capella-console-client


Namecapella-console-client JSON
Version 0.13.0 PyPI version JSON
download
home_pagehttps://github.com/capellaspace/console-client
SummaryPython SDK for api.capellaspace.com (task, search, order, download)
upload_time2024-02-28 18:22:59
maintainer
docs_urlNone
authorThomas Beyer
requires_python>=3.8,<4.0
licenseMIT
keywords capella space earth observation capella console synthetic aperture radar sar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage 
            # 🛰️ capella-console-client 🐐

[![Version](https://img.shields.io/pypi/v/capella-console-client.svg)](https://pypi.org/project/capella-console-client/)
[![License](https://img.shields.io/pypi/l/capella-console-client.svg)](#)
[![CI](https://github.com/capellaspace/console-client/workflows/CI/badge.svg)](#)
[![Coverage](https://coveralls.io/repos/github/capellaspace/console-client/badge.svg?branch=main)](https://coveralls.io/github/capellaspace/console-client)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/capella-console-client.svg)](https://pypi.org/project/capella-console-client/)
[![Documentation](https://readthedocs.org/projects/capella-console-client/badge/?version=main)](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.8, <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

![Quickstart](docs/images/quickstart.gif)

```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": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "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/7b/98/6b34d9a65ae3689387784773ecdada942cfe2029beab144dc22596364a59/capella_console_client-0.13.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\udef0\ufe0f capella-console-client \ud83d\udc10\n\n[![Version](https://img.shields.io/pypi/v/capella-console-client.svg)](https://pypi.org/project/capella-console-client/)\n[![License](https://img.shields.io/pypi/l/capella-console-client.svg)](#)\n[![CI](https://github.com/capellaspace/console-client/workflows/CI/badge.svg)](#)\n[![Coverage](https://coveralls.io/repos/github/capellaspace/console-client/badge.svg?branch=main)](https://coveralls.io/github/capellaspace/console-client)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/capella-console-client.svg)](https://pypi.org/project/capella-console-client/)\n[![Documentation](https://readthedocs.org/projects/capella-console-client/badge/?version=main)](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.8, <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![Quickstart](docs/images/quickstart.gif)\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.13.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": "6dc512bd72d231bbbbf5ef7478502a643717756c4f23a2fc16761e4c7b2e1354",
                "md5": "a2bb7e4a1e181ef9431df34b46f6baa6",
                "sha256": "1690612758f90e8359d197a9bc880885a0d67660c67ac9331c76832febeb41e1"
            },
            "downloads": -1,
            "filename": "capella_console_client-0.13.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a2bb7e4a1e181ef9431df34b46f6baa6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 51805,
            "upload_time": "2024-02-28T18:22:57",
            "upload_time_iso_8601": "2024-02-28T18:22:57.283016Z",
            "url": "https://files.pythonhosted.org/packages/6d/c5/12bd72d231bbbbf5ef7478502a643717756c4f23a2fc16761e4c7b2e1354/capella_console_client-0.13.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b986b34d9a65ae3689387784773ecdada942cfe2029beab144dc22596364a59",
                "md5": "957da3211d829f3fc67e0c02196a8a3a",
                "sha256": "049df520a122d3d01822cf48272544ed99aacfa006fd319400175c7fe6f811d1"
            },
            "downloads": -1,
            "filename": "capella_console_client-0.13.0.tar.gz",
            "has_sig": false,
            "md5_digest": "957da3211d829f3fc67e0c02196a8a3a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 39603,
            "upload_time": "2024-02-28T18:22:59",
            "upload_time_iso_8601": "2024-02-28T18:22:59.174253Z",
            "url": "https://files.pythonhosted.org/packages/7b/98/6b34d9a65ae3689387784773ecdada942cfe2029beab144dc22596364a59/capella_console_client-0.13.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-28 18:22:59",
    "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"
}
Thomas Beyer
Elapsed time: 0.20529s