[MCC-1498410] Create-README-file

[nmakarava-mdsol]

feature/bug/enhance/refactor/tech_debt/hotfix

• Python Lib - ReadMe [Dev Only]
• MCC-1498410

Checklist

• Review the pull request to fix typos and ensure variable/function names are intuitive, etc.
• Make sure the pull request does not have excessive number of unnecessary commits. Utilize the git commit --amend --no-edit command to reduce commit messages when making small file changes (like changing linespacing).
• Make sure you have added unit tests for the code changes. Tests should be added in the tests/ folder.
• Modify docs, if required. Add any new documentation in the doc/ folder.
• Rebase on latest active development branch (develop/main).

Changes Summary

This PR introduces initial, versioned README documentation and a setup vignette for the DataConnect Python library, and updates the repository’s root README to point to the versioned docs.

Changes:

• Added a setup guide (vignettes/pythonLibrary_setup.md) including install options and a Quick Start snippet.
• Added versioned documentation snapshot (readme/README-v1.0.0.md) describing the public client API and error codes.
• Replaced the root README.md content with a versioned-docs index and simplified CONTRIBUTING.md.

[Copilot]

Pull request overview

This PR introduces initial, versioned README documentation and a setup vignette for the DataConnect Python library, and updates the repository’s root README to point to the versioned docs.

Changes:

• Added a setup guide (vignettes/pythonLibrary_setup.md) including install options and a Quick Start snippet.
• Added versioned documentation snapshot (readme/README-v1.0.0.md) describing the public client API and error codes.
• Replaced the root README.md content with a versioned-docs index and simplified CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
vignettes/pythonLibrary_setup.md	New setup/install + quick start vignette for the Python library.
readme/README-v1.0.0.md	New versioned README snapshot documenting client functions, errors, and background.
README.md	Converted root README into a versioned documentation index.
CONTRIBUTING.md	Replaced contribution guidance with a public-contribution restriction note.

Comments suppressed due to low confidence (9)

vignettes/pythonLibrary_setup.md:33

• The Quick Start snippet imports DataconnectClient from Dataconnect, but the library’s public API exports DataConnectClient from the dataconnect package (see dataconnect/__init__.py). As written, this example will fail for users trying to copy/paste it.

from uuid import UUID

from Dataconnect import DataconnectClient

with DataconnectClient.connect(token="your-bearer-token") as client:
	studies = client.get_studies()
	print(f"Found {len(studies)} studies")

vignettes/pythonLibrary_setup.md:42

• The Quick Start Python example has inconsistent indentation (tabs on some lines and spaces on others), which will raise an IndentationError when run. Please normalize indentation so the entire snippet is valid Python.

with DataconnectClient.connect(token="your-bearer-token") as client:
	studies = client.get_studies()
	print(f"Found {len(studies)} studies")

	if studies and studies[0].environments:
    study_environment_uuid = studies[0].environments[0].uuid
    datasets_data = client.get_datasets(study_environment_uuid=study_environment_uuid, page=1, page_size=10)
    print(f"Found {datasets_data.total_records} datasets")

    if datasets_data.items:
      dataset_uuid = UUID(datasets_data.items[0].dataset_uuid)
      df = client.fetch_data(dataset_uuid, first_n_rows=100)

readme/README-v1.0.0.md:31

• The Installation Guide link points to the R SDK repository (dataconnect-library-r) and a path that doesn’t exist in this repo. This should likely be a relative link to this repo’s vignettes/pythonLibrary_setup.md (or whatever the intended setup doc is) so the link works for Python library users.

## Installation

To install, follow the [Installation Guide](https://github.com/mdsol/dataconnect-library-r/blob/main/vignettes/dataconnect/readme/vignettes/pythonLibrary_setup.md).

readme/README-v1.0.0.md:35

• [Usage Guide]() is an empty link target, so the rendered README has a broken link. Please either provide the correct URL/path or remove the link until the guide exists.

## Quick Start

For end-to-end examples, see the [Usage Guide]().

readme/README-v1.0.0.md:46

• This README names the main entry point as DataconnectClient, but the codebase exports DataConnectClient (capitalization and spelling) from the dataconnect package. Please update the public API naming throughout the README to match the actual import path/class name to avoid breaking user code examples.

## Functions

The main public entry point is `DataconnectClient`.

### connect()

readme/README-v1.0.0.md:60

• In the connect() arguments table, port is documented as an int but the default is shown as "443" (a string). This is misleading; please document the default as an integer (e.g., 443) to match the actual client signature.

| Argument | Type | Description |
|---|---|---|
| host | str | Server host. Default host="enodia-gateway.platform.imedidata.com" |
| port | int | Server port. Default port="443" |
| use_tls | bool | Denotes whether to use TLS. Default use_tls = True |
| token | str | Authentication token, this is the user authentication token generated from the Developer Center in Medidata Data Connect |

readme/README-v1.0.0.md:82

• The documented get_studies() output doesn’t match the library model: the client returns a StudiesResult with fields total and studies (see dataconnect/models.py), not total_records and a raw studies array as described here. Please align the README with the real return type/field names.

#### Output
Returns a list containing `total_records` (total studies available) and a `studies` array. Each study includes `name`, `uuid`, and an environments array. Each environment includes `name` and `uuid`.

readme/README-v1.0.0.md:103

• The documented get_datasets() output refers to a datasets array, but the client returns a PaginatedResponse with an items list (and total_records/pagination). Please update the README to use the actual field names so examples and consumer code aren’t confused.

#### Output
Returns a list containing `total_records` (total datasets available across all pages), `pagination` and `datasets` array.

readme/README-v1.0.0.md:166

• The Errors markdown table is malformed: many rows are missing the trailing | at the end of the line (e.g., VAL_002 and onward), which breaks table rendering in most markdown viewers. Please ensure each row has the correct number of columns and closing pipes.

| Error Code | Type | Scenario|
| :--- | :--- |:---|
| AUTHZ_001	| Authorization	| Authorization service check failed |
| VAL_002	| Validation - Page Number | Page number is not a positive integer
| VAL_003	| Validation - Page Size | Page size is out of range [1, 100]
| VAL_004	| Validation - Study Parameter | Invalid study uuid
| VAL_005	| Validation - Study Environment Parameter | Missing or invalid study environment uuid

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.