SunPy Package Template

The SunPy package template is a tool for creating, but primarily maintaining a Python package with the same layout, tooling and developer experience as the sunpy core package and other packages maintained by the SunPy Project.

The template is built on top of the OpenAstronomy Python Packaging Guide. For an overview of the core concepts of maintaining a Python package start there. These documentation pages will document the features added by the SunPy Template and the things you will need to setup to use it.

• Templating a New Package, and Available Options
  • Creating a New Package
  • Cookiecutter Options Reference
• Template Features
  • Changelog Management with Towncrier
  • Changelog Checks with Gilesbot
  • Oldest Dependencies Testing
  • Development Dependencies Testing
  • Coverage Reporting with Codecov
  • ReadTheDocs
  • Label Synchronisation
• Linting and Code Style
  • Pre-commit
  • Ruff
  • isort
  • Codespell
  • Flake8
• Continuous Integration
  • Jobs
• Template Updates
  • Centralised updater (SunPy org packages)
  • Per-repo self-update
  • Dependabot interaction
• Configuring Automatic Releases

Topics Covered by the OpenAstronomy Guide

The following topics are documented in the OpenAstronomy Python Packaging Guide and are not duplicated here. Follow the cross-references to read about them.

• Minimal package layout – minimal package layout (pyproject.toml, setup.py, MANIFEST.in, LICENSE, README)

• Documenting your Package – documenting your package (docstrings, Sphinx, ReadTheDocs)

• Testing your package – testing your package with pytest

• Running Commands with Tox – running commands with tox

• Compiled C/Cython extensions – compiled C/Cython extensions

• Releasing Your Package – releasing your package (version numbers, sdist, PyPI)

• Command-line scripts – command-line scripts

• Including data in your package – including data in your package

• Specifying the Version of your Package – specifying the version of your package (setuptools_scm)