cjolowicz/cookiecutter-hypermodern-python 2022.6.3

on GitHub

Overview of Changes

Here are the major changes brought by this release:

• Convert the entire documentation to Markdown, using MyST to support rich Markdown in Sphinx.
• Switch to isort as the Python import sorter, replacing reorder-python-imports. Enforce a single import per line to minimize merge conflicts.
• Remove upper version bounds from all dependencies.
• Restrict Dependabot updates to the lock file, greatly reducing the number of merge conflicts between Dependabot PRs.
• Enable Dependabot updates for indirect dependencies.
• Run Typeguard under the latest Python release only, to allow for the use of modern typing syntax.
• Combine coverage data under the latest Python release. This avoids problems due to changes in the AST between Python versions.
• Support patching Git hooks installed by recent versions of pre-commit, which use bash instead of Python for the hook script.
• Add a template variable for the copyright year.
• Do not run darglint on every commit to mitigate performance issues.

Read on for the full list of changes.

Changes

This section lists changes that affect generated projects.

🪲 Fixes

• Support patching pre-commit hooks written in bash (#718, #721, #1121) @cjolowicz @jooh

🚨 Testing

• Replace reorder-python-imports with isort (#741) @cjolowicz
• Combine coverage under the latest Python release (#710) @cjolowicz
• Run Typeguard under the latest Python release only (#764) @staticdev
• Move darglint to its own manual pre-commit hook (#822) @paw-lu
• Do not repeat Python versions in @session decorators (#711) @cjolowicz

👷 Continuous Integration

• Use FORCE_COLOR instead of nox --force-color (#778) @cjolowicz
• Enable Dependabot updates for indirect dependencies (#747) @cjolowicz
• Restrict Dependabot updates to lock file to reduce merge conflicts (#746) @cjolowicz

📚 Documentation

• Convert documentation to Markdown using MyST (#1089) @cauliyang
• Add copyright year as a template variable (#1101) @jasonwashburn
• Update Code of Conduct to Contributor Covenant 2.1 (#1139) @eyllanesc
• Add link for contact email in the Code of Conduct (#1135) @eyllanesc
• Link to project license instead of license templates (#1138, #1149) @eyllanesc
• Remove unused reference to Cookiecutter project (#1136) @paw-lu
• Use author template variable in copyright notice (#1110) @sgraaf
• Fix broken link to Contributor Guide on PyPI (#726) @staticdev
• Update permanently moved links in documentation (#738) @staticdev

📦 Packaging

• Remove upper version bounds from dependencies (#744, #709) @cjolowicz
• Add myst-parser to development dependencies (#815) @cjolowicz

⬆️ Dependencies

Changes to the template infrastructure

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

🪲 Fixes

• Fix bogus {{cookiecutter.copyright_year}} replacement in constraints.txt (#1146) @cjolowicz
• Fix bogus {{cookiecutter.license}} replacement in tests.yml (#1144) @nilsdebruin
• Fix bogus {{cookiecutter.version}} replacement in poetry.lock (#1153) @cjolowicz

📚 Documentation

• Convert documentation to Markdown using MyST (#1202, #1203, #1204, #1205, #1206, #1207, #1209)
• Why we remove upper bounds from version constraints (#1098) @cjolowicz
• Add instructions for installation on Windows (#1087) @cjolowicz
• Document that isort replaces reorder-python-imports (#1097) @cjolowicz
• Document that Typeguard runs on the latest Python only (#1106) @cjolowicz
• Document switch to MyST (#1133) @cjolowicz
• Remove the list of contributors (#1107) @cjolowicz
• Update Code of Conduct to Contributor Covenant 2.1 and add badge (#1160) @eyllanesc
• Update Python versions in User Guide (#1168) @jasonwashburn
• Ignore badgen.net when checking links (#1212) @cjolowicz

⬆️ Dependencies

• Bump Prettier from 2.5.1 to 2.6.0 (#1177) @eyllanesc
• Bump pre-commit-hooks from 3.2.0 to 4.1.0 (#1141) @eyllanesc