Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

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 use uv to manage dependencies:

# Install uv if you don't have it
pip install uv

# Sync all dependencies (including dev dependencies)
uv sync --all-groups

# Build the package
uv build

Instead of calling the CLI from the build package, you can call it directly from the source code:

uv run python -m deepset_cloud_sdk.cli --help
# or
uv run deepset-cloud --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

Metadata

Release files for deepset-cloud-sdk 1.7.8.post0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deepset-cloud-sdk 1.7.8.post0
File Size Uploaded Provenance Actions
deepset_cloud_sdk-1.7.8.post0.tar.gz 36.8 kB With provenance Details for deepset_cloud_sdk-1.7.8.post0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for deepset-cloud-sdk 1.7.8.post0
File Interpreter ABI Platform Actions
deepset_cloud_sdk-1.7.8.post0-py3-none-any.whl Python 3 none any Details for deepset_cloud_sdk-1.7.8.post0-py3-none-any.whl

Total release size: 85.4 kB

Release files / deepset_cloud_sdk-1.7.8.post0.tar.gz

Download URL deepset_cloud_sdk-1.7.8.post0.tar.gz
Size 36.8 kB
Tags Source
SHA-256 checksum
How to use checksums
2f6363db96eb2627850dab953f81525ef91154f7ef7bb629982968b48d231a43
BLAKE2b-256 checksum
How to use checksums
0275a711237aae8b1b431682d1c083b390e2cae173cde44dde5f865ec14ffac4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / deepset_cloud_sdk-1.7.8.post0-py3-none-any.whl

Download URL deepset_cloud_sdk-1.7.8.post0-py3-none-any.whl
Size 48.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9367f92e23e8c527ce738ac643fd0a1773d98ebb87d39870e404c7ad5dd456cd
BLAKE2b-256 checksum
How to use checksums
dfeb1d673ea0048fcd02971898bc1452a9fdcde0ed5ccd4ea4354fd574a9031a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Security for deepset-cloud-sdk 1.7.8.post0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for deepset_cloud_sdk-1.7.8.post0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page