From 63df6750376493a0cfc4052b98533ed51a1c6456 Mon Sep 17 00:00:00 2001 From: Nastassia Makarava Date: Wed, 27 May 2026 09:18:15 -0400 Subject: [PATCH] feat: updated README --- readme/README-v1.0.0.md | 4 +-- vignettes/pythonLibrary_setup.md | 44 -------------------------------- 2 files changed, 2 insertions(+), 46 deletions(-) delete mode 100644 vignettes/pythonLibrary_setup.md diff --git a/readme/README-v1.0.0.md b/readme/README-v1.0.0.md index f9c3431..16dfa09 100644 --- a/readme/README-v1.0.0.md +++ b/readme/README-v1.0.0.md @@ -22,11 +22,11 @@ To use this library, you must have a valid iMedidata account and access to requi ## Installation -To install, follow the [Installation Guide](https://github.com/mdsol/dataconnect-library-r/blob/main/vignettes/dataconnect/readme/vignettes/pythonLibrary_setup.md). +To install, follow the [Installation Guide](https://github.com/mdsol/dataconnect-library-python/blob/main/guides/dataconnect_setup.md). ## Quick Start -For end-to-end examples, see the [Usage Guide](). +For end-to-end examples, see the [Usage Guide](https://github.com/mdsol/dataconnect-library-python/blob/main/guides/dataconnect_quickstart.md). ### Authentication and Connectivity diff --git a/vignettes/pythonLibrary_setup.md b/vignettes/pythonLibrary_setup.md deleted file mode 100644 index 2a8fd29..0000000 --- a/vignettes/pythonLibrary_setup.md +++ /dev/null @@ -1,44 +0,0 @@ -# Data Connect Python Library - Setup - -Choose one of the following approaches. - -### Option 1: Install from source (recommended for this repository) - -```bash -git clone -cd dataconnect-library-python -python3.13 -m venv .venv -source .venv/bin/activate -pip install -e . -``` - -### Option 2: Install using Poetry - -```bash -git clone -cd dataconnect-library-python -poetry install -poetry shell -``` - -## Quick Start - -```python -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") - - 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) - print(df.head()) -```