py-pkgs
py-pkgs copied to clipboard
Additions for the next round of revision or second edition
edited by Tomas Beuzen
This is a scratchpad for topics we'd like to add or cover more comprehensively in the book:
- Dependency updating with Dependabot. This would fit nicely in the cookiecutter and book.
- Advanced fixture usage:
- Mocking
- Setting up environments for test to run in, e.g., directory structures, environment variables, etc.
- Style checking and formatting:
- Using flake8 and/or black, and integrating into CI
- Packages with extensions in other languages (relevant comment)
- Releasing packages to Anaconda/conda-forge repositories
- Mention PyScaffold as an alternative templating tool
- Consider changing
poetrytopdm(see discussions in #95) - Consider providing more guidance on file/directory/repository/distribution/package naming conventions (see https://github.com/py-pkgs/py-pkgs-cookiecutter/issues/48 and this post)
- Consider adding more information/examples about namespace packages - currently we only briefly mention them at the bottom of [Section 4.2.1](https://py-pkgs.org/04-package-structure#package-contents (see #119)