cjolowicz/cookiecutter-hypermodern-python 2021.11.26

on GitHub

Overview of Changes

Here are the major changes brought by this release:

• Add a pre-commit hook for pyupgrade, a tool for upgrading your source code to newer versions of the Python language and standard library.

• Use the furo Sphinx theme for documentation. Furo is a clean customizable theme for technical documentation, with a focus on being responsive and easy to navigate and search.

• Include the test suite itself when measuring code coverage: tests are code. Read more about the reasons behind this on Ned Batchelder's blog.

• Enable color output on GitHub Actions for pytest, pre-commit, Sphinx, and xdoctest. Tools on GitHub Actions default to monochrome output, and every tool has its own convention for overriding this (if any). This was a fun ride.

Read on for the full list of changes.

Changes

This section lists changes that affect generated projects.

🚨 Testing

• Include test suite in code coverage (#545) @cjolowicz

👷 Continuous Integration

• Add pre-commit hook for pyupgrade (#674) @cjolowicz
• Enable colors from pre-commit, pytest, Sphinx, and xdoctest (#700) @cjolowicz
• Use Python 3.10 on Read the Docs (#698) @cjolowicz
• Pin pip in virtual environments (#707) @cjolowicz
• Update test GA workflow for more consistent style (#697) @staticdev
• Shorten python-version to python in Tests workflow matrix (#699) @cjolowicz

📚 Documentation

• Use furo Sphinx theme for documentation (#676) @cjolowicz

📦 Dependencies

• Avoid semver constraints for dependencies using CalVer (#675) @cjolowicz

Changes to the template infrastructure

This section lists changes to the infrastructure of the Cookiecutter template. These changes don't affect generated projects.

👷 Continuous Integration

• Ignore our RTD page when checking links in documentation (#1081) @cjolowicz

📚 Documentation

• Use furo Sphinx theme for Cookiecutter documentation (#612) @cjolowicz
• Document pre-commit hook for pyupgrade (#1065) @cjolowicz
• Add furo Sphinx theme to the Cookiecutter documentation (#1066) @cjolowicz
• Add furo Sphinx theme to the Cookiecutter documentation (#1067) @cjolowicz
• Document code coverage for the test suite (#1075) @cjolowicz
• Add section explaining how to upgrade Nox and Poetry (#1076) @cjolowicz

📦 Dependencies