Skip to main content

xoople-cli

Command-line interface for the Xoople Products API, over xoople-sdk.

$ uv tool install xoople-cli
$ export XOOPLE_API_URL=https://api.xoople.com XOOPLE_TOKEN=...
$ xoople analyses list

Every command reads --api-url and --token from XOOPLE_API_URL and XOOPLE_TOKEN. --json prints the API response verbatim instead of a table, so output pipes into jq.

Commands

Group Commands
analyses list get create update cancel estimate
runs list get
outputs list get access-url
schedules list get create pause resume cancel run estimate-run
events list get
usage history limits
catalog products measures designs
access me token features

Submitting an analysis

The product spec is deeply nested and differs per product, so create and estimate take it as JSON rather than as flags:

$ xoople catalog designs --json | jq '.[0].spec_fragment' > spec.json
$ # fill in period and aoi, then:
$ xoople analyses create -f spec.json --display-name "South Wales NDVI" --wait

The file holds either the bare spec or a whole create request (anything with a spec key). -f - reads stdin. --wait polls the initial run and exits non-zero if it does not reach COMPLETE.

Exit codes

0 success · 1 unexpected CLI error · 2 usage error · 3 unauthenticated · 4 forbidden · 5 not found · 6 bad request or validation · 7 conflict · 8 rate limited · 9 server error · 10 connection failure · 11 unreadable response · 12 run finished in a non-COMPLETE state · 13 --wait timed out.

Metadata

Release files for xoople-cli 0.2.0

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

Source distribution (sdist)

Source distribution for xoople-cli 0.2.0
File Size Uploaded Provenance
xoople_cli-0.2.0.tar.gz 16.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for xoople-cli 0.2.0
File Interpreter ABI Platform
xoople_cli-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 39.6 kB

Release files / xoople_cli-0.2.0.tar.gz

Download URL xoople_cli-0.2.0.tar.gz
Size 16.1 kB
Tags Source
SHA-256 checksum
How to use checksums
55305f8de385e160e0e7a4101f57425b002e4ac8db8604f6515960b67147326b
BLAKE2b-256 checksum
How to use checksums
c3dd9781e347bf5dbea220ceb509daa4fd31710a7b1799293e6c1efe6cd294ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / xoople_cli-0.2.0-py3-none-any.whl

Download URL xoople_cli-0.2.0-py3-none-any.whl
Size 23.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1fa34f51b8b8110dcfafffb747d325246dee9734477a70172f4d49439cc58443
BLAKE2b-256 checksum
How to use checksums
00447e1cd81a498da267687d32432ed667408f09c9b7e5fffa00b97b965c2502
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for xoople-cli 0.2.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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