blah blah
This is a template repo used for creating new packages for stactools
.
- Clone this template repository as your package name, e.g.
landsat
. This name should be short, memorable, and a valid Python package name (i.e. it shouldn't start with a number, etc). It can, however, include a hyphen, in which case the name for Python imports will be the underscored version, e.g.landsat-8
goes tostactools.landsat_8
. Your name will be used on PyPI to publish the package in the stactools namespace, e.g.stactools-landsat
. - Install the development requirements (
pip install -r requirements-dev.txt
) and pre-commit (pre-commit install
). - Change into the top-level directory of your package and run
scripts/rename
. This will update most of the files in the repository with your new package name. - Update
setup.cfg
with your package description and such. - Update the LICENSE with your company's information (or whomever holds the copyright).
- Edit or replace the existing functions to create stac Items and Collections for your dataset.
- Add example Items (and Collections and Catalogs, if included) to an
examples/
directory. - Delete this file, and rename
README-template.md
toREADME.md
. Update your new README to provide information about how to use your package.