While the sample code is handy to demonstrate the blueprint, in practice it's an annoyance since the first thing to do when creating a real project based on the blueprint is removing all traces of the sample code and tests. That's why propose one or both of the following:
- Add a setup switch to skip the sample code, in which case only
__init__.py, py.typed etc. are created in src/{{module_name}}/, but not cli.py etc. (There was a similar switch once, but we removed it to reduce complexity, but the that switch was also more complex than what I propose.)
- Name the sample package
example or so instead of {{module_name}} (but still create the latter with only the necessary files). This would at least make it easier to remove the sample code, and if combined with the switch facilitate implementing the latter since there would only be two places for a conditional (src/example and tests/test_example).
What do you think? I'll implement this anyway in my fork in one form or another, so I'll be happy to prepare a PR, but I thought I'd ask first in case you have strong any strong opinions.
While the sample code is handy to demonstrate the blueprint, in practice it's an annoyance since the first thing to do when creating a real project based on the blueprint is removing all traces of the sample code and tests. That's why propose one or both of the following:
__init__.py,py.typedetc. are created insrc/{{module_name}}/, but notcli.pyetc. (There was a similar switch once, but we removed it to reduce complexity, but the that switch was also more complex than what I propose.)exampleor so instead of{{module_name}}(but still create the latter with only the necessary files). This would at least make it easier to remove the sample code, and if combined with the switch facilitate implementing the latter since there would only be two places for a conditional (src/exampleandtests/test_example).What do you think? I'll implement this anyway in my fork in one form or another, so I'll be happy to prepare a PR, but I thought I'd ask first in case you have strong any strong opinions.