Skip to main content

Python SDK and command-line interface for the Diffuse research data platform.

Project description

diffuse-hub

Python SDK and command-line interface for the Diffuse research data platform.

Manage experiments, metadata, and artifacts from your terminal or programmatically from notebooks and scripts.

Installation

# Full install (CLI + SDK)
pip install "diffuse-hub[cli]"

# SDK only (lightweight, no CLI deps)
pip install diffuse-hub

Or run the CLI without installing:

uvx --from "diffuse-hub[cli]" diffuse --help

For a persistent CLI install on your PATH:

uv tool install "diffuse-hub[cli]"
diffuse --help

Quickstart

CLI

diffuse auth login
diffuse experiments list
diffuse experiments create --title "My Experiment" --tags ml,vision
diffuse artifacts upload ./data.h5 --experiment EXP-1

Run diffuse --help for the full command reference.

SDK

from diffuse_cli.sdk import Diffuse

diffuse = Diffuse()  # reads config / env vars for auth

experiments = diffuse.experiments.list(query="tag:crystal", sort="recent")
exp = diffuse.experiments.get("EXP-1")

artifacts = diffuse.artifacts.list(experiment="EXP-1")
url = diffuse.artifacts.download_url("abc123")

Configuration

The CLI reads ~/.diffuse/config.json and the following environment variables:

Variable Purpose
DIFFUSE_API_URL Override the API base URL
DIFFUSE_API_KEY Authenticate with a personal / system API key (dfk_...)
DIFFUSE_ENV Shorthand: local or prod

Links

License

Apache-2.0

Project details


Download files

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

Source Distribution

diffuse_hub-0.4.36.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

diffuse_hub-0.4.36-py3-none-any.whl (54.8 kB view details)

Uploaded Python 3

File details

Details for the file diffuse_hub-0.4.36.tar.gz.

File metadata

  • Download URL: diffuse_hub-0.4.36.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for diffuse_hub-0.4.36.tar.gz
Algorithm Hash digest
SHA256 4ba9836331c173a839bf767164f4266788e95b4d126ddb532b3887e78dc1f46c
MD5 beb81f036c8318eac5fab71746366277
BLAKE2b-256 4304f0b92d4d2d31b3f342009e83936f8c0ff25776e73ed2e10568fc4e053cc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for diffuse_hub-0.4.36.tar.gz:

Publisher: release.yml on diff-use/webapp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file diffuse_hub-0.4.36-py3-none-any.whl.

File metadata

  • Download URL: diffuse_hub-0.4.36-py3-none-any.whl
  • Upload date:
  • Size: 54.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for diffuse_hub-0.4.36-py3-none-any.whl
Algorithm Hash digest
SHA256 98741be81ec10cd2eb159337c27175f49acc566d7123334d67d4fcb124980410
MD5 86198fae74183b9d8b4c56a8cfef50e4
BLAKE2b-256 8b0d3600e59d72f87a58effbb236edf87b535a06d4a3811fdf9011c82eac6224

See more details on using hashes here.

Provenance

The following attestation bundles were made for diffuse_hub-0.4.36-py3-none-any.whl:

Publisher: release.yml on diff-use/webapp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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