[](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/source/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 the Octue SDK. Use it to start an Octue data service or digital
twin locally or run an analysis on one locally.
Read more in the docs: https://octue-python-sdk.readthedocs.io/en/latest/
Options:
--id UUID UUID of the analysis being undertaken. None
(for local use) will cause a unique ID to be
generated.
--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]
--force-reset / --no-force-reset
Forces a reset of analysis cache and outputs
[For future use, currently not implemented]
[default: force-reset]
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
deploy Deploy a python app to the cloud as an Octue service or digital...
run Run an analysis on the given input data using an Octue service...
start Start an Octue service or digital twin locally as a child so it...
```
## 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`
- `TEST_PROJECT_NAME=<name-of-google-cloud-project-to-run-pub-sub-tests-on>`
Then, from the repository root, run
```shell
python3 -m unittest
```
or
```shell
tox
```
## Contributing
Take a look at our [contributing](/docs/contributing.md) page.
Raw data
{
"_id": null,
"home_page": "https://www.github.com/octue/octue-sdk-python",
"name": "octue",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "digital, twins, twined, data, services, science, api, apps, ml",
"author": "Marcus Lugg",
"author_email": "marcus@octue.com",
"download_url": "https://files.pythonhosted.org/packages/14/0e/6f2f031b46f748c5061c877d12d5b86988b1f6768bee025f4056dfbcdfac/octue-0.60.2.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/source/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 the Octue SDK. Use it to start an Octue data service or digital\n twin locally or run an analysis on one locally.\n\n Read more in the docs: https://octue-python-sdk.readthedocs.io/en/latest/\n\nOptions:\n --id UUID UUID of the analysis being undertaken. None\n (for local use) will cause a unique ID to be\n generated.\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 --force-reset / --no-force-reset\n Forces a reset of analysis cache and outputs\n [For future use, currently not implemented]\n [default: force-reset]\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n deploy Deploy a python app to the cloud as an Octue service or digital...\n run Run an analysis on the given input data using an Octue service...\n start Start an Octue service or digital twin locally as a child so it...\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- `TEST_PROJECT_NAME=<name-of-google-cloud-project-to-run-pub-sub-tests-on>`\n\nThen, from the repository root, run\n\n```shell\npython3 -m unittest\n```\n\nor\n\n```shell\ntox\n```\n\n## Contributing\n\nTake a look at our [contributing](/docs/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.60.2",
"project_urls": {
"Homepage": "https://www.github.com/octue/octue-sdk-python",
"Repository": "https://www.github.com/octue/octue-sdk-python"
},
"split_keywords": [
"digital",
" twins",
" twined",
" data",
" services",
" science",
" api",
" apps",
" ml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be6837cff52c94385d0ab70be5880cbe839f41b62c8ee1c51c87286d5378c09f",
"md5": "22b922a3d493df3cb471c4e51b27c194",
"sha256": "71d10f92513cdf6b35552f39045f141f8717f9bcf7f3955155687348bc38886c"
},
"downloads": -1,
"filename": "octue-0.60.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22b922a3d493df3cb471c4e51b27c194",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 165918,
"upload_time": "2024-10-25T12:51:37",
"upload_time_iso_8601": "2024-10-25T12:51:37.848451Z",
"url": "https://files.pythonhosted.org/packages/be/68/37cff52c94385d0ab70be5880cbe839f41b62c8ee1c51c87286d5378c09f/octue-0.60.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "140e6f2f031b46f748c5061c877d12d5b86988b1f6768bee025f4056dfbcdfac",
"md5": "f2645cd0d01c5d2276ff0ecc914bfc54",
"sha256": "0058c99558eb1d4c02565420b69c9ba93d7ddddd79e13e9b3ed6c8504983a486"
},
"downloads": -1,
"filename": "octue-0.60.2.tar.gz",
"has_sig": false,
"md5_digest": "f2645cd0d01c5d2276ff0ecc914bfc54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 117834,
"upload_time": "2024-10-25T12:51:39",
"upload_time_iso_8601": "2024-10-25T12:51:39.777113Z",
"url": "https://files.pythonhosted.org/packages/14/0e/6f2f031b46f748c5061c877d12d5b86988b1f6768bee025f4056dfbcdfac/octue-0.60.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 12:51:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "octue",
"github_project": "octue-sdk-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "octue"
}
JSON
