Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/deepset-ai/deepset-cloud-sdk

A Python SDK to interact with deepset Cloud

https://github.com/deepset-ai/deepset-cloud-sdk

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary
Last synced: 5 months ago · JSON representation

Repository

A Python SDK to interact with deepset Cloud

Basic Info
  • Host: GitHub
  • Owner: deepset-ai
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 3.27 MB
Statistics
  • Stars: 13
  • Watchers: 8
  • Forks: 2
  • Open Issues: 18
  • Releases: 43
Created almost 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Codeowners

README.md

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: bash 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: bash deepset-cloud --help

deepset CLI

Development Installation

To install the deepset 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 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

Owner

  • Name: deepset
  • Login: deepset-ai
  • Kind: organization
  • Email: hello@deepset.ai
  • Location: Berlin, Germany

Building enterprise search systems powered by latest NLP & open-source.

GitHub Events

Total
  • Create event: 120
  • Issues event: 2
  • Release event: 20
  • Watch event: 3
  • Delete event: 100
  • Issue comment event: 53
  • Push event: 248
  • Pull request review comment event: 111
  • Pull request review event: 99
  • Pull request event: 104
  • Fork event: 1
Last Year
  • Create event: 120
  • Issues event: 2
  • Release event: 20
  • Watch event: 3
  • Delete event: 100
  • Issue comment event: 53
  • Push event: 248
  • Pull request review comment event: 111
  • Pull request review event: 99
  • Pull request event: 104
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 36
  • Total pull requests: 223
  • Average time to close issues: 17 days
  • Average time to close pull requests: 14 days
  • Total issue authors: 13
  • Total pull request authors: 13
  • Average comments per issue: 0.92
  • Average comments per pull request: 1.09
  • Merged pull requests: 181
  • Bot issues: 0
  • Bot pull requests: 77
Past Year
  • Issues: 1
  • Pull requests: 52
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Issue authors: 1
  • Pull request authors: 7
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.77
  • Merged pull requests: 32
  • Bot issues: 0
  • Bot pull requests: 25
View more stats
Top Authors
Issue Authors
  • ArzelaAscoIi (18)
  • rjanjua (4)
  • mathislucka (2)
  • ju-gu (2)
  • FHardow (2)
  • agnieszka-m (1)
  • bglearning (1)
  • virtualroot (1)
  • elundaeva (1)
  • tstadel (1)
  • sjrl (1)
  • OGuggenbuehl (1)
  • lucalila (1)
  • masci (1)
Pull Request Authors
  • dependabot[bot] (104)
  • ArzelaAscoIi (68)
  • agnieszka-m (22)
  • rjanjua (18)
  • tstadel (15)
  • wochinge (14)
  • faymarie (13)
  • sjrl (4)
  • FHardow (4)
  • virtualroot (1)
  • askainet (1)
  • elundaeva (1)
  • tholor (1)
Top Labels
Issue Labels
bug (8) production (2) enhancement (2) medium (2) feature:downalods (1) feature:upload (1) documentation (1) low (1) good first issue (1)
Pull Request Labels
dependencies (104) python (68) github_actions (36) integration (16) test-deploy (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 766 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 62
  • Total maintainers: 1
pypi.org: deepset-cloud-sdk

deepset SDK

  • Versions: 62
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 766 Last month
Rankings
Dependent packages count: 7.3%
Stargazers count: 25.5%
Average: 26.0%
Forks count: 30.5%
Dependent repos count: 40.8%
Maintainers (1)
deepset
Last synced: 5 months ago

Dependencies

.github/actions/integration_tests/action.yml actions
  • actions/setup-python v4 composite
.github/workflows/api-docs.yaml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/compliance.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout v4 composite
  • actions/setup-python b55428b1882923874294fa556849718a1d7f2ca5 composite
  • fossas/fossa-action f61a4c0c263690f2ddb54b9822a719c25a7b608f composite
.github/workflows/continuous-deployment-dev.yml actions
  • ./.github/actions/integration_tests * composite
  • actions/checkout v4 composite
.github/workflows/continuous-deployment-prod.yml actions
  • ./.github/actions/integration_tests * composite
  • actions/checkout v4 composite
.github/workflows/continuous-integration.yml actions
  • ./.github/actions/integration_tests * composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • py-cov-action/python-coverage-comment-action b3d7e98bf5528b07d6951ef7a93e2b156f960112 composite
.github/workflows/deploy-prod.yml actions
.github/workflows/deploy-test.yml actions
.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/high-prio-bug.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
docs/_pydoc/requirements.txt pypi
  • PyYAML ==6.0.1
  • docspec-python ==2.2.1
  • pydoc-markdown ==4.8.2
  • requests ==2.31.0
pyproject.toml pypi
.github/workflows/merge-queue.yml actions
  • ./.github/actions/integration_tests * composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite