Metadata-Version: 2.4
Name: eodash_catalog
Version: 0.4.5
Summary: This package is intended to help create a compatible STAC catalog for the eodash dashboard client. It supports configuration of multiple endpoint types for information extraction.
Project-URL: Documentation, https://github.com/eodash/eodash_catalog#readme
Project-URL: Issues, https://github.com/eodash/eodash_catalog/issues
Project-URL: Source, https://github.com/eodash/eodash_catalog
Author-email: Daniel Santillan <daniel.santillan@eox.at>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: click
Requires-Dist: click<9
Requires-Dist: oauthlib<3.3
Requires-Dist: owslib
Requires-Dist: pystac-client<1
Requires-Dist: pystac[validation]<2
Requires-Dist: python-dateutil<3
Requires-Dist: python-dotenv<1.1.0
Requires-Dist: pyyaml<7
Requires-Dist: requests-oauthlib<1.3.2
Requires-Dist: requests<3
Requires-Dist: setuptools<71
Requires-Dist: spdx-lookup<=0.3.3
Requires-Dist: stac-geoparquet<=0.7.0
Requires-Dist: structlog<22.0
Description-Content-Type: text/markdown

# eodash_catalog

[![PyPI - Version](https://img.shields.io/pypi/v/eodash_catalog.svg)](https://pypi.org/project/eodash_catalog)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eodash_catalog.svg)](https://pypi.org/project/eodash_catalog)

---

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install eodash_catalog
```

## Testing

Project uses pytest and runs it as part of CI:

```bash
python -m pytest
```

## Testing

Project uses ruff to perform checks on code style and formatting

```bash
ruff check .
```

## Versioning and branches

eodash_catalog adheres to [Semantic Versioning](https://semver.org/) and follows these rules:

Given a version number `MAJOR.MINOR.PATCH`, we increment the:

- `MAJOR` version when we make incompatible API changes
- `MINOR` version when we add functionality in a backward compatible manner
- `PATCH` version when we make backward compatible bug fixes

Active development is followed by the `main` branch.
`
New features or maintenance commits should be done against this branch in the form of a Merge Request of a Feature branch.

## Tagging

This repository uses bump2version for managing tags. To bump a version use

```bash
bump2version <major|minor|patch> # or bump2version --new-version <new_version>
git push && git push --tags
```

Pushing a tag in the repository automatically creates:

- versioned package on pypi

## License

`eodash_catalog` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Wiki

eodash_catalog wiki contains meaning of most of configurable parameters of the collections, indicators and catalogs.

For one-time export of the wiki as single PDF, do following:

```bash
git clone https://github.com/eodash/eodash_catalog.wiki.git
cd eodash_catalog.wiki
for f in *.md; do pandoc -V geometry:margin=1in "$f" -o "$f".pdf; done
now=`date +'%Y%m%d'` && pdftk Home.md.pdf Data-integration-steps.md.pdf "Data-definition-‐-first-steps.md.pdf" Auxiliary-layers.md.pdf Colorlegend.md.pdf DataSource.md.pdf Locations.md.pdf Process.md.pdf Projection.md.pdf Provider.md.pdf Reference.md.pdf Resource.md.pdf Service.md.pdf Story.md.pdf output eodash-catalog-wiki-snapshot-$now.pdf
```
Add missing files if new wiki pages have been added in the meantime.
