# cdsodatacli
<div align="center">
[![Build status](https://github.com/umr-lops/cdsodatacli/workflows/build/badge.svg?branch=main&event=push)](https://github.com/umr-lops/cdsodatacli/actions?query=workflow%3Abuild)
[![Python Version](https://img.shields.io/pypi/pyversions/cdsodatacli.svg)](https://pypi.org/project/cdsodatacli/)
[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/umr-lops/cdsodatacli/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/umr-lops/cdsodatacli/blob/main/.pre-commit-config.yaml)
[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/umr-lops/cdsodatacli/releases)
[![License](https://img.shields.io/github/license/umr-lops/cdsodatacli)](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE)
![Coverage Report](assets/images/coverage.svg)
odata client for Copernicus Data Space catalog
</div>
## Very first steps
### step 1: create a config file
* create a copy of the config.yml called localconfig.yml where `cdsodatacli` is installed in your python environement.
```bash
cp config.yml localconfig.yml
```
* edit the localconfig.yml to set your own path for output directories and CDSE accounts
```bash
vi localconfig.yml
```
### step 2: do a query on CDSE Odata API
```bash
queryCDS -h
# or
queryCDS --collection SENTINEL-1 --startdate 20230101T00:00:00 --stopdate 20230105T10:10:10 --mode IW --product SLC --querymode seq --geometry "POINT (-5.02 48.4)"
```
or use the method `cdsodatacli.query.fetch_data()`
### step 3: download a listing of product
```bash
downloadFromCDS -h
```
## Installation
```bash
pip install -U cdsodatacli
```
## 🛡 License
[![License](https://img.shields.io/github/license/umr-lops/cdsodatacli)](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE) for more details.
## 📃 Citation
```bibtex
@misc{cdsodatacli,
author = {umr-lops},
title = {odata client for Copernicus Data Space catalog},
year = {2023},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/umr-lops/cdsodatacli}}
}
```
## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
Raw data
{
"_id": null,
"home_page": "",
"name": "cdsodatacli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Odata,copernicus-data-space,api",
"author": "Antoine Grouazel, Jean-Renaud Miadana",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/4b/77/decf295fd2ea4adf6c3c04e955c66f4c6d63bb205f736a10c2e9bf99bb3d/cdsodatacli-2024.3.11.tar.gz",
"platform": null,
"description": "# cdsodatacli\n\n<div align=\"center\">\n\n[![Build status](https://github.com/umr-lops/cdsodatacli/workflows/build/badge.svg?branch=main&event=push)](https://github.com/umr-lops/cdsodatacli/actions?query=workflow%3Abuild)\n[![Python Version](https://img.shields.io/pypi/pyversions/cdsodatacli.svg)](https://pypi.org/project/cdsodatacli/)\n[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/umr-lops/cdsodatacli/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/umr-lops/cdsodatacli/blob/main/.pre-commit-config.yaml)\n[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/umr-lops/cdsodatacli/releases)\n[![License](https://img.shields.io/github/license/umr-lops/cdsodatacli)](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE)\n![Coverage Report](assets/images/coverage.svg)\n\nodata client for Copernicus Data Space catalog\n\n</div>\n\n## Very first steps\n\n### step 1: create a config file\n \n* create a copy of the config.yml called localconfig.yml where `cdsodatacli` is installed in your python environement.\n```bash\ncp config.yml localconfig.yml \n``` \n * edit the localconfig.yml to set your own path for output directories and CDSE accounts\n```bash\n vi localconfig.yml\n ```\n\n### step 2: do a query on CDSE Odata API\n\n```bash\nqueryCDS -h\n# or\nqueryCDS --collection SENTINEL-1 --startdate 20230101T00:00:00 --stopdate 20230105T10:10:10 --mode IW --product SLC --querymode seq --geometry \"POINT (-5.02 48.4)\"\n```\n\nor use the method `cdsodatacli.query.fetch_data()`\n\n### step 3: download a listing of product\n\n```bash\ndownloadFromCDS -h\n```\n\n## Installation\n\n```bash\npip install -U cdsodatacli\n```\n\n\n## \ud83d\udee1 License\n\n[![License](https://img.shields.io/github/license/umr-lops/cdsodatacli)](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/umr-lops/cdsodatacli/blob/main/LICENSE) for more details.\n\n## \ud83d\udcc3 Citation\n\n```bibtex\n@misc{cdsodatacli,\n author = {umr-lops},\n title = {odata client for Copernicus Data Space catalog},\n year = {2023},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/umr-lops/cdsodatacli}}\n}\n```\n\n## Credits [![\ud83d\ude80 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)\n\nThis project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OData client for Copernicus Data Space catalog",
"version": "2024.3.11",
"project_urls": null,
"split_keywords": [
"odata",
"copernicus-data-space",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b77decf295fd2ea4adf6c3c04e955c66f4c6d63bb205f736a10c2e9bf99bb3d",
"md5": "d1f5b2ae37fbd5f87aa8d6f04fbb1431",
"sha256": "bb9c7b57c552fb26be5413a06db2b316b2a176d3f69f470a03e21f6b2f3417c6"
},
"downloads": -1,
"filename": "cdsodatacli-2024.3.11.tar.gz",
"has_sig": false,
"md5_digest": "d1f5b2ae37fbd5f87aa8d6f04fbb1431",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47831,
"upload_time": "2024-03-11T15:41:16",
"upload_time_iso_8601": "2024-03-11T15:41:16.957018Z",
"url": "https://files.pythonhosted.org/packages/4b/77/decf295fd2ea4adf6c3c04e955c66f4c6d63bb205f736a10c2e9bf99bb3d/cdsodatacli-2024.3.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 15:41:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cdsodatacli"
}