Skip to main content

SDK for Hubble API at Jina AI.

Project description

Hubble python SDK logo

Hubble Python SDK: Talk with Hubble in a Pythonic Way

Install

pip install jina-hubble-sdk

Core functionality

  • Authentication and token management.
  • Artifact management.

Usage

Login to Hubble

import hubble

# Open browser automatically and login via 3rd party.
# Token will be saved locally.
hubble.login()

Logout

import hubble

# If there is a valid token locally, 
# this will disable that token and remove it from local config.
hubble.logout()

Authentication and Token Management

After calling hubble.login(), you can use the client with:

import hubble

client = hubble.Client(
    max_retries=None,
    jsonify=True
)
# Get current user information.
response = client.get_user_info()
# Create a new personally access token for longer expiration period.
response = client.create_personal_access_token(
    name='my-pat',
    expiration_days=30
)
# Query all personal access tokens.
response = client.list_personal_access_tokens()

Artifact Management

import hubble
import io

client = hubble.Client(
    max_retries=None,
    jsonify=True
)
# Upload artifact to Hubble Artifact Storage by providing path.
response = client.upload_artifact(
    f='~/Documents/my-model.onnx',
    is_public=False
)
# Upload artifact to Hubble Artifact Storage by providing `io.BytesIO`
response = client.upload_artifact(
    f=io.BytesIO(b"some initial binary data: \x00\x01"),
    is_public=False
)

# Get current artifact information.
response = client.get_artifact_info(id='my-artifact-id')
# Download artifact to local directory.
response = client.download_artifact(
    id='my-artifact-id',
    path='my-local-filepath'
)
# Delete the artifact.
response = client.delete_artifact(id='my-artifact-id')

Release cycle

  • Each time new commits come into main branch, CD workflow will generate a new release both on GitHub and Pypi.
  • Each time new commits come into alpha branch, CD workflow will generate a new pre-release both on GitHub and Pypi.

Support

Join Us

Hubble Python SDK is backed by Jina AI and licensed under Apache-2.0. We are actively hiring AI engineers, solution engineers to build the next neural search ecosystem in opensource.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

jina-hubble-sdk-0.3.0.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

jina_hubble_sdk-0.3.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file jina-hubble-sdk-0.3.0.tar.gz.

File metadata

  • Download URL: jina-hubble-sdk-0.3.0.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jina-hubble-sdk-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6a8c18bf0537538f57bc58cef0e0f168f67f9ad05bc8bf946688688463ea4c58
MD5 14212c45ff90c7672fbcf125083bbfd7
BLAKE2b-256 01c696fc38088ea053b54885af87a0c7e57cb47d82bdcc8078552a5e1dfc1a69

See more details on using hashes here.

File details

Details for the file jina_hubble_sdk-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jina_hubble_sdk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bffe70dd383e1c2c335e45ee3f0f7525319e7df45d90bb229b4dea5d400a857f
MD5 22fca9c7738dec31bb4f17032e6f260d
BLAKE2b-256 59295e05b939300218eb564d499dd4b81d4ec888366f36ee90f23dc9325e0cf8

See more details on using hashes here.

Supported by

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