Package layout
A src/ layout with a console entry point, pytest tests and a pyproject.toml ready for PyPI.
template-python
A starting point for a Python package with tests, CI, examples and an Astro documentation site.
What is included
Section titled “What is included”Continuous integration
GitHub Actions for tests, static analysis, notebook execution, documentation and PyPI publishing.
Examples
Jupyter notebooks in tutorials/ are executed and published as pages of this site, and
complete Python scripts in examples/ are shown with their plots.
API reference
Every module, class and function is documented from the docstrings with starlight-pydocs.
Start here
Section titled “Start here”InstallationCreate an environment and install the package.
QuickstartRun the command line entry point.
ExamplesExecuted notebooks and complete scripts with their outputs.
API referenceGenerated from the docstrings.