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

Supply a py.typed marker file in the package directory, as described in PEP 561.

See also https://mypy.readthedocs.io/en/stable/installed_packages.html

https://github.com/pre-commit/action

I find flake8-rst-docstring pretty useful—it checks if your docstrings are valid RST.

If there is interest I'd be happy to provide a PR.

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

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

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

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.

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

Reported by @webknjaz on Twitter:

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

https://alabaster.readthedocs.io/en/latest/customization.html

There are more interesting features here, related to external services:

• Codecov
• GitHub
• Tidelift
• Donate
• Analytics

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

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

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.

https://github.com/PyCQA/pep8-naming

Re-generate https://github.com/cjolowicz/cookiecutter-hypermodern-python-instance on push to master.

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.

See cjolowicz/retrocookie#64

Reported by @webknjaz on Twitter:

Also, it's better to use it for both PyPI and TestPyPI in order to be sure that the publishing flow is healthy at all times.

Dependabot just started working with Poetry again.

Reported by @webknjaz on Twitter

See official announcement

I like using Prettier as a pre-commit hook for formatting Markdown and YAML files in the repo—something like this

Happy to provide a PR if you're interested.

Thanks for the great template!

It appears that this plugin is redundant, when mypy is run with --disallow-untyped-defs.

https://mypy.readthedocs.io/en/stable/error_code_list2.html#check-that-every-function-has-an-annotation-no-untyped-def

See #17

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

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

codecov.yaml

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

• display error codes
• be strict

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

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
• ...

• Replace emoji codes by emoji characters
• Use simple bullet lists instead of checkboxes
• Replace table by bullet list, using the format - <emoji> <title> (<label>)

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).