Skip to main content

deepset SDK

Project description

deepset SDK

Coverage badge Tests Deploy PyPi Compliance Checks

The deepset SDK is an open source software development kit that provides convenient access to and integration with deepset AI Platform, a powerful cloud offering for various AI 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 AI Platform and for importing Haystack pipelines and indexes. The following examples demonstrate how to use the deepset SDK to interact with deepset AI Platform using Python. You can use the deepset SDK in the command line as well. For more information, see the CLI documentation.

Installation

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

pip install deepset-cloud-sdk

After installing the deepset SDK, you can use it to interact with deepset AI Platform. It comes with a command line interface (CLI), that you can use by calling:

deepset-cloud --help

deepset CLI

Development Installation

To install the deepset 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 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 AI Platform 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.7.1.tar.gz (364.4 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.7.1-py3-none-any.whl (50.8 kB view details)

Uploaded Python 3

File details

Details for the file deepset_cloud_sdk-1.7.1.tar.gz.

File metadata

  • Download URL: deepset_cloud_sdk-1.7.1.tar.gz
  • Upload date:
  • Size: 364.4 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.7.1.tar.gz
Algorithm Hash digest
SHA256 1b74f456e0ffae5eb83eb86f3dd95f9cd0697cf77794d8154f9072dc71700f59
MD5 50e332105685bd5d9bf4629fcc462b7c
BLAKE2b-256 d85d5fc5c36f3ca12bd60e3e2b52451ed30388e00fc79fd7441bc27c8910a852

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepset_cloud_sdk-1.7.1.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.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for deepset_cloud_sdk-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4ebec5b06f0e8119fffe9bd1f60d90e18a429e92db743d982b0c720503ed106
MD5 ec4fe976c7fa0d67d6035d3e4a9d8c4e
BLAKE2b-256 f9a42132196408144e3c2b5cedcfe9adba70853eba157515818e0a2c24ea0b63

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepset_cloud_sdk-1.7.1-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