cjolowicz / cookiecutter-hypermodern-python Goto Github PK
View Code? Open in Web Editor NEWHypermodern Python Cookiecutter
Home Page: http://cookiecutter-hypermodern-python.readthedocs.io/
License: MIT License
Hypermodern Python Cookiecutter
Home Page: http://cookiecutter-hypermodern-python.readthedocs.io/
License: MIT License
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:
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.
We should check that the documentation still builds with the changes in a given PR.
codecov.yaml
# comment spam as user can always click the failed coverage check
comment: false
Sphinx will sometimes skip files which have been generated before, even though the source files changed.
Reported by @webknjaz on Twitter:
FTR I've published a stable publishing GitHub Action yesterday: https://twitter.com/webKnjaZ/status/1236554217315336192.
Dependabot just started working with Poetry again.
Reported by @webknjaz on Twitter
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
The Cookiecutter documentation on RTD gets their theme instead of Alabaster with the configured logo.
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.
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.
This allows invoking the program as python -m <package_name>
.
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).
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
.
See #17
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
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.
https://alabaster.readthedocs.io/en/latest/customization.html
There are more interesting features here, related to external services:
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.
- <emoji> <title> (<label>)
Re-generate https://github.com/cjolowicz/cookiecutter-hypermodern-python-instance on push to master.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.