cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-03-01 09:50:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

Settings mapping effort take 1 for help with #35

Browse Source
This commit is contained in:
Daniel Greenfeld 2013-10-25 07:59:48 -07:00
parent b094ee1010
commit 6b14e33073
3 changed files with 35 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -11,6 +11,7 @@ Features
* Cutting edge: For Django 1.6 and other bleeding edge stuff
* Twitter Bootstrap 3
* AngularJS
* Settings management via django-configurations
* Registration via django-allauth
* User avatars via django-avatar
* Procfile for deploying to Heroku
@ -22,13 +23,12 @@ Constraints
* Only maintained 3rd party libraries are used.
* PostgreSQL everywhere
* Environment variables for configuration (This won't work with Apache/mod_wsgi)
* Environment variables for configuration (This won't work with Apache/mod_wsgi).
Caution: Bleeding Edge Requirements
------------------------------------
The cookiecutter-django project is bleeding edge in that it uses unreleased versions of several packages like Django,
South, django-crispy-forms, django-avatar, and more.
The cookiecutter-django project is bleeding edge in that it uses the Django 1.6c1 release candidate.
Consider yourself warned.
@ -81,7 +81,7 @@ Create a GitHub repo and push it there::
$ git remote add origin git@github.com:pydanny/redditclone.git
$ git push -u origin master
Now take a look at your repo. Awesome, right?
Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?
It's time to write the code!!!

30
{{cookiecutter.repo_name}}/README.rst
View File

@ -6,6 +6,36 @@
LICENSE: BSD
Settings
------------
cookiecutter-django relies extensively on environment settings which **will not work with Apache/mod_wsgi setups**. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.
For configuration purposes, the following table maps the cookiecutter-django environment variables to their Django setting:
======================================= =========================== =========================================== ===========================================
Environment Variable Django Setting Development Default Production Default
======================================= =========================== =========================================== ===========================================
DJANGO_AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID n/a raises error
DJANGO_AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY n/a raises error
DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a raises error
DJANGO_CACHES CACHES locmem memcached
DJANGO_DATABASES DATABASES See code See code
DJANGO_DEBUG DEBUG True False
DJANGO_EMAIL_BACKEND EMAIL_BACKEND django.core.mail.backends.smtp.EmailBackend django.core.mail.backends.smtp.EmailBackend
DJANGO_SECRET_KEY SECRET_KEY CHANGEME!!! raises error
DJANGO_SECURE_BROWSER_XSS_FILTER SECURE_BROWSER_XSS_FILTER n/a True
DJANGO_SECURE_SSL_REDIRECT SECURE_SSL_REDIRECT n/a True
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF SECURE_CONTENT_TYPE_NOSNIFF n/a True
DJANGO_SECURE_FRAME_DENY SECURE_FRAME_DENY n/a True
DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS HSTS_INCLUDE_SUBDOMAINS n/a True
DJANGO_SESSION_COOKIE_HTTPONLY SESSION_COOKIE_HTTPONLY n/a True
DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a True
======================================= =========================== =========================================== ===========================================
* TODO: Add vendor-added settings in another table
Deployment
------------

2
{{cookiecutter.repo_name}}/requirements/base.txt
View File

@ -1,5 +1,5 @@
# Bleeding edge Django
https://github.com/django/django/archive/1.6b4.tar.gz
https://github.com/django/django/archive/1.6c1.tar.gz
# Configuration
django-configurations==0.5.1