pystac-generator 0.1.13

A python package and CLI tool for generating STAC catalog from spatial data files

stac-generator

Install Package

pip install pystac_generator

Run as CLI

stac_generator --help

Run as python package

from stac_generator.generator_factor import StacGeneratorFactory

Run the current example as a Python module

Note that you will need to either clone the repository or download the example directory in the repository

To run the example as python module: see the notebook

Run the current example as a CLI

When the source file is on local host:

See the config file. Note how the location points to a file on local host.

stac_generator csv example/csv/source_config.csv --to_local example/csv/generated --id point_data

When the source file is hosted and accessible via http(s) (AWS S3, Nectr Object Storage):

See the config file. Note how the location points to a remote file.

stac_generator csv example/csv/remote_config.csv --to_local example/csv/generated --id point_data

When the config file is hosted and accessible via http(s) (AWS S3, Nectr Object Storage):

So far, the config files are stored locally. It is possible to have the config file hosted somewhere.

stac_generator csv https://object-store.rc.nectar.org.au/v1/AUTH_9f063fd4ed28439487e49cddfb56d02d/Test_Data_Container/csv/remote_config.csv --to_local example/csv/generated --id point_data

Publish the example to a STAC endpoint

This feature is still experimental. This only works if the collection does not exist on the STAC api endpoint. Future versions will have a more fine-grained control over create Collection vs update Collection.

To publish to remote, simply have a flag --to_remote <CATALOG API Endpoint>. For example, if you have setup a STAC API server with stac-fastapi-pgstac, the example collection can be generated by running:

stac_generator csv example/csv/source_config.csv --id point_data --to_remote http://localhost:8082

Install pdm and all packages

make install

Adding a new dependency

pdm add <package>

Adding a new dependency under a dependency group:

pdm add -dG <group> <package>

Remove a dependency

pdm remove <package>

Serve docs locally

make docs

Fixing CI

Run the linter. This runs all methods in pre-commit - i.e. checking for exports, format the code, etc, followed by mypy. This has a one to one correspondence with validate-ci

make lint

Run tests. This runs all tests using pytest. This has a one to one correspondence with test-ci

make test