semvec/pypi-packages huggingface dataset:
cradl 0.6.0
Python SDK for Cradl
License: Apache 2.0
Requires Python: >=3.10

# Python SDK for Cradl

![Github Actions build status](https://github.com/CradlAI/cradl-sdk-python/workflows/main/badge.svg)

## Installation

```bash
$ pip install cradl
```

## Usage

Sign up for free [here](https://app.cradl.ai/signup) and download API credentials to use this SDK.
Read more about authenticating to the API [here](https://docs.cradl.ai/api-reference/introduction#authentication)

### Quick start

```python
import json
from cradl import Client

client = Client()
models = client.list_models()['models'] # List all models available
model_id = models[0]['modelId'] # Get ID of first model in list
document = client.create_document('path/to/document.pdf')
prediction = client.create_prediction(document['documentId'], model_id=model_id)
print(json.dumps(prediction, indent=2))
```

## Contributing

### Prerequisites

```bash
$ pip install -r requirements.txt
$ pip install -r requirements.ci.txt
```

### Run tests

```bash
$ make prism-start
$ python -m pytest
```