keimlink / django-project-package-template Goto Github PK

Hi @keimlink

Thanks for the project :) I learned a lot, and I really like it!

I know that I can just go and create my own flavor, but maybe it would be much more fun to discuss the approaches, and if you like, I don't mind adding a PR.

I would consider the template for the following purpose:

To bootstrap a simple and easily readable Django project based on best practices, avoiding patterns that some larger quantity of users would want to refactor afterwards.

I would consider the following:

1. Remove envparse. My own reason is that it entangles development and production settings. I would much prefer to have settings.development and settings.production (possibly add settings.local to the .gitignore template). This way, settings become a lot easier to read and overwrite. The manage.py script has the --settings option, making it easy to switch between settings.

2. Move urls and wsgi up a level, for me they are not "configuration" any more than the whole project is then a configuration of sorts.

3. Rename conf to settings.

Here is a pattern that is quite similar to what I mean:

https://django-best-practices.readthedocs.io/en/latest/projects.html#handling-urlconfs-for-multiple-environments

I was once writing a project where we actually included the bootstrapping of settings.local in our manage.py, such that new users couldn't avoid having it created when it didn't exist and then seeing that it existed and contained their secrets.