Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.59 KB

README.md

File metadata and controls

18 lines (15 loc) · 1.59 KB
Raw

stactools-template

This is a template repo used for creating new packages for stactools.

How to use

  1. 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 to stactools.landsat_8. Your name will be used on PyPI to publish the package in the stactools namespace, e.g. stactools-landsat.
  2. 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.
  3. Update setup.cfg with your package description and such.
  4. Update the LICENSE with your company's information (or whomever holds the copyright).
  5. Run sphinx-quickstart in the docs directory to create the documentation template.
  6. Update docs/installation_and_basic_usage.ipynb to provide an interactive notebook to help users get started. Include the following badge at the top of the README to launch the notebook: Binder. Be sure to modify the badge href to match your package repo.
  7. Add example Items (and Collections and Catalogs, if included) to a examples/ directory.
  8. Delete this file, and rename README-template.md to README.md. Update your new README to provide information about how to use your package.