This release is a pre-release and may not be stable for production use.
Installation
pip install dataroom-client
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.0.6.post280.dev0
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.0.6.post280.dev0.tar.gz | 22.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dataroom_client-1.0.6.post280.dev0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.0 kB
Release files / dataroom_client-1.0.6.post280.dev0.tar.gz
| Download URL | dataroom_client-1.0.6.post280.dev0.tar.gz |
|---|---|
| Size | 22.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ccc3579e6f433d4ab95e573acde1d1f2c382b92ac0493370cf6b22b6e4ea1f43
|
|
BLAKE2b-256 checksum How to use checksums |
90da940491ef6292afb09e9c235d0c59eafdd8877acde407a9cedb076eb6dc0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1020-azure
|
Release files / dataroom_client-1.0.6.post280.dev0-py3-none-any.whl
| Download URL | dataroom_client-1.0.6.post280.dev0-py3-none-any.whl |
|---|---|
| Size | 27.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7e619d481960e89460809fb8f8069aa27d8033dd334cf496182aadec0e1d260a
|
|
BLAKE2b-256 checksum How to use checksums |
b6506f56f2789ed80f9cf0c8e4b132ba2dbea234f7d4cd76e9df6075a5b3594c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1020-azure
|
