# 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)
Raw data
{
"_id": null,
"home_page": "https://nuclia.com",
"name": "nuclia",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "search, semantic, AI",
"author": "Nuclia",
"author_email": "info@nuclia.com",
"download_url": "https://files.pythonhosted.org/packages/2a/e1/c2a738fec619afdab603e4070488e173e9977e818f94ab2f6c5f35df8b11/nuclia-4.4.0.tar.gz",
"platform": null,
"description": "# Nuclia Python Client\n\nIn order to install\n\n```bash\npip install nuclia\n```\n\n## Authentication\n\n### Nuclia\n\nYou can login with your Nuclia user [How to sign-up](https://nuclia.cloud/user/signup) via\n\n```bash\nnuclia auth login\n```\n\n### Nuclia Knowledgebox\n\nYou 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)\n\n```bash\nnuclia auth kb --url KB_URL --token SERVICE_TOKEN\n```\n\nKB_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.\n\n### Nuclia Understanding API\n\nYou can login with a Nuclia Understanding API key to process files, predict and train using our system\n\n```bash\nnuclia auth nua --key ZZZZ\n```\n\n## Documentation\n\nYou can find the documentation [here](https://github.com/nuclia/nuclia.py/tree/main/docs/01-README.md)\n",
"bugtrack_url": null,
"license": "BSD",
"summary": null,
"version": "4.4.0",
"project_urls": {
"Github": "https://github.com/nuclia/nucliadb",
"Homepage": "https://nuclia.com",
"Nuclia": "https://nuclia.com",
"Slack": "https://join.slack.com/t/nuclia-community/shared_invite/zt-2ldfznncw-LW6GJjOicdEA18kgI~95Xw"
},
"split_keywords": [
"search",
" semantic",
" ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ae1c2a738fec619afdab603e4070488e173e9977e818f94ab2f6c5f35df8b11",
"md5": "b8abddd7e8d4e26d0c98248519a69e88",
"sha256": "00c423d37daf23d34782a2c4511e67afd50e740dd796f3a0cdd9b21448f68d9e"
},
"downloads": -1,
"filename": "nuclia-4.4.0.tar.gz",
"has_sig": false,
"md5_digest": "b8abddd7e8d4e26d0c98248519a69e88",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 63152,
"upload_time": "2024-12-18T15:36:59",
"upload_time_iso_8601": "2024-12-18T15:36:59.343681Z",
"url": "https://files.pythonhosted.org/packages/2a/e1/c2a738fec619afdab603e4070488e173e9977e818f94ab2f6c5f35df8b11/nuclia-4.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 15:36:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nuclia",
"github_project": "nucliadb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "nuclia"
}