[](https://badge.fury.io/py/octue)
[](https://github.com/octue/octue-sdk-python/actions/workflows/release.yml)
[](https://codecov.io/gh/octue/octue-sdk-python)
[](https://octue-python-sdk.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/ambv/black)
[](https://doi.org/10.5281/zenodo.10961975)
# Octue Python SDK <img src="./docs/images/213_purple-fruit-snake-transparent.gif" alt="Purple Fruit Snake" width="100"/></span>
The python SDK for running [Octue](https://octue.com) data services, digital twins, and applications - get faster data
groundwork so you have more time for the science!
Read the docs [here.](https://octue-python-sdk.readthedocs.io/en/latest/)
Uses our [twined](https://twined.readthedocs.io/en/latest/) library for data validation.
## Installation and usage
To install, run one of:
```shell
pip install octue
```
```shell
poetry add octue
```
The command line interface (CLI) can then be accessed via:
```shell
octue --help
```
```text
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:
--logger-uri TEXT Stream logs to a websocket at the given URI.
--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](https://github.com/octue/octue-sdk-python/issues/415).
This constitutes a breaking change.
## Developer notes
### Installation
We use [Poetry](https://python-poetry.org/) as our package manager. For development, run the following from the
repository root, which will editably install the package:
```shell
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
```shell
python3 -m unittest
```
## Contributing
Take a look at our [contributing](/CONTRIBUTING.md) page.
Raw data
{
"_id": null,
"home_page": null,
"name": "octue",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "digital, twins, twined, data, services, science, api, apps, ml, python, schema",
"author": "Marcus Lugg",
"author_email": "marcus@octue.com",
"download_url": "https://files.pythonhosted.org/packages/dc/14/7c6514726d3065b40c9a956b93f06587362bb1ca0c6f83093580200fb76a/octue-0.68.0.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/octue)\n[](https://github.com/octue/octue-sdk-python/actions/workflows/release.yml)\n[](https://codecov.io/gh/octue/octue-sdk-python)\n[](https://octue-python-sdk.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/ambv/black)\n[](https://doi.org/10.5281/zenodo.10961975)\n\n# Octue Python SDK <img src=\"./docs/images/213_purple-fruit-snake-transparent.gif\" alt=\"Purple Fruit Snake\" width=\"100\"/></span>\n\nThe python SDK for running [Octue](https://octue.com) data services, digital twins, and applications - get faster data\ngroundwork so you have more time for the science!\n\nRead the docs [here.](https://octue-python-sdk.readthedocs.io/en/latest/)\n\nUses our [twined](https://twined.readthedocs.io/en/latest/) library for data validation.\n\n## Installation and usage\n\nTo install, run one of:\n\n```shell\npip install octue\n```\n\n```shell\npoetry add octue\n```\n\nThe command line interface (CLI) can then be accessed via:\n\n```shell\noctue --help\n```\n\n```text\nUsage: octue [OPTIONS] COMMAND [ARGS]...\n\n The CLI for Octue SDKs and APIs, most notably Twined.\n\n Read more in the docs: https://octue-python-sdk.readthedocs.io/en/latest/\n\nOptions:\n --logger-uri TEXT Stream logs to a websocket at the given URI.\n --log-level [debug|info|warning|error]\n Log level used for the analysis. [default:\n info]\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n twined The Twined CLI.\n```\n\n## Deprecated code\n\nWhen code is deprecated, it will still work but a deprecation warning will be issued with a suggestion on how to update\nit. After an adjustment period, deprecations will be removed from the codebase according to the [code removal schedule](https://github.com/octue/octue-sdk-python/issues/415).\nThis constitutes a breaking change.\n\n## Developer notes\n\n### Installation\n\nWe use [Poetry](https://python-poetry.org/) as our package manager. For development, run the following from the\nrepository root, which will editably install the package:\n\n```shell\npoetry install --all-extras\n```\n\nThen run the tests to check everything's working.\n\n### Testing\n\nThese environment variables need to be set to run the tests:\n\n- `GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/service/account/file.json`\n\nThen, from the repository root, run\n\n```shell\npython3 -m unittest\n```\n\n## Contributing\n\nTake a look at our [contributing](/CONTRIBUTING.md) page.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package providing template applications for data services, and a python SDK to the Octue API.",
"version": "0.68.0",
"project_urls": {
"Repository": "https://www.github.com/octue/octue-sdk-python"
},
"split_keywords": [
"digital",
" twins",
" twined",
" data",
" services",
" science",
" api",
" apps",
" ml",
" python",
" schema"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f1b912d8e7cfed11992ed0f49fe36131ceeaacec9d9a11eda567cd6293f50797",
"md5": "058ab5e0d5d41c17d50dbc167084bb1d",
"sha256": "c57e78c87ca3708c23a6fd7c127b2fa7da105770985ebc5ce31fd3aea4d62fa2"
},
"downloads": -1,
"filename": "octue-0.68.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "058ab5e0d5d41c17d50dbc167084bb1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 616828,
"upload_time": "2025-08-19T22:07:32",
"upload_time_iso_8601": "2025-08-19T22:07:32.477402Z",
"url": "https://files.pythonhosted.org/packages/f1/b9/12d8e7cfed11992ed0f49fe36131ceeaacec9d9a11eda567cd6293f50797/octue-0.68.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dc147c6514726d3065b40c9a956b93f06587362bb1ca0c6f83093580200fb76a",
"md5": "ba03e618e5e310b3781c15830f0fb7e9",
"sha256": "970c9c73c49a15b03abbab51f94e904fbc1f7a139a9746ccd7424d2841faae33"
},
"downloads": -1,
"filename": "octue-0.68.0.tar.gz",
"has_sig": false,
"md5_digest": "ba03e618e5e310b3781c15830f0fb7e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 546956,
"upload_time": "2025-08-19T22:07:34",
"upload_time_iso_8601": "2025-08-19T22:07:34.271130Z",
"url": "https://files.pythonhosted.org/packages/dc/14/7c6514726d3065b40c9a956b93f06587362bb1ca0c6f83093580200fb76a/octue-0.68.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 22:07:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "octue",
"github_project": "octue-sdk-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "octue"
}
JSON
