Skip to main content

deepset Cloud SDK

Project description

deepset Cloud SDK

Coverage badge Tests Deploy PyPi Compliance Checks

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.

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.

Installation

The deepset Cloud SDK is available on PyPI and you can install it using pip:

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:

deepset-cloud --help

deepset Cloud CLI

Development Installation

To install the deepset Cloud SDK for development, clone the repository and install the package in editable mode:

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:

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 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.


Licenses

The SDK is licensed under Apache 2.0, you can see the license here

We use several libraries in this SDK that are licensed under the MPL 2.0 license

  • tqdm for progress bars
  • pathspec for pattern matching file paths
  • certifi for validating trustworthiness of SSL certificates

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deepset_cloud_sdk-1.6.0rc1.tar.gz (360.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deepset_cloud_sdk-1.6.0rc1-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

Details for the file deepset_cloud_sdk-1.6.0rc1.tar.gz.

File metadata

  • Download URL: deepset_cloud_sdk-1.6.0rc1.tar.gz
  • Upload date:
  • Size: 360.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for deepset_cloud_sdk-1.6.0rc1.tar.gz
Algorithm Hash digest
SHA256 e2b79fc59b8400d244256a9b8f5ba7d83190c84fac6c5f1553504f0809f65b94
MD5 15adf4c6b16ea30f12583342e7beb165
BLAKE2b-256 9da1d6c8b9016abd0dd708f1ce625c8c81d73ccc3bfe2ada8343331482d4ef94

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepset_cloud_sdk-1.6.0rc1.tar.gz:

Publisher: deploy-prod.yml on deepset-ai/deepset-cloud-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file deepset_cloud_sdk-1.6.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for deepset_cloud_sdk-1.6.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 688e502a2e55f50de211d8b6d8e128f62c6f30d17c3baef97a7c220de67beed0
MD5 79b186b2d307c0faedd55eaebeb938ce
BLAKE2b-256 738eeae60eb508cea797dfbcfc19144692f4d8405f9c65564d8a2b730d41cf55

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepset_cloud_sdk-1.6.0rc1-py3-none-any.whl:

Publisher: deploy-prod.yml on deepset-ai/deepset-cloud-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page