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.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jina-hubble-sdk-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 bab9b7b4d8c5965e099e07effd92cc0607b56eead0b4d26d6e5b473cb93daf8f
MD5 35a342cd114df3045dc9ff06e4dc7df3
BLAKE2b-256 d0b764717f657442eb71b2e3f9e38ff37b7b30e6cce36e36b06188f1a93aa975

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jina_hubble_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 490ee3158b164c7d9f9f2246266c60623dd9426afc6d27b4fc2f9fe7b2490e21
MD5 b8597c93ba045b3dceaa307e4ca36f48
BLAKE2b-256 f220ef109cc67d27957df9f9478871b51936112a6f2baf122c4eb559226d7482

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