Metadata-Version: 2.4
Name: nuclia
Version: 4.9.20
Summary: Nuclia Python SDK
Author-email: Nuclia <info@nuclia.com>
License-Expression: MIT
Project-URL: Homepage, https://nuclia.com
Project-URL: Repository, https://github.com/nuclia/nuclia.py
Project-URL: Slack, https://join.slack.com/t/nuclia-community/shared_invite/zt-2ldfznncw-LW6GJjOicdEA18kgI~95Xw
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: <4,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fire
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pyyaml>=5.4
Requires-Dist: requests
Requires-Dist: httpx
Requires-Dist: httpcore>=1.0.0
Requires-Dist: prompt_toolkit
Requires-Dist: nucliadb_sdk<7,>=6.7.2
Requires-Dist: nucliadb_models<7,>=6.9.0
Requires-Dist: nuclia-models>=0.51.0
Requires-Dist: tqdm
Requires-Dist: aiofiles
Requires-Dist: backoff
Requires-Dist: deprecated
Requires-Dist: tabulate
Requires-Dist: websockets
Requires-Dist: rich
Provides-Extra: litellm
Requires-Dist: litellm; extra == "litellm"
Provides-Extra: protos
Requires-Dist: nucliadb_protos<7,>=6.4; extra == "protos"
Dynamic: license-file

# Nuclia Python Client

In order to install

```bash
pip install nuclia
```

## Authentication

### Nuclia

You can login with your Nuclia user [How to sign-up](https://rag.progress.cloud/user/signup) via

```bash
nuclia auth login
```

### Nuclia Knowledgebox

You can login to a specific knowledgebox if you have a Service Token (How to get a Service Token) or your NucliaDB is [deployed on-premise](https://docs.rag.progress.cloud/docs/nucliadb/deploy)

```bash
nuclia auth kb --url KB_URL --token SERVICE_TOKEN
```

KB_URL its the url of the Knowledge Box. On the cloud service you can retrieve it on the dashboard. On the on-premise/community deployment its the url mapped to it.

### Nuclia Understanding API

You can login with a Nuclia Understanding API key to process files, predict and train using our system

```bash
nuclia auth nua --key ZZZZ
```

## Documentation

You can find the documentation [here](https://github.com/nuclia/nuclia.py/tree/main/docs/01-README.md)

## For internal use

Find more information on the internal CI setup [here](https://github.com/nuclia/internal/tree/main/ci/nucliapy.md)
