This release is a pre-release and may not be stable for production use.
Installation
pip install dataroom-client
Pre-releases are published too, and never installed by default:
pip install --pre dataroom-client
pip install dataroom-client==1.2.0.dev2
Usage
After getting an account you can find your API key on the settings page.
The API is grouped into resource namespaces: images, groups, datasets,
group_types, roles, queries and tags.
from dataroom_client import DataRoomClient
DataRoom = DataRoomClient(api_key='YOUR_SECRET_API_KEY_HERE', api_url='YOUR_API_URL_HERE')
# landscape images from one ingest source
images = await DataRoom.images.list(sources=['local_dataset'], aspect_ratio__gt=1.5, limit=100)
# one image with its metadata
image = await DataRoom.images.get(images[0]['id'])
# every version of one dataset
datasets = await DataRoom.datasets.list(slug='training-set')
DataRoomClientSync exposes the same namespaces with blocking calls (no
await). The pre-namespace flat methods (get_images(), create_dataset(),
...) still work and are thin aliases of the namespace methods.
Worked examples, one notebook per area: client_example (images and tags), groups_example, datasets_example, queries_example and loader_example (bulk upload).
Developing
Follow the instructions in the main README.
1 maintainer
Metadata
1 maintainer
Release files for dataroom-client 1.2.0.dev2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dataroom_client-1.2.0.dev2.tar.gz | 24.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dataroom_client-1.2.0.dev2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 56.2 kB
Release files / dataroom_client-1.2.0.dev2.tar.gz
| Download URL | dataroom_client-1.2.0.dev2.tar.gz |
|---|---|
| Size | 24.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c6faa550be3de03a9debdba50de8535ae314c4514449576213992b1e19e41ad
|
|
BLAKE2b-256 checksum How to use checksums |
45061dc04d8906ec4bbb07127eae8c3440e00ccb7793f9b6a457d6c9b2f1d6d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logRelease files / dataroom_client-1.2.0.dev2-py3-none-any.whl
| Download URL | dataroom_client-1.2.0.dev2-py3-none-any.whl |
|---|---|
| Size | 31.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c20c5eaffce423983ffc845b5477f51718acab54dc644955c458e690032ac59
|
|
BLAKE2b-256 checksum How to use checksums |
722408ad2fc140bd2517c793bd72096108dc3f54afdc0837e35132578e5c916c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency log
