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 --pre 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,
    timeout=10,
    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,
    timeout=10,
    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, the pre-release procedure will be started. It will generate a pre-release in 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.2.4a2.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

jina_hubble_sdk-0.2.4a2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file jina-hubble-sdk-0.2.4a2.tar.gz.

File metadata

  • Download URL: jina-hubble-sdk-0.2.4a2.tar.gz
  • Upload date:
  • Size: 13.9 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.2.4a2.tar.gz
Algorithm Hash digest
SHA256 19dfa6f3975b5a26e20d29788905220422f1a538b6ff1cac135f80f0664edab6
MD5 4054e1c379ba92e071b83f073254cf2f
BLAKE2b-256 71d52e5bf806dd828511ca5455cf9dbda1f6d6f41d066a85ee0d124d3b08bd53

See more details on using hashes here.

File details

Details for the file jina_hubble_sdk-0.2.4a2-py3-none-any.whl.

File metadata

File hashes

Hashes for jina_hubble_sdk-0.2.4a2-py3-none-any.whl
Algorithm Hash digest
SHA256 c25f1ab5e975d1918fd610f962d8e1d1d77d02c3a0e4227b82694be1a41f08ea
MD5 7891e72e5fc7a99b9f9bb7cd594bd862
BLAKE2b-256 538f0b272d5b51a36a2c1470c6e7ce87b22a32e9cf7ba68ac0482c92dd8262ea

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