This template works boilerplate project-templating engine.
django-boilerplate is an attempt to set up a standard convention for Django app layouts, to assist in writing utilities to deploy such applications. A bit of convention can go a long way.
directory structure:
django-boilerplate ├── apps │ ├── core │ │ ├── __init__.py │ │ ├── models.py │ │ ├── README.rst │ │ ├── static │ │ │ └── core │ │ │ ├── css │ │ │ │ ├── core.css │ │ │ │ └── README.rst │ │ │ ├── img │ │ │ │ └── README.rst │ │ │ ├── js │ │ │ │ ├── core.js │ │ │ │ └── README.rst │ │ │ ├── lib │ │ │ │ └── README.rst │ │ │ └── README.rst │ │ ├── templates │ │ │ ├── 404.html │ │ │ ├── 500.html │ │ │ ├── base.html │ │ │ └── README.rst │ │ └── views.py │ ├── __init__.py │ └── README.rst ├── environment.py ├── __init__.py ├── lib │ ├── __init__.py │ └── README.rst ├── log │ └── README.rst ├── manage.py ├── media │ └── README.rst ├── README.rst ├── requirements │ ├── common.txt │ ├── dev.txt │ ├── production.txt │ └── README.rst ├── settings │ ├── default.py │ ├── dev.py │ ├── __init__.py │ ├── README.rst │ └── urls.py ├── static │ └── README.rst └── TIMELINE.rst
All of your Django "apps" go in this directory. These have models, views, forms,
templates or all of the above. These should be Python packages you would add to
your project's INSTALLED_APPS list.
Everything in this directory is added to the PYTHONPATH when
the setup function from environment.py is invoked.
There's one predefined app: core. Every base classes should be placed here.
It's also a place to keep your project-level static files. Here's how you might
to organize it:
apps/core/static/core/ <== application's css, js, img apps/core/static/core/lib/ <== css, js libraries
Why is that?
When collectstatic commands creates the content of static folder it just
copy contents of static folders from each app. We decide that the best way
to keep clean, resonable and simple structure, will be keeping all static
dependentcies to core app.
Third party Python packages and/or django-apps. Everything in this directory
is added to the PYTHONPATH when the setup function from environment.py
is invoked.
Default place to store logs from your loggers. We recommend ./logs/$app/ for keeping logs of $app django application.
This folder is fully auto-generated. You don't even need to create it.
It will be created by manage.py collectstatic command line tool.
pip requirements files, optionally one for each app environment. The
common.txt is installed in every case.
Very similar to requirements - settings for each environment. There's also
main urls.py file.
- environment.py
Introduces setup function that modifies the PYTHONPATH to allow importing
from the apps and lib directories.
- manage.py
The standard Django manage.py.
- Kuba Janoszek ([email protected])
- Leszek Piątek jr ([email protected])