Skip to main content

PyPI version Release codecov Documentation Status pre-commit black DOI

Octue Python SDK Purple Fruit Snake

The python SDK for running Octue data services, digital twins, and applications - get faster data groundwork so you have more time for the science!

Read the docs here.

Uses our twined library for data validation.

Installation and usage

To install, run one of:

pip install octue
poetry add octue

The command line interface (CLI) can then be accessed via:

octue --help
Usage: octue [OPTIONS] COMMAND [ARGS]...

  The CLI for Octue SDKs and APIs, most notably Twined.

  Read more in the docs: https://octue-python-sdk.readthedocs.io/en/latest/

Options:
  --log-level [debug|info|warning|error]
                                  Log level used for the analysis.  [default:
                                  info]
  --version                       Show the version and exit.
  -h, --help                      Show this message and exit.

Commands:
  twined  The Twined CLI.

Deprecated code

When code is deprecated, it will still work but a deprecation warning will be issued with a suggestion on how to update it. After an adjustment period, deprecations will be removed from the codebase according to the code removal schedule. This constitutes a breaking change.

Developer notes

Installation

We use Poetry as our package manager. For development, run the following from the repository root, which will editably install the package:

poetry install --all-extras

Then run the tests to check everything's working.

Testing

These environment variables need to be set to run the tests:

  • GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/service/account/file.json

Then, from the repository root, run

python3 -m unittest

Contributing

Take a look at our contributing page.

Metadata

Release files for octue 0.69.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for octue 0.69.1
File Size Uploaded Provenance
octue-0.69.1.tar.gz 547.7 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for octue 0.69.1
File Interpreter ABI Platform
octue-0.69.1-py3-none-any.whl Python 3 none any Details

Total release size: 1.2 MB

Release files / octue-0.69.1.tar.gz

Download URL octue-0.69.1.tar.gz
Size 547.7 kB
Tags Source
SHA-256 checksum
How to use checksums
674790f9ec9989970f99d3dbae7b4a047f2148e18e9370e198c5cb6ae9b4b33d
BLAKE2b-256 checksum
How to use checksums
2f6d14411b27c884144d88913e44ca07ad9bfa6a090454b7cf6b2e98e6a9ec6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

Release files / octue-0.69.1-py3-none-any.whl

Download URL octue-0.69.1-py3-none-any.whl
Size 618.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2338f80a81cf22cad22f742e9a303df2912fed0153b41d6bbc2f6fb9bf892b9f
BLAKE2b-256 checksum
How to use checksums
0227d16bab9e590630a6d0259c14fa32b8f6a3780d5f5735f47433f2ba8ad948
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

Security for octue 0.69.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for octue-0.69.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.69.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page