Metadata-Version: 2.3
Name: dataroom-client
Version: 1.0.1
Summary: A python client to interface with the Dataroom backend API
Author: Ales Kocjancic
Author-email: hi@ales.io
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: httpx (>=0.24.1,<1)
Description-Content-Type: text/markdown


# Installation

```
pip install dataroom-client
```


# Usage

After getting an account you can find your API key on the settings page.

```
from dataroom_client import DataRoomClient

DataRoom = DataRoomClient(api_key='YOUR_SECRET_API_KEY_HERE', api_url='YOUR_API_URL_HERE')

images = await DataRoom.get_images()
```

For more examples see [client_example.ipynb](./notebooks/client_example.ipynb).


# Developing

Check out the `dataroom` repo and follow the instructions in the README.

