pystac-monty 0.2.0__tar.gz

pystac_monty-0.2.0/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2019-2024 the authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

pystac_monty-0.2.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: pystac_monty
+Version: 0.2.0
+Summary: Python library for working with the SpatioTemporal Asset Catalog (STAC) extension for Montandon
+Author-email: Emmanuel Mathot <emmanuel.mathot@gmail.com>
+License: Apache-2.0
+Project-URL: Documentation, https://ifrcgo.org/monty-stac-extension/
+Project-URL: Repository, https://github.com/IFRCGo/pystac-monty
+Project-URL: Issues, https://github.com/IFRCGo/pystac-monty/issues
+Project-URL: Changelog, https://github.com/IFRCGo/pystac-monty/blob/main/CHANGELOG.md
+Project-URL: Discussions, https://github.com/radiantearth/stac-spec/discussions/categories/stac-software
+Keywords: pystac,disaster,hazard,catalog,STAC,Montandon,Monty
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.7.0
+Requires-Dist: pystac>=1.11.0
+Requires-Dist: geojson>=2.5.0
+Requires-Dist: markdownify>=0.14.1
+Requires-Dist: pytz>=2021.1
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: lxml>=5.3.0
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: ijson>=3.4.0
+Requires-Dist: pyarrow>=22.0.0
+Requires-Dist: shapely>=2.0.0
+Dynamic: license-file
+
+# Montandon Extension for PySTAC
+
+This project provides a Python library for working with the SpatioTemporal Asset Catalog (STAC) extension for Montandon. It extends the capabilities of PySTAC to handle disaster and hazard-related data using the Montandon schema.
+
+## Features
+
+- Extend STAC Collections and Items with Montandon-specific properties.
+- Support for hazard detail objects.
+- Integration with GDACS data sources.
+- Utilities for pairing and correlation ID generation.
+
+## Installation
+
+To install the library, use pip:
+
+```sh
+pip install pystac_monty
+```
+
+To install the tool `jq`, use the following:
+
+Debian/Ubuntu/Mint environment
+```sh
+sudo apt-get update
+sudo apt-get install jq
+```
+
+MacOS environment
+```sh
+brew install jq
+```
+
+To check if it is install correctly
+
+```sh
+jq --version
+```
+
+## Usage
+
+### Batch export (CLI)
+
+To export upstream source files to on-disk Monty STAC, first initialise the submodule:
+
+```sh
+git submodule update --init --recursive
+```
+
+Then run the CLI. `SOURCE` is one of `glide`, `gfd`, `gdacs`; `--input` accepts a source-specific file (see the `convert_*` docstrings in `pystac_monty/sources/batch_export.py`):
+
+```sh
+pystac-monty SOURCE --input path/to/input --output path/to/output/
+```
+
+The output directory will contain role collections (`{slug}-events/`, `{slug}-hazards/`, etc.), each with a collection JSON and flat item files. Raw source payloads live in `monty-stac-extension/docs/model/sources/` — the `examples/` folders are published STAC output, not inputs.
+
+To add more sources or use the exporter programmatically, see `pystac_monty/exporter.py`.
+
+### Extending a STAC Item
+
+The library provides classes and functions to work with Montandon STAC objects. Here is an example of how to create a Montandon Item:
+
+```python
+import pystac
+from pystac_monty.extension import MontyExtension
+
+item = pystac.Item(...)  # Create or load a STAC Item
+monty_ext = MontyExtension.ext(item)
+monty_ext.episode_number = 1
+print(monty_ext.episode_number)
+```
+
+### Working with GDACS data
+
+To transform GDACS event data into STAC Items:
+
+```python
+from pystac_monty.sources.gdacs import GDACSTransformer, GDACSDataSource
+
+data_source = GDACSDataSource(source_url="...", data="...", type=GDACSDataSourceType.EVENT)
+transformer = GDACSTransformer(data=[data_source])
+items = transformer.make_items()
+```
+
+## Development
+
+To set up the development environment:
+
+```sh
+pip install uv
+uv sync
+```
+
+To run the tests:
+
+1. Make the test with actual calls to http and write them in the cassette files:
+
+```sh
+uv run pytest -v -s --record-mode rewrite
+```
+
+2. Run the tests with the recorded calls:
+
+```sh
+uv run pytest -v -s
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.
+
+### Links
+
+- [Documentation](https://pystac.readthedocs.io)
+- [Repository](https://github.com/IFRCGo/monty-stac-extension)
+- [Issues](https://github.com/IFRCGo/monty-stac-extension/issues)

pystac_monty-0.2.0/README.md

@@ -0,0 +1,120 @@
+# Montandon Extension for PySTAC
+
+This project provides a Python library for working with the SpatioTemporal Asset Catalog (STAC) extension for Montandon. It extends the capabilities of PySTAC to handle disaster and hazard-related data using the Montandon schema.
+
+## Features
+
+- Extend STAC Collections and Items with Montandon-specific properties.
+- Support for hazard detail objects.
+- Integration with GDACS data sources.
+- Utilities for pairing and correlation ID generation.
+
+## Installation
+
+To install the library, use pip:
+
+```sh
+pip install pystac_monty
+```
+
+To install the tool `jq`, use the following:
+
+Debian/Ubuntu/Mint environment
+```sh
+sudo apt-get update
+sudo apt-get install jq
+```
+
+MacOS environment
+```sh
+brew install jq
+```
+
+To check if it is install correctly
+
+```sh
+jq --version
+```
+
+## Usage
+
+### Batch export (CLI)
+
+To export upstream source files to on-disk Monty STAC, first initialise the submodule:
+
+```sh
+git submodule update --init --recursive
+```
+
+Then run the CLI. `SOURCE` is one of `glide`, `gfd`, `gdacs`; `--input` accepts a source-specific file (see the `convert_*` docstrings in `pystac_monty/sources/batch_export.py`):
+
+```sh
+pystac-monty SOURCE --input path/to/input --output path/to/output/
+```
+
+The output directory will contain role collections (`{slug}-events/`, `{slug}-hazards/`, etc.), each with a collection JSON and flat item files. Raw source payloads live in `monty-stac-extension/docs/model/sources/` — the `examples/` folders are published STAC output, not inputs.
+
+To add more sources or use the exporter programmatically, see `pystac_monty/exporter.py`.
+
+### Extending a STAC Item
+
+The library provides classes and functions to work with Montandon STAC objects. Here is an example of how to create a Montandon Item:
+
+```python
+import pystac
+from pystac_monty.extension import MontyExtension
+
+item = pystac.Item(...)  # Create or load a STAC Item
+monty_ext = MontyExtension.ext(item)
+monty_ext.episode_number = 1
+print(monty_ext.episode_number)
+```
+
+### Working with GDACS data
+
+To transform GDACS event data into STAC Items:
+
+```python
+from pystac_monty.sources.gdacs import GDACSTransformer, GDACSDataSource
+
+data_source = GDACSDataSource(source_url="...", data="...", type=GDACSDataSourceType.EVENT)
+transformer = GDACSTransformer(data=[data_source])
+items = transformer.make_items()
+```
+
+## Development
+
+To set up the development environment:
+
+```sh
+pip install uv
+uv sync
+```
+
+To run the tests:
+
+1. Make the test with actual calls to http and write them in the cassette files:
+
+```sh
+uv run pytest -v -s --record-mode rewrite
+```
+
+2. Run the tests with the recorded calls:
+
+```sh
+uv run pytest -v -s
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.
+
+### Links
+
+- [Documentation](https://pystac.readthedocs.io)
+- [Repository](https://github.com/IFRCGo/monty-stac-extension)
+- [Issues](https://github.com/IFRCGo/monty-stac-extension/issues)

pystac_monty-0.2.0/pyproject.toml

@@ -0,0 +1,164 @@
+[project]
+name = "pystac_monty"
+description = "Python library for working with the SpatioTemporal Asset Catalog (STAC) extension for Montandon"
+readme = "README.md"
+authors = [{ name = "Emmanuel Mathot", email = "emmanuel.mathot@gmail.com" }]
+keywords = [
+    "pystac",
+    "disaster",
+    "hazard",
+    "catalog",
+    "STAC",
+    "Montandon",
+    "Monty",
+]
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "python-dateutil>=2.7.0",
+    "pystac>=1.11.0",
+    "geojson>=2.5.0",
+    "markdownify>=0.14.1",
+    "pytz>=2021.1",
+    "pandas>=2.2.0",
+    "lxml>=5.3.0",
+    "pydantic>=2.10.6",
+    "ijson>=3.4.0",
+    "pyarrow>=22.0.0",
+    "shapely>=2.0.0",
+]
+dynamic = ["version"]
+
+[project.urls]
+Documentation = "https://ifrcgo.org/monty-stac-extension/"
+Repository = "https://github.com/IFRCGo/pystac-monty"
+Issues = "https://github.com/IFRCGo/pystac-monty/issues"
+Changelog = "https://github.com/IFRCGo/pystac-monty/blob/main/CHANGELOG.md"
+Discussions = "https://github.com/radiantearth/stac-spec/discussions/categories/stac-software"
+
+[project.scripts]
+pystac-monty = "pystac_monty.cli:main"
+
+[tool.coverage.run]
+branch = true
+source = ["pystac_monty"]
+# omit = ["pystac/extensions/label.py"]
+
+[tool.coverage.report]
+fail_under = 90
+exclude_lines = ["if TYPE_CHECKING:"]
+
+[tool.doc8]
+ignore-path = ["docs/_build", "docs/tutorials"]
+max-line-length = 88
+
+[tool.mypy]
+show_error_codes = true
+strict = true
+
+[[tool.mypy.overrides]]
+module = ["jinja2"]
+ignore_missing_imports = true
+
+[tool.pyright]
+exclude = [
+    "**/__pycache__",
+    "**/snap_test_*.py",
+    ".venv/",
+    "**/migrations/*.py",
+    "tests/**",
+    "notebooks/**",
+]
+reportMissingImports = true
+reportMissingTypeStubs = false
+typeCheckingMode = "basic"
+reportAttributeAccessIssue = "warning"
+reportArgumentType = "warning"
+reportCallIssue = "warning"
+reportReturnType = "warning"
+reportAssignmentType = "warning"
+reportGeneralTypeIssues = "warning"
+reportOptionalMemberAccess = "warning"
+reportOptionalSubscript = "warning"
+reportInvalidTypeForm = "warning"
+venvPath = "."
+venv = ".venv"
+
+[tool.ruff]
+line-length = 130
+extend-exclude = [
+    ".git",
+    ".pytest_cache",
+    ".venv",
+    "venv",
+    "**/migrations/*",
+    "__pycache__",
+]
+lint.extend-select = ["I", "E", "F", "W"]
+lint.ignore = ["C901", "E701", "E203"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402"]
+
+[tool.pytest.ini_options]
+filterwarnings = ["error"]
+
+[tool.setuptools.packages.find]
+include = ["pystac_monty*"]
+exclude = ["tests*"]
+
+[tool.setuptools.package-data]
+pystac_monty = ["HazardProfiles.csv"]
+
+[tool.setuptools.dynamic]
+version = { attr = "pystac_monty.extension.__version__" }
+
+[dependency-groups]
+dev = [
+    "codespell<2.3",
+    "coverage>=7.6.2",
+    "doc8>=1.1.2",
+    "fiona>=1.10.0",
+    "geopandas>=1.0.1",
+    "geopy>=2.4.0",
+    "html5lib>=1.1",
+    "jinja2>=3.1.4",
+    "jsonschema>=4.23.0",
+    "mypy>=1.11.2",
+    "openpyxl>=3.1.0",
+    "orjson>=3.10.7",
+    "packaging>=24.1",
+    "parameterized",
+    "pre-commit>=4.0.1",
+    "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
+    "pytest-mock>=3.14.0",
+    "pytest-recording>=0.13.2",
+    "requests>=2.32.3",
+    "ruff>=0.6.9",
+    "shapely>=2.0.0",
+    "types-html5lib>=1.1.11.20240806",
+    "types-jsonschema>=4.23.0.20240813",
+    "types-lxml>=2024.12.13",
+    "types-orjson>=3.6.2",
+    "types-python-dateutil>=2.9.0.20241003",
+    "types-urllib3>=1.26.25.14",
+    "virtualenv>=20.26.6",
+]
+
+[tool.uv.workspace]
+members = ["docs"]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"