Metadata-Version: 2.1
Name: nuclia
Version: 4.0.0
Home-page: https://nuclia.com
Author: Nuclia
Author-email: info@nuclia.com
License: BSD
Project-URL: Nuclia, https://nuclia.com
Project-URL: Github, https://github.com/nuclia/nucliadb
Project-URL: Slack, https://join.slack.com/t/nuclia-community/shared_invite/zt-2ldfznncw-LW6GJjOicdEA18kgI~95Xw
Keywords: search,semantic,AI
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: >=3.8, <4
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<6,>=5.0.0.post639
Requires-Dist: nucliadb_models<6,>=5.0.0.post639
Requires-Dist: tqdm
Requires-Dist: aiofiles
Requires-Dist: backoff
Requires-Dist: deprecated
Requires-Dist: tabulate

# 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://nuclia.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.nuclia.dev/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)
