The cookiecutter-hypermodern-python's discuss from cjolowicz

The order in the release notes can be improved. It appears to be based on the order in the configuration file, .github/release-drafter.yml. Something like this:

Breaking Changes
Features
Bugfixes
...

Configure Codecov for 100% coverage

Include the following coverage.yml in generated projects:

coverage:
    status:
        patch:
            default:
                target: '100'
        project:
            default:
                target: '100'

See https://docs.codecov.io/docs/codecov-yaml

The file above is from urllib3.

Add Dockerfile

See cjolowicz/hypermodern-python@chapter06-old...chapter07

Add workflow to build documentation

We should check that the documentation still builds with the changes in a given PR.

Disable Codecov comment

codecov.yaml

# comment spam as user can always click the failed coverage check
comment: false

Add documentation for Cookiecutter

everything from README
cookiecutter variables (name, default, description)

Upgrade to pre-commit-hooks 2.5.0

Eliminate console module, using only main

Remove Sphinx build directory before building the documentation

Sphinx will sometimes skip files which have been generated before, even though the source files changed.

Upgrade GitHub Action for PyPI upload to stable release

Reported by @webknjaz on Twitter:

FTR I've published a stable publishing GitHub Action yesterday: https://twitter.com/webKnjaZ/status/1236554217315336192.

Use Python 3.8 for Read the Docs

Use dependabot

Dependabot just started working with Poetry again.

Codecov token is no longer needed for GitHub Actions

Reported by @webknjaz on Twitter

See official announcement

Add Contributor Guide to Cookiecutter

Remove sphinx-autodoc-typehints?

Sphinx >= 3.0.0 supports autodoc_typehints = "description". This suggests that the sphinx-autodoc-typehints extension is no longer needed.

http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints

Override theme on Read the Docs

The Cookiecutter documentation on RTD gets their theme instead of Alabaster with the configured logo.

Build and install wheel in Nox sessions

The current method of installing the package into Nox sessions (poetry install --no-dev) uninstalls development dependencies. This leads to repeated installs even when Nox is invoked with nox -r. Also, it would be better to test against the actual distribution package rather than against an editable install.

Add pre-commit badge

https://pre-commit.com/#badging-your-repository

[Enhancement] Add sphinx-autobuild option to nox's docs session

It would be useful to have the option to run sphinx-autobuild—where sphinx can serve your docs, open your browser, and actively watch for changes—in nox's docs session.

It could be triggered by an optional argument such as nox -s docs -- serve.

As always, happy to provide a PR if you are open to it.

Add Read the Docs badge to Cookiecutter

Update README.md
Update docs/index.rst (?)

Use `main` instead of console

This allows invoking the program as python -m <package_name>.

Add Windows builds

Run black from pre-commit

Not sure about this one. It appears to be what most people do, and people expect pre-commit to fix issues automatically if possible. On the other hand, we already run flake8-black from pre-commit, so this is kind of redundant (and you can simply nox -rs black if it fails).

Support Python 3.6

Configure issue and PR templates

From #1119:

https://github.com/tiangolo/typer/tree/master/.github/ISSUE_TEMPLATE

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms