# 🛰️ capella-console-client 🐐
[](https://pypi.org/project/capella-console-client/)
[](#)
[](#)
[](https://coveralls.io/github/capellaspace/console-client)
[](https://pypi.org/project/capella-console-client/)
[](https://capella-console-client.readthedocs.io)
Python SDK for api.capellaspace.com (task, search, order, download)
## Installation
```bash
pip install capella-console-client
```
## Requirements
* python >= 3.9, <4.0
* `capella-console-client` requires an active account on [console.capellaspace.com](https://console.capellaspace.com/). Sign up for an account at [https://www.capellaspace.com/community/](https://www.capellaspace.com/community/).
## Usage

```python
from capella_console_client import CapellaConsoleClient
# you will be prompted for console user (user@email.com)/ password before authenticating
client = CapellaConsoleClient(
verbose=True
)
# search for 2 open-data products
stac_items = client.search(
instrument_mode="spotlight",
product_type__in=["SLC", "GEO"],
collections=["capella-open-data"],
limit=2
)
# order
order_id = client.submit_order(items=stac_items, omit_search=True)
# download
product_paths = client.download_products(
order_id=order_id,
local_dir='/tmp',
show_progress=True
)
```
## Documentation
The documentation for `capella-console-client` can be found [here](https://capella-console-client.readthedocs.io).
## 🧙 capella-console-wizard 🧙♂️
starting with `capella-console-client>=0.8.0` the SDK ships with an interactive wizard-like CLI: `capella-console-wizard`
### Installation
```
pip install capella-console-client[wizard]
```
### Usage
```
capella-console-wizard --help
```
see
## Support
Please [open an issue](https://github.com/capellaspace/console-client/issues/new)
with enough information for us to reproduce your problem.
A [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
would be very helpful.
## Contributing
Contributions are very much welcomed and appreciated. See [how to contribute](https://capella-console-client.readthedocs.io/en/main/pages/contributors.html) for more information.
## License
• Licensed under the [MIT License](https://github.com/capellaspace/console-client/blob/master/LICENSE) • Copyright 2024 • Capella Space •
Raw data
{
"_id": null,
"home_page": "https://github.com/capellaspace/console-client",
"name": "capella-console-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Capella Space, Earth Observation, Capella Console, Synthetic Aperture Radar, SAR",
"author": "Thomas Beyer",
"author_email": "thomas.beyer@capellaspace.com",
"download_url": "https://files.pythonhosted.org/packages/06/3a/92e10da7a7118b1ac49ed5d004d60c346bc205fe7ef116d2a47a78cfa3de/capella_console_client-0.15.0.tar.gz",
"platform": null,
"description": "# \ud83d\udef0\ufe0f capella-console-client \ud83d\udc10\n\n[](https://pypi.org/project/capella-console-client/)\n[](#)\n[](#)\n[](https://coveralls.io/github/capellaspace/console-client)\n[](https://pypi.org/project/capella-console-client/)\n[](https://capella-console-client.readthedocs.io)\n\nPython SDK for api.capellaspace.com (task, search, order, download)\n\n\n## Installation\n\n```bash\npip install capella-console-client\n```\n\n## Requirements\n\n* python >= 3.9, <4.0\n* `capella-console-client` requires an active account on [console.capellaspace.com](https://console.capellaspace.com/). Sign up for an account at [https://www.capellaspace.com/community/](https://www.capellaspace.com/community/).\n\n\n## Usage\n\n\n\n```python\nfrom capella_console_client import CapellaConsoleClient\n\n# you will be prompted for console user (user@email.com)/ password before authenticating\nclient = CapellaConsoleClient(\n verbose=True\n)\n\n# search for 2 open-data products\nstac_items = client.search(\n instrument_mode=\"spotlight\",\n product_type__in=[\"SLC\", \"GEO\"],\n collections=[\"capella-open-data\"],\n limit=2\n)\n\n# order\norder_id = client.submit_order(items=stac_items, omit_search=True)\n\n# download\nproduct_paths = client.download_products(\n order_id=order_id,\n local_dir='/tmp',\n show_progress=True\n)\n```\n\n\n## Documentation\n\nThe documentation for `capella-console-client` can be found [here](https://capella-console-client.readthedocs.io).\n\n## \ud83e\uddd9\u200d capella-console-wizard \ud83e\uddd9\u200d\u2642\ufe0f\nstarting with `capella-console-client>=0.8.0` the SDK ships with an interactive wizard-like CLI: `capella-console-wizard`\n\n### Installation\n```\npip install capella-console-client[wizard]\n```\n\n### Usage\n```\ncapella-console-wizard --help\n```\n\nsee\n\n\n## Support\n\nPlease [open an issue](https://github.com/capellaspace/console-client/issues/new)\nwith enough information for us to reproduce your problem.\nA [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)\nwould be very helpful.\n\n## Contributing\n\nContributions are very much welcomed and appreciated. See [how to contribute](https://capella-console-client.readthedocs.io/en/main/pages/contributors.html) for more information.\n\n\n## License\n\u2022 Licensed under the [MIT License](https://github.com/capellaspace/console-client/blob/master/LICENSE) \u2022 Copyright 2024 \u2022 Capella Space \u2022\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for api.capellaspace.com (task, search, order, download)",
"version": "0.15.0",
"project_urls": {
"Documentation": "https://capella-console-client.readthedocs.io/",
"Homepage": "https://github.com/capellaspace/console-client",
"Repository": "https://github.com/capellaspace/console-client"
},
"split_keywords": [
"capella space",
" earth observation",
" capella console",
" synthetic aperture radar",
" sar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7be4d9b55a0bac01288b104f00e90664ae32d22e859b7fd65044de145d53da8",
"md5": "429c28f0d277bef9938349cc475aeafc",
"sha256": "4eb6723b921e5288075ed939d1b379b0e8a1a09f1f40054b170a571c4ebafab5"
},
"downloads": -1,
"filename": "capella_console_client-0.15.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "429c28f0d277bef9938349cc475aeafc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 53752,
"upload_time": "2025-01-24T20:03:24",
"upload_time_iso_8601": "2025-01-24T20:03:24.162673Z",
"url": "https://files.pythonhosted.org/packages/f7/be/4d9b55a0bac01288b104f00e90664ae32d22e859b7fd65044de145d53da8/capella_console_client-0.15.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "063a92e10da7a7118b1ac49ed5d004d60c346bc205fe7ef116d2a47a78cfa3de",
"md5": "29636fdae53e3009f9d71c529504dbd3",
"sha256": "285da74a9af14fe83bf397947fa71315aabb6c2252a36b602ea9c08778118970"
},
"downloads": -1,
"filename": "capella_console_client-0.15.0.tar.gz",
"has_sig": false,
"md5_digest": "29636fdae53e3009f9d71c529504dbd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 39167,
"upload_time": "2025-01-24T20:03:25",
"upload_time_iso_8601": "2025-01-24T20:03:25.601254Z",
"url": "https://files.pythonhosted.org/packages/06/3a/92e10da7a7118b1ac49ed5d004d60c346bc205fe7ef116d2a47a78cfa3de/capella_console_client-0.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 20:03:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "capellaspace",
"github_project": "console-client",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "capella-console-client"
}