| Name | deepset-cloud-sdk JSON |
| Version |
0.41
JSON |
| download |
| home_page | |
| Summary | deepset Cloud SDK |
| upload_time | 2024-03-13 16:02:35 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://cloud.deepset.ai/"><img src="/assets/logo.png" alt="deepset Cloud SDK"></a>
</p>
[](https://github.com/deepset-ai/deepset-cloud-sdk/tree/python-coverage-comment-action-data)
[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/continuous-integration.yml)
[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/deploy-prod.yml)
[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/compliance.yml)
The deepset Cloud SDK is an open source software development kit that provides convenient access to and integration with deepset Cloud, a powerful cloud offering for various natural language processing (NLP) tasks.
This README provides an overview of the SDK and its features, and information on contributing to the project and exploring related resources.
- [Official SDK Docs](https://sdk.cloud.deepset.ai)
- [deepset Cloud Documentation](https://docs.cloud.deepset.ai/)
- Tutorials:
- [Uploading with CLI](https://docs.cloud.deepset.ai/docs/tutorial-uploading-files-with-cli)
- [Uploading with Python Methods](https://docs.cloud.deepset.ai/docs/tutorial-uploading-files-with-python-methods)
# Supported Features
In its current shape, the SDK offers a suite of tools for seamless data upload to deepset Cloud.
The following examples demonstrate how to use the deepset Cloud SDK to interact with deepset Cloud using Python.
You can use the deepset Cloud SDK in the command line as well. For more information, see the [CLI documentation](docs/examples/cli/README.md).
- [SDK Examples - Upload datasets](/docs/examples/sdk/upload.py)
- [CLI Examples - Upload datasets](/docs/examples/cli/README.md)
## Installation
The deepset Cloud SDK is available on [PyPI](https://pypi.org/project/deepset-cloud-sdk/) and you can install it using pip:
```bash
pip install deepset-cloud-sdk
```
After installing the deepset Cloud SDK, you can use it to interact with deepset Cloud. It comes with a command line interface (CLI), that you can use by calling:
```bash
deepset-cloud --help
```
<p align="center">
<a href="https://cloud.deepset.ai/"><img src="/assets/cli.gif" alt="deepset Cloud CLI"></a>
</p>
### Development Installation
To install the deepset Cloud SDK for development, clone the repository and install the package in editable mode:
```bash
pip install hatch==1.7.0
hatch build
```
Instead of calling the CLI from the build package, you can call it directly from the source code:
```bash
python3 -m deepset_cloud_sdk.cli --help
```
## Contributing
We welcome contributions from the open source community to enhance the deepset Cloud SDK. If you would like to contribute, have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and instructions on how to get started.
We appreciate your contributions, whether they're bug fixes, new features, or documentation improvements.
---
## Interested in Haystack?
deepset Cloud is powered by Haystack, an open source framework for building end-to-end NLP pipelines.
- [Project website](https://haystack.deepset.ai/)
- [GitHub repository](https://github.com/deepset-ai/haystack)
Raw data
{
"_id": null,
"home_page": "",
"name": "deepset-cloud-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "deepset <rohan.janjua@deepset.ai>",
"download_url": "https://files.pythonhosted.org/packages/92/ad/8196141500fdde39c401e6af2255a58ed68dc843b999793d89b536c6e3ed/deepset_cloud_sdk-0.41.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://cloud.deepset.ai/\"><img src=\"/assets/logo.png\" alt=\"deepset Cloud SDK\"></a>\n</p>\n\n[](https://github.com/deepset-ai/deepset-cloud-sdk/tree/python-coverage-comment-action-data)\n[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/continuous-integration.yml)\n[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/deploy-prod.yml)\n[](https://github.com/deepset-ai/deepset-cloud-sdk/actions/workflows/compliance.yml)\n\nThe deepset Cloud SDK is an open source software development kit that provides convenient access to and integration with deepset Cloud, a powerful cloud offering for various natural language processing (NLP) tasks.\nThis README provides an overview of the SDK and its features, and information on contributing to the project and exploring related resources.\n\n- [Official SDK Docs](https://sdk.cloud.deepset.ai)\n- [deepset Cloud Documentation](https://docs.cloud.deepset.ai/)\n- Tutorials: \n - [Uploading with CLI](https://docs.cloud.deepset.ai/docs/tutorial-uploading-files-with-cli) \n - [Uploading with Python Methods](https://docs.cloud.deepset.ai/docs/tutorial-uploading-files-with-python-methods)\n\n# Supported Features\n\nIn its current shape, the SDK offers a suite of tools for seamless data upload to deepset Cloud. \nThe following examples demonstrate how to use the deepset Cloud SDK to interact with deepset Cloud using Python.\nYou can use the deepset Cloud SDK in the command line as well. For more information, see the [CLI documentation](docs/examples/cli/README.md).\n\n- [SDK Examples - Upload datasets](/docs/examples/sdk/upload.py)\n- [CLI Examples - Upload datasets](/docs/examples/cli/README.md)\n\n## Installation\nThe deepset Cloud SDK is available on [PyPI](https://pypi.org/project/deepset-cloud-sdk/) and you can install it using pip:\n```bash\npip install deepset-cloud-sdk\n```\n\nAfter installing the deepset Cloud SDK, you can use it to interact with deepset Cloud. It comes with a command line interface (CLI), that you can use by calling:\n```bash\ndeepset-cloud --help\n```\n\n<p align=\"center\">\n <a href=\"https://cloud.deepset.ai/\"><img src=\"/assets/cli.gif\" alt=\"deepset Cloud CLI\"></a>\n</p>\n\n### Development Installation\nTo install the deepset Cloud SDK for development, clone the repository and install the package in editable mode:\n```bash\npip install hatch==1.7.0\nhatch build\n```\n\nInstead of calling the CLI from the build package, you can call it directly from the source code:\n```bash\npython3 -m deepset_cloud_sdk.cli --help\n```\n\n## Contributing\nWe welcome contributions from the open source community to enhance the deepset Cloud SDK. If you would like to contribute, have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and instructions on how to get started.\nWe appreciate your contributions, whether they're bug fixes, new features, or documentation improvements.\n\n\n---\n\n## Interested in Haystack?\ndeepset Cloud is powered by Haystack, an open source framework for building end-to-end NLP pipelines.\n\n - [Project website](https://haystack.deepset.ai/)\n - [GitHub repository](https://github.com/deepset-ai/haystack)\n",
"bugtrack_url": null,
"license": "",
"summary": "deepset Cloud SDK",
"version": "0.41",
"project_urls": {
"Documentation": "https://github.com/deepset-ai/deepset-cloud-sdk#readme",
"Issues": "https://github.com/deepset-ai/deepset-cloud-sdk/issues",
"Source": "https://github.com/deepset-ai/deepset-cloud-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3503c8db68e953bf4cdf3eccc49a720f1f97d2dd9baf316b789e80ceb0318a9",
"md5": "4b303e075301ced8f5edfa1476d53f2e",
"sha256": "172d84bfe4d337be1f672486147cfee33c6aa36cf175a7ea3ee0ca4cf51fe6cf"
},
"downloads": -1,
"filename": "deepset_cloud_sdk-0.41-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b303e075301ced8f5edfa1476d53f2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 35374,
"upload_time": "2024-03-13T16:02:33",
"upload_time_iso_8601": "2024-03-13T16:02:33.560624Z",
"url": "https://files.pythonhosted.org/packages/c3/50/3c8db68e953bf4cdf3eccc49a720f1f97d2dd9baf316b789e80ceb0318a9/deepset_cloud_sdk-0.41-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92ad8196141500fdde39c401e6af2255a58ed68dc843b999793d89b536c6e3ed",
"md5": "7c3d58664498815bd61944c3dc98c49a",
"sha256": "fe12d3593f7bae82177d8a644dd51b8acc7162afae056f7c14e00458fa83ea16"
},
"downloads": -1,
"filename": "deepset_cloud_sdk-0.41.tar.gz",
"has_sig": false,
"md5_digest": "7c3d58664498815bd61944c3dc98c49a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 351086,
"upload_time": "2024-03-13T16:02:35",
"upload_time_iso_8601": "2024-03-13T16:02:35.386376Z",
"url": "https://files.pythonhosted.org/packages/92/ad/8196141500fdde39c401e6af2255a58ed68dc843b999793d89b536c6e3ed/deepset_cloud_sdk-0.41.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 16:02:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepset-ai",
"github_project": "deepset-cloud-sdk#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deepset-cloud-sdk"
}
