# 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/0d/96/ece451d44832a42b0f7fdbf0c5e1fd94d09551edc8320d49f530d34f75f7/nuclia-2.0.10.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\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": null,
"version": "2.0.10",
"project_urls": {
"Discord": "https://discord.gg/8EvQwmsbzf",
"Github": "https://github.com/nuclia/nucliadb",
"Homepage": "https://nuclia.com",
"Nuclia": "https://nuclia.com"
},
"split_keywords": [
"search",
" semantic",
" ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cde04645cbecb1e9356629044c635f5d23f7ed03236860f0982dd49bd84d0ac9",
"md5": "3a7e1c4bfa4e9607591cf8ef12518f37",
"sha256": "a2aeeffd0dd4798c4e1d73a4afb4d8099f068031f904067cc4f5af711b0e72a1"
},
"downloads": -1,
"filename": "nuclia-2.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a7e1c4bfa4e9607591cf8ef12518f37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 46799,
"upload_time": "2024-03-26T08:30:14",
"upload_time_iso_8601": "2024-03-26T08:30:14.735934Z",
"url": "https://files.pythonhosted.org/packages/cd/e0/4645cbecb1e9356629044c635f5d23f7ed03236860f0982dd49bd84d0ac9/nuclia-2.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d96ece451d44832a42b0f7fdbf0c5e1fd94d09551edc8320d49f530d34f75f7",
"md5": "6bb18bbb5f9d0cd0d5eaefa480812cea",
"sha256": "39acb6ea9e849bd7c520f1571a3c6a40653b207109af83bcca597d2d24971f82"
},
"downloads": -1,
"filename": "nuclia-2.0.10.tar.gz",
"has_sig": false,
"md5_digest": "6bb18bbb5f9d0cd0d5eaefa480812cea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 43789,
"upload_time": "2024-03-26T08:30:16",
"upload_time_iso_8601": "2024-03-26T08:30:16.819459Z",
"url": "https://files.pythonhosted.org/packages/0d/96/ece451d44832a42b0f7fdbf0c5e1fd94d09551edc8320d49f530d34f75f7/nuclia-2.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 08:30:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nuclia",
"github_project": "nucliadb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "nuclia"
}