Cookiecutter template for python packages at Jupiter Volta.

This template is the standard way to create a python package at Jupiter Volta. It is a fork from cookiecutter-nist-python with adaptations for Jupiter Volta's needs. Some of the documentation is still taken from the original template, so you may see some references and links to NIST.

• Testing with pytest
• Isolated testing, documentation building, etc, with nox
• Linting with pre-commit
• Documentation with Sphinx, MyST, using either the furo or sphinx-book-theme theme.
• Works with both conda and virtualenv based envronments.
• Handle creation of requirments.txt and environment.yaml files with pyproject2conda

To generate a package using cookiecutter, run:

cookiecutter [--checkout BRANCH-NAME] https://github.com/jupitervolta/cookiecutter-python.git

where the optional argument in brackets can be used to specify a specific branch.

Alternatively (and highly recommended) is to use cruft. This allows for the template files to be updated as the template is updated. For this, you can run:

cruft create [--checkout BRANCH-NAME] https://github.com/jupitervolta/cookiecutter-python.git

See the documentation for a look at cookiecutter-python in action.

This is free software. See LICENSE.

The following packages use this template:

• cmomy
• thermoextrap
• tmmc-lnpy
• module-utilities
• analphipy
• pyproject2conda

• cookiecutter-pypackage: The template on which this work is based.
• cookiecutter-hypermodern-python

This template started as a fork of cookiecutter-pypackage.