From b275c7ca72687d4fb4a2a2d72b1d1b1ffa23446b Mon Sep 17 00:00:00 2001 From: kaidokert Date: Mon, 20 Jul 2015 02:10:31 +0100 Subject: [PATCH 001/402] Add .pep8 and .pylintrc --- {{cookiecutter.repo_name}}/.pep8 | 3 +++ {{cookiecutter.repo_name}}/.pylintrc | 11 +++++++++++ 2 files changed, 14 insertions(+) create mode 100644 {{cookiecutter.repo_name}}/.pep8 create mode 100644 {{cookiecutter.repo_name}}/.pylintrc diff --git a/{{cookiecutter.repo_name}}/.pep8 b/{{cookiecutter.repo_name}}/.pep8 new file mode 100644 index 000000000..5c558cdd6 --- /dev/null +++ b/{{cookiecutter.repo_name}}/.pep8 @@ -0,0 +1,3 @@ +[pep8] +max-line-length = 120 +exclude=*/migrations/* diff --git a/{{cookiecutter.repo_name}}/.pylintrc b/{{cookiecutter.repo_name}}/.pylintrc new file mode 100644 index 000000000..ce2204c9d --- /dev/null +++ b/{{cookiecutter.repo_name}}/.pylintrc @@ -0,0 +1,11 @@ +[MASTER] +load-plugins=pylint_common, pylint_django{% if cookiecutter.use_celery == "y" %}, pylint_celery {% endif %} + +[FORMAT] +max-line-length=120 + +[MESSAGES CONTROL] +disable=missing-docstring,invalid-name + +[DESIGN] +max-parents=13 \ No newline at end of file From 362f86a4c11aa8c67107a0a6c5f3bcaf976bcecc Mon Sep 17 00:00:00 2001 From: kaido Date: Sun, 19 Jul 2015 21:55:29 -0700 Subject: [PATCH 002/402] Switch celery default serialization to JSON, to avoid pickle related deprecation warnings --- {{cookiecutter.repo_name}}/config/settings/common.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index 22d3d0849..cc6faece5 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -256,11 +256,14 @@ LOGGING = { } } {% if cookiecutter.use_celery == "y" %} -########## CELERY +# ######### CELERY INSTALLED_APPS += ('{{cookiecutter.repo_name}}.taskapp.celery.CeleryConfig',) # if you are not using the django database broker (e.g. rabbitmq, redis, memcached), you can remove the next line. INSTALLED_APPS += ('kombu.transport.django',) BROKER_URL = env("CELERY_BROKER_URL", default='django://') -########## END CELERY +CELERY_ACCEPT_CONTENT = ['json'] +CELERY_TASK_SERIALIZER = 'json' +CELERY_RESULT_SERIALIZER = 'json' +# ######### END CELERY {% endif %} # Your common stuff: Below this line define 3rd party library settings From 76a207d8dae65ed67ac59889d968b7841e11f260 Mon Sep 17 00:00:00 2001 From: Kaido Kert Date: Thu, 6 Aug 2015 11:21:08 -0700 Subject: [PATCH 003/402] Oops - revert celery defaults change, separate PR --- {{cookiecutter.repo_name}}/config/settings/common.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index cc6faece5..22d3d0849 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -256,14 +256,11 @@ LOGGING = { } } {% if cookiecutter.use_celery == "y" %} -# ######### CELERY +########## CELERY INSTALLED_APPS += ('{{cookiecutter.repo_name}}.taskapp.celery.CeleryConfig',) # if you are not using the django database broker (e.g. rabbitmq, redis, memcached), you can remove the next line. INSTALLED_APPS += ('kombu.transport.django',) BROKER_URL = env("CELERY_BROKER_URL", default='django://') -CELERY_ACCEPT_CONTENT = ['json'] -CELERY_TASK_SERIALIZER = 'json' -CELERY_RESULT_SERIALIZER = 'json' -# ######### END CELERY +########## END CELERY {% endif %} # Your common stuff: Below this line define 3rd party library settings From 2bf111d03a89894ee59d9c0e02db7373df7c5908 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Thu, 27 Aug 2015 20:18:10 -0700 Subject: [PATCH 004/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e3696890..f92c458de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-08-27] +### Changed +- Grunt Updates: use libsass, add postcss (@288) + ## [2015-08-20] ### Changed - requirements files to match current dependency versions (@pydanny) From cb4e1d0d9ddd7bb439a2631e11bea9e5a2105f1d Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 28 Aug 2015 22:01:26 -0700 Subject: [PATCH 005/402] Switch to django-mailgun-redux --- CHANGELOG.md | 6 ++++++ {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f92c458de..8716369a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). + +## [2015-08-28] +### Changed +- Switched to django-mailgun-redux so mail doesn't blow up on Python 3 (@pydanny) + + ## [2015-08-27] ### Changed - Grunt Updates: use libsass, add postcss (@288) diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index 73d66d190..9910b5e96 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -17,7 +17,7 @@ Collectfast==0.2.3 # Mailgun Support # --------------- -django-mailgun==0.2.2 +django-mailgun-redux==0.3.0 {% if cookiecutter.use_sentry == "y" -%} # Raven is the Sentry client From 8330706775bb6c996db6252e5874bd39421d1e96 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 29 Aug 2015 12:09:45 -0700 Subject: [PATCH 006/402] Update navbar and toggle to Bootstrap 4 HTML. --- .../templates/base.html | 34 ++++++++----------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index f4732389e..0d25e405a 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -34,38 +34,32 @@ -
+
From 968c04369e21cd2e6024bfea6a8ef777ed7b9a0f Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 29 Aug 2015 12:11:10 -0700 Subject: [PATCH 007/402] Update stylesheet to Bootstrap 4. Remove optional theme stylesheet. --- .../{{cookiecutter.repo_name}}/templates/base.html | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 0d25e405a..07d573137 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -15,10 +15,7 @@ {% block css %} - - - - + From 69617648d5e6b61604b9b093eb887c0322ba393e Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 29 Aug 2015 21:44:51 -0700 Subject: [PATCH 008/402] Remove navbar's corners, and invert colors. --- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 07d573137..5b68b4f69 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -31,7 +31,7 @@ -
From 1153edf2f7e047bd19bc27de31db9ef8fb02cbc3 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sun, 30 Aug 2015 15:46:30 -0700 Subject: [PATCH 014/402] Update CHANGELOG.md --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8716369a8..197e87374 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-08-30] +### Changed +- Moved from Bootstrap 3 to Bootstrap 4 (@audreyr) +- Slight Reorganization of the README docs (@pydanny) +- Dokku docs are out of the README and in the docs folder (@pydanny) ## [2015-08-28] ### Changed From d6fb935e7fac1b060e42fa5a0ee93abd1813b12c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Sun, 30 Aug 2015 22:12:18 -0300 Subject: [PATCH 015/402] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 865a2c380..b78392ee5 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ Features * For Django 1.8 * Renders Django projects with 100% test coverage -* Twitter Bootstrap_ 3 +* Twitter Bootstrap_ v4.0.0-alpha * End-to-end via Hitch_ * AngularJS_ * 12-Factor_ based settings via django-environ_ From acc8e0bc4c0d640684ed1a1b84021fc56ca48431 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Sun, 30 Aug 2015 22:14:25 -0300 Subject: [PATCH 016/402] Update README.rst --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b78392ee5..112fc60b7 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ Features * For Django 1.8 * Renders Django projects with 100% test coverage -* Twitter Bootstrap_ v4.0.0-alpha +* Twitter Bootstrap_ v4.0.0-alpha_ * End-to-end via Hitch_ * AngularJS_ * 12-Factor_ based settings via django-environ_ @@ -39,6 +39,7 @@ Features * Procfile_ for deploying to Heroku * Works with Dokku +.. _v4.0.0-alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest .. _Bootstrap: https://github.com/twbs/bootstrap .. _AngularJS: https://github.com/angular/angular.js From 795fccc15f862b63ca1d69b61ae739fb3db0dc9c Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Sun, 30 Aug 2015 22:52:38 -0300 Subject: [PATCH 017/402] Update version of django-crispy-forms to 1.5.1, django-extensions to 1.5.6, django-test-plus to 1.0.9, gevent to 1.1b3, coverage to 4.0b2, hitchpython to 0.3.3 and hitchtest to 0.7.6 --- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- {{cookiecutter.repo_name}}/requirements/local.txt | 6 +++--- {{cookiecutter.repo_name}}/requirements/test.txt | 4 ++-- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 6f39bbb7c..3348d10c6 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -11,7 +11,7 @@ whitenoise==2.0.3 # Forms django-braces==1.8.1 -django-crispy-forms==1.5.0 +django-crispy-forms==1.5.1 django-floppyforms==1.5.2 # Models diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 431b16665..f9a5524f8 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -2,9 +2,9 @@ -r base.txt coverage==3.7.1 Sphinx -django-extensions==1.5.5 +django-extensions==1.5.6 Werkzeug==0.10.4 -django-test-plus==1.0.8 +django-test-plus==1.0.9 factory_boy==2.5.2 # django-debug-toolbar that works with Django 1.5+ @@ -15,7 +15,7 @@ ipdb==0.8.1 {% if cookiecutter.use_maildump == "y" -%} # Required by maildump. Need to pin dependency to gevent beta to be Python 3-compatible. -gevent==1.1b2 +gevent==1.1b3 # Enables better email testing maildump==0.5.1 {%- endif %} diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index dae48a1ce..77d7d93fe 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -1,6 +1,6 @@ # Test dependencies go here. -r base.txt -coverage==4.0b1 +coverage==4.0b2 flake8==2.4.1 -django-test-plus==1.0.8 +django-test-plus==1.0.9 factory_boy==2.5.2 diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index a353684ba..ee330e662 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -3,12 +3,12 @@ colorama==0.3.3 faketime==0.9.6.3 hitchcron==0.2 hitchpostgres==0.6.2 -hitchpython==0.3.2 +hitchpython==0.3.3 hitchredis==0.4.1 hitchselenium==0.4 hitchserve==0.4.3 hitchsmtp==0.2.1 -hitchtest==0.7.5 +hitchtest==0.7.6 humanize==0.5.1 ipython==4.0.0 Jinja2==2.8 From 7ca8863a8c20c27981853863b0ff28a7b0442733 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Sun, 30 Aug 2015 22:56:19 -0300 Subject: [PATCH 018/402] Small improvements in install_python_dependencies.sh and install_os_dependencies.sh scripts --- {{cookiecutter.repo_name}}/install_os_dependencies.sh | 2 +- {{cookiecutter.repo_name}}/install_python_dependencies.sh | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.repo_name}}/install_os_dependencies.sh b/{{cookiecutter.repo_name}}/install_os_dependencies.sh index 477dcafd0..aea9dec45 100755 --- a/{{cookiecutter.repo_name}}/install_os_dependencies.sh +++ b/{{cookiecutter.repo_name}}/install_os_dependencies.sh @@ -24,7 +24,7 @@ function usage_message() # Read the requirements.apt file, and remove comments and blank lines function list_packages(){ - cat ${OS_REQUIREMENTS_FILENAME} | grep -v "#" | grep -v "^$"; + grep -v "#" ${OS_REQUIREMENTS_FILENAME} | grep -v "^$"; } function install() diff --git a/{{cookiecutter.repo_name}}/install_python_dependencies.sh b/{{cookiecutter.repo_name}}/install_python_dependencies.sh index 0de90c829..34929e607 100755 --- a/{{cookiecutter.repo_name}}/install_python_dependencies.sh +++ b/{{cookiecutter.repo_name}}/install_python_dependencies.sh @@ -3,7 +3,7 @@ pip --version >/dev/null 2>&1 || { echo >&2 -e "\npip is required but it's not installed." echo >&2 -e "You can install it by running the following command:\n" - echo >&2 "wget https://bootstrap.pypa.io/get-pip.py; chmod +x get-pip.py; sudo ./get-pip.py" + echo >&2 "wget https://bootstrap.pypa.io/get-pip.py --output-document=get-pip.py; chmod +x get-pip.py; sudo -H python3 get-pip.py" echo >&2 -e "\n" echo >&2 -e "\nFor more information, see pip documentation: https://pip.pypa.io/en/latest/" exit 1; @@ -12,7 +12,7 @@ pip --version >/dev/null 2>&1 || { virtualenv --version >/dev/null 2>&1 || { echo >&2 -e "\nvirtualenv is required but it's not installed." echo >&2 -e "You can install it by running the following command:\n" - echo >&2 "sudo pip install virtualenv" + echo >&2 "sudo -H pip3 install virtualenv" echo >&2 -e "\n" echo >&2 -e "\nFor more information, see virtualenv documentation: https://virtualenv.pypa.io/en/latest/" exit 1; @@ -21,7 +21,7 @@ virtualenv --version >/dev/null 2>&1 || { if [ -z "$VIRTUAL_ENV" ]; then echo >&2 -e "\nYou need activate a virtualenv first" echo >&2 -e 'If you do not have a virtualenv created, run the following command to create and automatically activate a new virtualenv named "venv" on current folder:\n' - echo >&2 -e "virtualenv venv" + echo >&2 -e "virtualenv venv --python=\`which python3\`" echo >&2 -e "\nTo leave/disable the currently active virtualenv, run the following command:\n" echo >&2 "deactivate" echo >&2 -e "\nTo activate the virtualenv again, run the following command:\n" From ebc728613e4e338084a3447d6aed388b27e2443c Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Sun, 30 Aug 2015 23:29:57 -0300 Subject: [PATCH 019/402] update AngularJS version to 1.4.4 --- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 3a15a4c39..00123ab02 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -24,7 +24,7 @@ {% endblock %} {% block angular %} - + {% endblock %} From 5ab0f3d07effb18f7b81c268d32f3e716574e83c Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Mon, 31 Aug 2015 00:06:11 -0300 Subject: [PATCH 020/402] update usage example --- README.rst | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 112fc60b7..543ef3564 100644 --- a/README.rst +++ b/README.rst @@ -91,17 +91,21 @@ It prompts you for questions. Answer them:: remote: Total 550 (delta 283), reused 479 (delta 222) Receiving objects: 100% (550/550), 127.66 KiB | 58 KiB/s, done. Resolving deltas: 100% (283/283), done. - project_name (default is "project_name")? Reddit Clone - repo_name (default is "Reddit_Clone")? reddit - author_name (default is "Your Name")? Daniel Greenfeld - email (default is "Your email")? pydanny@gmail.com - description (default is "A short description of the project.")? A reddit clone. - domain_name (default is "example.com")? myreddit.com - version (default is "0.1.0")? 0.0.1 - timezone (default is "UTC")? - now (default is "2015/01/13")? 2015/01/16 - year (default is "2015")? - use_whitenoise (default is "y")? + project_name [project_name]: Reddit Clone + repo_name [Reddit_Clone]: reddit + author_name [Your Name]: Daniel Greenfeld + email [Your email]: pydanny@gmail.com + description [A short description of the project.]: A reddit clone. + domain_name [example.com]: myreddit.com + version [0.1.0]: 0.0.1 + timezone [UTC]: + now [2015/01/13]: 2015/08/30 + year [2015]: + use_whitenoise [y]: n + use_celery [n]: y + use_maildump [n]: y + use_sentry [n]: y + windows [n]: Enter the project and take a look around:: From ec12e84407ebbf762a8020f83e9d3a2e612f357b Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Mon, 31 Aug 2015 00:06:32 -0300 Subject: [PATCH 021/402] update CHANGELOG --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 197e87374..9a7634bc9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Moved from Bootstrap 3 to Bootstrap 4 (@audreyr) - Slight Reorganization of the README docs (@pydanny) - Dokku docs are out of the README and in the docs folder (@pydanny) +- Small improvements in ``install_python_dependencies.sh`` and ``install_os_dependencies.sh`` scripts (@luzfcb) +- Update version of django-crispy-forms, django-extensions, django-test-plus, gevent, coverage, hitchpython and hitchtest (@luzfcb) +- Update AngularJS version to 1.4.4 (@luzfcb) +- Update the usage example on README (@luzfcb) ## [2015-08-28] ### Changed From fe4bf2b7ed494763e22d12b5417cc4cdc225176d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Mon, 31 Aug 2015 00:14:44 -0300 Subject: [PATCH 022/402] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 543ef3564..a37ead412 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ Features * For Django 1.8 * Renders Django projects with 100% test coverage -* Twitter Bootstrap_ v4.0.0-alpha_ +* Twitter Bootstrap_ v4.0.0 - alpha_ * End-to-end via Hitch_ * AngularJS_ * 12-Factor_ based settings via django-environ_ @@ -39,7 +39,7 @@ Features * Procfile_ for deploying to Heroku * Works with Dokku -.. _v4.0.0-alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ +.. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest .. _Bootstrap: https://github.com/twbs/bootstrap .. _AngularJS: https://github.com/angular/angular.js From bbc1d337f24e42b4f9b9303dcf3701eaa0eb121f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Mon, 31 Aug 2015 00:16:39 -0300 Subject: [PATCH 023/402] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a37ead412..f710a2e52 100644 --- a/README.rst +++ b/README.rst @@ -110,7 +110,7 @@ It prompts you for questions. Answer them:: Enter the project and take a look around:: - $ cd redditclone/ + $ cd reddit/ $ ls Create a GitHub repo and push it there:: From 99a30d08dcf40040b01ff9da0b0e365552a30849 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Mon, 31 Aug 2015 21:25:23 -0700 Subject: [PATCH 024/402] Fix #313, which is removing dokku --- CHANGELOG.md | 4 +++ README.rst | 5 ++- {{cookiecutter.repo_name}}/README.rst | 11 +----- {{cookiecutter.repo_name}}/docs/dokku.rst | 41 ----------------------- 4 files changed, 7 insertions(+), 54 deletions(-) delete mode 100644 {{cookiecutter.repo_name}}/docs/dokku.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a7634bc9..462ea0cbd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-08-31] +### +- Dokku in favor of docker-compose and other modern Django tools (@pydanny) (@pydanny) + ## [2015-08-30] ### Changed - Moved from Bootstrap 3 to Bootstrap 4 (@audreyr) diff --git a/README.rst b/README.rst index f710a2e52..f6cb01c3b 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,6 @@ Features * Integration with Sentry_ for error logging (optional) * Docker support using docker-compose_ for dev and prod * Procfile_ for deploying to Heroku -* Works with Dokku .. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest @@ -98,9 +97,9 @@ It prompts you for questions. Answer them:: description [A short description of the project.]: A reddit clone. domain_name [example.com]: myreddit.com version [0.1.0]: 0.0.1 - timezone [UTC]: + timezone [UTC]: now [2015/01/13]: 2015/08/30 - year [2015]: + year [2015]: use_whitenoise [y]: n use_celery [n]: y use_maildump [n]: y diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index e1df993de..b6cf2ec64 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -200,7 +200,7 @@ The testing framework runs Django, Celery (if enabled), Postgres, HitchSMTP (a m Deployment ---------- -We providing tools and instructions for deploying using Docker and Heroku. Dokku is also an option, but doesn't have the same amount of support. +We providing tools and instructions for deploying using Docker and Heroku. Heroku ^^^^^^ @@ -344,12 +344,3 @@ To get the status, run:: If you have errors, you can always check your stack with `docker-compose`. Switch to your projects root directory and run:: docker-compose ps - - - -Dokku -^^^^^^ - -`Instructions for deploying with Dokku`_ can be found in the docs. - -.. _`Instructions for deploying with Dokku`: https://github.com/pydanny/cookiecutter-django/blob/master/%7B%7Bcookiecutter.repo_name%7D%7D/docs/deploy.rst diff --git a/{{cookiecutter.repo_name}}/docs/dokku.rst b/{{cookiecutter.repo_name}}/docs/dokku.rst deleted file mode 100644 index a33a95cee..000000000 --- a/{{cookiecutter.repo_name}}/docs/dokku.rst +++ /dev/null @@ -1,41 +0,0 @@ -Dokku -===== - -You need to make sure you have a server running Dokku with at least 1GB of RAM. Backing services are -added just like in Heroku however you must ensure you have the relevant Dokku plugins installed. - -.. code-block:: bash - - cd /var/lib/dokku/plugins - git clone https://github.com/rlaneve/dokku-link.git link - git clone https://github.com/luxifer/dokku-redis-plugin redis - git clone https://github.com/jezdez/dokku-postgres-plugin postgres - dokku plugins-install - -You can specify the buildpack you wish to use by creating a file name .env containing the following. - -.. code-block:: bash - - export BUILDPACK_URL= - -You can then deploy by running the following commands. - -.. code-block:: bash - - git remote add dokku dokku@yourservername.com:{{cookiecutter.repo_name}} - git push dokku master - ssh -t dokku@yourservername.com dokku redis:create {{cookiecutter.repo_name}}-redis - ssh -t dokku@yourservername.com dokku redis:link {{cookiecutter.repo_name}}-redis {{cookiecutter.repo_name}} - ssh -t dokku@yourservername.com dokku postgres:create {{cookiecutter.repo_name}}-postgres - ssh -t dokku@yourservername.com dokku postgres:link {{cookiecutter.repo_name}}-postgres {{cookiecutter.repo_name}} - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_SECRET_KEY=RANDOM_SECRET_KEY_HERE - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_SETTINGS_MODULE='config.settings.production' - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_MAILGUN_API_KEY=YOUR_MAILGUN_API_KEY - ssh -t dokku@yourservername.com dokku config:set {{cookiecutter.repo_name}} DJANGO_MAILGUN_SERVER_NAME=YOUR_MAILGUN_SERVER - ssh -t dokku@yourservername.com dokku run {{cookiecutter.repo_name}} python manage.py migrate - ssh -t dokku@yourservername.com dokku run {{cookiecutter.repo_name}} python manage.py createsuperuser - -When deploying via Dokku make sure you backup your database in some fashion as it is NOT done automatically. From 6b58d65bb673b677444db87e824617e9d3096b56 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Mon, 31 Aug 2015 21:53:04 -0700 Subject: [PATCH 025/402] Remove comments referring to specific lines, which are brittle. Replace with descriptive comment. --- .../{{cookiecutter.repo_name}}/static/css/project.css | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css index 40432d7e7..983fd0e07 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css @@ -1,39 +1,35 @@ -/* line 5, ../sass/project.scss */ +/* These styles are generated from project.scss. */ + .alert-debug { color: black; background-color: white; border-color: #d6e9c6; } -/* line 11, ../sass/project.scss */ .alert-info { color: #3a87ad; background-color: #d9edf7; border-color: #bce8f1; } -/* line 17, ../sass/project.scss */ .alert-success { color: #468847; background-color: #dff0d8; border-color: #d6e9c6; } -/* line 23, ../sass/project.scss */ .alert-warning { color: black; background-color: orange; border-color: #d6e9c6; } -/* line 29, ../sass/project.scss */ .alert-error { color: #b94a48; background-color: #f2dede; border-color: #eed3d7; } -/* line 36, ../sass/project.scss */ .navbar-header { margin-bottom: 3rem; } From 1571b91dadc867680f8a9e82ac18b09b3a707183 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Tue, 1 Sep 2015 20:18:28 +0200 Subject: [PATCH 026/402] Add ability to set ALLOWED_HOSTS --- {{cookiecutter.repo_name}}/config/settings/production.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 23830a33a..9d65f90e7 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -69,7 +69,7 @@ SECURE_SSL_REDIRECT = env.bool("DJANGO_SECURE_SSL_REDIRECT", default=True) # ------------------------------------------------------------------------------ # Hosts/domain names that are valid for this site # See https://docs.djangoproject.com/en/1.6/ref/settings/#allowed-hosts -ALLOWED_HOSTS = ["*"] +ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=['{{cookiecutter.domain_name}}']) # END SITE CONFIGURATION INSTALLED_APPS += ("gunicorn", ) From b04719170944746d89f03489d19c68d9b33c5a3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Tue, 1 Sep 2015 20:35:43 +0200 Subject: [PATCH 027/402] Set .herokuapp.com as allowed host on heroku --- {{cookiecutter.repo_name}}/README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index b6cf2ec64..cf5db95b3 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -220,6 +220,7 @@ Run these commands to deploy the project to Heroku: heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' + heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE From 1ab5e73b51ab85bba90e78b6666cc1acfadc6fec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Tue, 1 Sep 2015 20:50:50 +0200 Subject: [PATCH 028/402] Add allowed_hosts to the settings list --- {{cookiecutter.repo_name}}/README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index cf5db95b3..d98dc48f8 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -30,6 +30,7 @@ DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "{{cookiecutter.project_name}} " DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "{{cookiecutter.project_name}} " DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[{{cookiecutter.project_name}}] " +DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['{{cookiecutter.domain_name}}'] ======================================= =========================== ============================================== ====================================================================== The following table lists settings and their defaults for third-party applications: From e73e967c8dfd037c6676c2dff38316e8b8afeeb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Wed, 2 Sep 2015 22:10:37 +0200 Subject: [PATCH 029/402] Fix sentry configuration --- {{cookiecutter.repo_name}}/config/settings/production.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 23830a33a..766ee2037 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -162,7 +162,8 @@ CACHES = { {% if cookiecutter.use_sentry == "y" %} # Sentry Configuration -SENTRY_CLIENT = env('DJANGO_SENTRY_CLIENT') +SENTRY_DSN = env('DJANGO_SENTRY_DSN') +SENTRY_CLIENT = env('DJANGO_SENTRY_CLIENT', default='raven.contrib.django.raven_compat.DjangoClient') LOGGING = { 'version': 1, 'disable_existing_loggers': True, @@ -205,9 +206,10 @@ LOGGING = { }, }, } -SENTRY_CELERY_LOGLEVEL = env('DJANGO_SENTRY_LOG_LEVEL', logging.INFO) +SENTRY_CELERY_LOGLEVEL = env.int('DJANGO_SENTRY_LOG_LEVEL', logging.INFO) RAVEN_CONFIG = { - 'CELERY_LOGLEVEL': env('DJANGO_SENTRY_LOG_LEVEL', logging.INFO) + 'CELERY_LOGLEVEL': env.int('DJANGO_SENTRY_LOG_LEVEL', logging.INFO), + 'DSN': SENTRY_DSN } {% endif %} # Your production stuff: Below this line define 3rd party library settings From b13bd0578e8066d05313052053bfb3874cf327ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Wed, 2 Sep 2015 22:59:40 +0200 Subject: [PATCH 030/402] Make logs more descriptive --- .../config/settings/common.py | 20 ++++++++++++++++++- .../config/settings/production.py | 5 +++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index fb494848e..b74f72bae 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -238,12 +238,23 @@ LOGGING = { '()': 'django.utils.log.RequireDebugFalse' } }, + 'formatters': { + 'verbose': { + 'format': '%(levelname)s %(asctime)s %(module)s ' + '%(process)d %(thread)d %(message)s' + }, + }, 'handlers': { 'mail_admins': { 'level': 'ERROR', 'filters': ['require_debug_false'], 'class': 'django.utils.log.AdminEmailHandler' - } + }, + 'console': { + 'level': 'DEBUG', + 'class': 'logging.StreamHandler', + 'formatter': 'verbose', + }, }, 'loggers': { 'django.request': { @@ -251,6 +262,13 @@ LOGGING = { 'level': 'ERROR', 'propagate': True, }, + 'loggers': { + 'django.security.DisallowedHost': { + 'level': 'ERROR', + 'handlers': ['console', 'mail_admins'], + 'propagate': True, + }, + }, } } {% if cookiecutter.use_celery == "y" %} diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 9d65f90e7..caff8e36a 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -203,6 +203,11 @@ LOGGING = { 'handlers': ['console'], 'propagate': False, }, + 'django.security.DisallowedHost': { + 'level': 'ERROR', + 'handlers': ['console', 'sentry'], + 'propagate': False, + }, }, } SENTRY_CELERY_LOGLEVEL = env('DJANGO_SENTRY_LOG_LEVEL', logging.INFO) From 734fef14e80fe56bef2d90e64f05adad388f6bc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Wed, 2 Sep 2015 23:22:40 +0200 Subject: [PATCH 031/402] Add DJANGO_ALLOWED_HOSTS variable to the env.example file --- {{cookiecutter.repo_name}}/env.example | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index b43753243..381a3cf0b 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -3,6 +3,7 @@ POSTGRES_USER=postgresuser DJANGO_SETTINGS_MODULE=config.settings.production DJANGO_SECRET_KEY= +DJANGO_ALLOWED_HOSTS= DJANGO_AWS_ACCESS_KEY_ID= DJANGO_AWS_SECRET_ACCESS_KEY= DJANGO_AWS_STORAGE_BUCKET_NAME= From 467ccee10cf7e5a93e92970227b9b8702cb4397a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Thu, 3 Sep 2015 20:52:59 +0200 Subject: [PATCH 032/402] Add heroku configuration file --- {{cookiecutter.repo_name}}/README.rst | 3 +++ {{cookiecutter.repo_name}}/app.json | 30 +++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 {{cookiecutter.repo_name}}/app.json diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index b6cf2ec64..5a35d1e00 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -205,6 +205,9 @@ We providing tools and instructions for deploying using Docker and Heroku. Heroku ^^^^^^ +.. image:: https://www.herokucdn.com/deploy/button.png + :target: https://heroku.com/deploy + Run these commands to deploy the project to Heroku: .. code-block:: bash diff --git a/{{cookiecutter.repo_name}}/app.json b/{{cookiecutter.repo_name}}/app.json new file mode 100644 index 000000000..1af80c5d0 --- /dev/null +++ b/{{cookiecutter.repo_name}}/app.json @@ -0,0 +1,30 @@ +{ + "name": "{{cookiecutter.repo_name}}", + "description": "{{cookiecutter.description}}", + "env": { + "BUILDPACK_URL": "https://github.com/heroku/heroku-buildpack-python", + "DJANGO_SETTINGS_MODULE": "config.settings.production", + "DJANGO_SECRET_KEY": { + "description": "A secret key for verifying the integrity of signed cookies.", + "generator": "secret" + }, + "DJANGO_ALLOWED_HOSTS": { + "description": "Comma-separated list of hosts", + "value": ".herokuapp.com" + }, + "DJANGO_AWS_ACCESS_KEY_ID": "", + "DJANGO_AWS_SECRET_ACCESS_KEY": "", + "DJANGO_AWS_STORAGE_BUCKET_NAME": "", + "DJANGO_MAILGUN_SERVER_NAME": "", + "DJANGO_MAILGUN_API_KEY": ""{% if cookiecutter.use_sentry == "y" -%}, + "DJANGO_SENTRY_DSN": ""{%- endif %} + }, + "scripts": { + "postdeploy": "python manage.py migrate" + }, + "addons": [ + "heroku-postgresql:hobby-dev", + "heroku-redis:hobby-dev", + "mailgun" + ] +} From e29857c8ad29e8d64f4b518080a6f8c2788a9aae Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Thu, 3 Sep 2015 15:18:58 -0700 Subject: [PATCH 033/402] Added @bogdal's latest to the CHANGELOG --- CHANGELOG.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 462ea0cbd..8723aa19a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,13 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-03 +### Added +- For security reasons, we set explicitly the list of allowed hosts (@bogdal) + ## [2015-08-31] -### -- Dokku in favor of docker-compose and other modern Django tools (@pydanny) (@pydanny) +### Removed +- Dokku in favor of docker-compose and other modern Django tools (@pydanny) ## [2015-08-30] ### Changed From b5876ce60a74f380c216d9a11fedea2afbf7b067 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Thu, 3 Sep 2015 15:21:30 -0700 Subject: [PATCH 034/402] fix @318 Added the pre-built custom user model as a feature because it's come up in #318 and #232. --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index f6cb01c3b..3b666cd32 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,7 @@ Features * 12-Factor_ based settings via django-environ_ * Optimized development and production settings * Registration via django-allauth_ +* Comes with custom user model ready to go. * Grunt build for compass and livereload * Basic e-mail configurations for sending emails via Mailgun_ * Media storage using Amazon S3 From 73759e38b5b67bacd1697c2514fa4219ffe5d528 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Thu, 3 Sep 2015 21:20:42 -0300 Subject: [PATCH 035/402] =?UTF-8?q?add=20Adam=20Bogda=C5=82=20to=20CONTRIB?= =?UTF-8?q?UTORS=20list?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTORS.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 3b20a0eab..934cc9d35 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -50,6 +50,7 @@ Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * Jannis Gebauer / @got_nil jayfk / @jayfk stepmr / @stepmr +Adam Bogdał / @bogdal * Possesses commit rights From 07027c77dfaf08e733f97d547d63f66ca86665c1 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 4 Sep 2015 21:08:06 -0700 Subject: [PATCH 036/402] Changelog for @bagdal --- CHANGELOG.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8723aa19a..2ee7a4cb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,11 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -## [2015-09-03 +## [2015-09-04] +### Added +- Add easy deploy Heroku button and app.json file (@bogdal) + +## [2015-09-03] ### Added - For security reasons, we set explicitly the list of allowed hosts (@bogdal) From a91d1a41fd305ed230ddea8b77b0cb65462a6ef4 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Tue, 8 Sep 2015 18:05:11 -0700 Subject: [PATCH 037/402] Added htmlcov to .gitignore. No reason to keep these files, as they are purposefully ephemeral. --- {{cookiecutter.repo_name}}/.gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore index ff0e7b0cd..13567ebd0 100644 --- a/{{cookiecutter.repo_name}}/.gitignore +++ b/{{cookiecutter.repo_name}}/.gitignore @@ -32,6 +32,7 @@ pip-log.txt .coverage .tox nosetests.xml +htmlcov # Translations *.mo From 3d93e10cf952ccf3344457692e7867e7a8dbc459 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Wed, 9 Sep 2015 17:56:27 -0700 Subject: [PATCH 038/402] fixed #3, added secret key generator --- CHANGELOG.md | 6 +++- hooks/post_gen_project.py | 67 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 hooks/post_gen_project.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ee7a4cb3..d89a1e833 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,13 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-09] +### Added +- post_gen_hook to generate a secret key for use in locals.py. You should define your own for production (@pydanny) + ## [2015-09-04] ### Added -- Add easy deploy Heroku button and app.json file (@bogdal) +- Easy deploy Heroku button and app.json file (@bogdal) ## [2015-09-03] ### Added diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py new file mode 100644 index 000000000..62363b915 --- /dev/null +++ b/hooks/post_gen_project.py @@ -0,0 +1,67 @@ +""" +This code has been adopted from Django's standard crypto functions and +utilities, specifically: + https://github.com/django/django/blob/master/django/utils/crypto.py +""" +import hashlib +import os +import random +import shutil + +# Use the system PRNG if possible +try: + random = random.SystemRandom() + using_sysrandom = True +except NotImplementedError: + # import warnings + # warnings.warn('A secure pseudo-random number generator is not available ' + # 'on your system. Falling back to Mersenne Twister.') + using_sysrandom = False + +def get_random_string( + length=50, + allowed_chars='abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'): + """ + Returns a securely generated random string. + The default length of 12 with the a-z, A-Z, 0-9 character set returns + a 71-bit value. log_2((26+26+10)^12) =~ 71 bits + """ + if not using_sysrandom: + # This is ugly, and a hack, but it makes things better than + # the alternative of predictability. This re-seeds the PRNG + # using a value that is hard for an attacker to predict, every + # time a random string is required. This may change the + # properties of the chosen random sequence slightly, but this + # is better than absolute predictability. + random.seed( + hashlib.sha256( + ("%s%s%s" % ( + random.getstate(), + time.time(), + settings.SECRET_KEY)).encode('utf-8') + ).digest()) + return ''.join(random.choice(allowed_chars) for i in range(length)) + +# Get the root project directory +project_directory = os.path.realpath(os.path.curdir) + +# Determine the local_setting_file_location +local_setting_file_location = os.path.join( + project_directory, + 'config/settings/local.py' +) + +# Open locals.py +with open(local_setting_file_location) as f: + local_py = f.read() + +# Generate a SECRET_KEY that matches the Django standard +SECRET_KEY = get_random_string() +SECRET_KEY = 'CHANGEME!!!' + SECRET_KEY + +# Replace "CHANGEME!!!" with SECRET_KEY +local_py = local_py.replace('CHANGEME!!!', SECRET_KEY) + +# Write the results to the locals.py module +with open(local_setting_file_location, 'w') as f: + f.write(local_py) From 071f7d00eb94beaa22af1f59fc0e3f235646fc9f Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Wed, 9 Sep 2015 17:57:23 -0700 Subject: [PATCH 039/402] Changelog for adding html to gitignore --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d89a1e833..04f649696 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Added - post_gen_hook to generate a secret key for use in locals.py. You should define your own for production (@pydanny) +## [2015-09-09] +### Added +- htmlcov to gitignore (@pydanny) + ## [2015-09-04] ### Added - Easy deploy Heroku button and app.json file (@bogdal) From 904f149405702893ec2a3f9231db8a353bcad456 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sun, 13 Sep 2015 08:54:21 -0700 Subject: [PATCH 040/402] Remove styles that already exist in Bootstrap 4 (or 3). --- .../static/sass/project.scss | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index 29a696389..fddce209f 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -8,24 +8,6 @@ border-color: #d6e9c6; } -.alert-info { - color: #3a87ad; - background-color: #d9edf7; - border-color: #bce8f1; -} - -.alert-success { - color: #468847; - background-color: #dff0d8; - border-color: #d6e9c6; -} - -.alert-warning { - color: black; - background-color: orange; - border-color: #d6e9c6; -} - .alert-error { color: #b94a48; background-color: #f2dede; From db186d9e9a534ad873b2a56b1881279563bccd93 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Mon, 31 Aug 2015 00:09:28 -0300 Subject: [PATCH 041/402] fix issue #296 --- CHANGELOG.md | 6 ++++++ .../{{cookiecutter.repo_name}}/templates/account/login.html | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04f649696..80f0ca11a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,11 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Removed - Dokku in favor of docker-compose and other modern Django tools (@pydanny) +## [2015-08-30] +### Changed +- Fix issue #296 - change login.html to use [get_providers](https://github.com/pennersr/django-allauth/blob/master/allauth/socialaccount/templatetags/socialaccount.py#L84-L93) templatetag because ``allauth.socialaccount`` context processor now is [deprecated](http://django-allauth.readthedocs.org/en/latest/changelog.html#from-0-21-0) (@luzfcb) + + ## [2015-08-30] ### Changed - Moved from Bootstrap 3 to Bootstrap 4 (@audreyr) @@ -32,6 +37,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Update AngularJS version to 1.4.4 (@luzfcb) - Update the usage example on README (@luzfcb) + ## [2015-08-28] ### Changed - Switched to django-mailgun-redux so mail doesn't blow up on Python 3 (@pydanny) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html index 19b7a8976..51e75a10b 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html @@ -2,6 +2,7 @@ {% load i18n %} {% load account %} +{% load socialaccount %} {% load url from future %} {% load crispy_forms_tags %} @@ -12,8 +13,8 @@

{% trans "Sign In" %}

- - {% if socialaccount.providers %} + {% get_providers as socialaccount_providers %} + {% if socialaccount_providers %}

{% blocktrans with site.name as site_name %}Please sign in with one of your existing third party accounts. Or, sign up for a {{ site_name }} account and sign in below:{% endblocktrans %}

From baaa94926e2c45b3ce6d20021731da1dadea784a Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Sun, 13 Sep 2015 13:04:57 -0300 Subject: [PATCH 042/402] update CHANGELOG.md --- CHANGELOG.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 80f0ca11a..2ef8d2b72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-13] +### Changed +- Fix issue #296 - change login.html to use [get_providers](https://github.com/pennersr/django-allauth/blob/master/allauth/socialaccount/templatetags/socialaccount.py#L84-L93) templatetag because ``allauth.socialaccount`` context processor now is [deprecated](http://django-allauth.readthedocs.org/en/latest/changelog.html#from-0-21-0) (@luzfcb) + ## [2015-09-09] ### Added - post_gen_hook to generate a secret key for use in locals.py. You should define your own for production (@pydanny) @@ -22,11 +26,6 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Removed - Dokku in favor of docker-compose and other modern Django tools (@pydanny) -## [2015-08-30] -### Changed -- Fix issue #296 - change login.html to use [get_providers](https://github.com/pennersr/django-allauth/blob/master/allauth/socialaccount/templatetags/socialaccount.py#L84-L93) templatetag because ``allauth.socialaccount`` context processor now is [deprecated](http://django-allauth.readthedocs.org/en/latest/changelog.html#from-0-21-0) (@luzfcb) - - ## [2015-08-30] ### Changed - Moved from Bootstrap 3 to Bootstrap 4 (@audreyr) @@ -37,7 +36,6 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Update AngularJS version to 1.4.4 (@luzfcb) - Update the usage example on README (@luzfcb) - ## [2015-08-28] ### Changed - Switched to django-mailgun-redux so mail doesn't blow up on Python 3 (@pydanny) From 135f129d6bcf9c1ccd10095b75e150fc442b925f Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sun, 13 Sep 2015 09:18:39 -0700 Subject: [PATCH 043/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04f649696..602c1ac31 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-13] +## Removed +- Styles that already exist in Bootstrap 4 (or 3) (@audreyr) + ## [2015-09-09] ### Added - post_gen_hook to generate a secret key for use in locals.py. You should define your own for production (@pydanny) From 9c9a624ee28d93b800217d9cb958a1ceeef785bd Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sun, 13 Sep 2015 09:56:40 -0700 Subject: [PATCH 044/402] Update Hitch requirements to latest. --- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index ee330e662..d081a2244 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -8,15 +8,15 @@ hitchredis==0.4.1 hitchselenium==0.4 hitchserve==0.4.3 hitchsmtp==0.2.1 -hitchtest==0.7.6 +hitchtest==0.7.7 humanize==0.5.1 ipython==4.0.0 Jinja2==2.8 MarkupSafe==0.23 patool==1.8 -psutil==3.1.1 -python-build==0.2.1 -pyuv==1.1.0 +psutil==3.2.1 +python-build==0.2.2 +pyuv==1.2.0 PyYAML==3.11 requests==2.7.0 selenium==2.47.1 From 191d4768a548e883bbc865236c93fcf23e3fc235 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sun, 13 Sep 2015 13:59:02 -0700 Subject: [PATCH 045/402] Address test coverage issues. --- .../{{cookiecutter.repo_name}}/taskapp/celery.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index 33cda5c62..469716261 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -7,7 +7,7 @@ from django.conf import settings if not settings.configured: # set the default Django settings module for the 'celery' program. - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") # noqa app = Celery('{{cookiecutter.repo_name}}') @@ -26,8 +26,8 @@ class CeleryConfig(AppConfig): @app.task(bind=True) def debug_task(self): - print('Request: {0!r}'.format(self.request)) + print('Request: {0!r}'.format(self.request)) # noqa {% else %} # Use this as a starting point for your project with celery. # If you are not using celery, you can remove this app -{% endif %} \ No newline at end of file +{% endif %} From 2b81eb9be7b41589efb455d3e6a9afdfde9e56f3 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sun, 13 Sep 2015 14:01:51 -0700 Subject: [PATCH 046/402] noqa != pragma --- .../{{cookiecutter.repo_name}}/taskapp/celery.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index 469716261..d29fca8ca 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -7,7 +7,7 @@ from django.conf import settings if not settings.configured: # set the default Django settings module for the 'celery' program. - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") # noqa + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") # pragma: no cover app = Celery('{{cookiecutter.repo_name}}') @@ -26,7 +26,7 @@ class CeleryConfig(AppConfig): @app.task(bind=True) def debug_task(self): - print('Request: {0!r}'.format(self.request)) # noqa + print('Request: {0!r}'.format(self.request)) # pragma: no cover {% else %} # Use this as a starting point for your project with celery. # If you are not using celery, you can remove this app From 319c5ac42a58a25dbed970aa5f525f125adf16b6 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Sun, 13 Sep 2015 19:09:23 -0300 Subject: [PATCH 047/402] fix 'W391 blank line at end of file' on celery.py --- .../{{cookiecutter.repo_name}}/taskapp/celery.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index d29fca8ca..8155204ab 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -30,4 +30,4 @@ def debug_task(self): {% else %} # Use this as a starting point for your project with celery. # If you are not using celery, you can remove this app -{% endif %} +{% endif -%} From c45c86ad308df49c354b0e4d38885c18aaecb8d8 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Mon, 14 Sep 2015 13:20:12 -0700 Subject: [PATCH 048/402] Replace navbar-header with Bootstrap m-b-lg for the navbar's margin-bottom. --- .../{{cookiecutter.repo_name}}/static/sass/project.scss | 5 ----- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index fddce209f..5352d3241 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -13,8 +13,3 @@ background-color: #f2dede; border-color: #eed3d7; } - -// Give header a nice bottom margin -.navbar-header { - margin-bottom: 3rem; -} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 00123ab02..076e9556f 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -31,7 +31,7 @@ -
+
From 275f7eee14d9a8826efb346b8449061cd4d58195 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 18 Sep 2015 10:20:48 -0700 Subject: [PATCH 068/402] Big reorganization of documentation --- .gitignore | 1 + README.rst | 5 +- docs/deployment-on-heroku.rst | 34 +++ docs/deployment-with-docker.rst | 110 +++++++++ docs/index.rst | 5 + docs/linters.rst | 4 + docs/live-reloading-and-sass-compilation.rst | 24 ++ docs/settings.rst | 42 ++++ {{cookiecutter.repo_name}}/README.rst | 232 +------------------ 9 files changed, 234 insertions(+), 223 deletions(-) create mode 100644 docs/deployment-on-heroku.rst create mode 100644 docs/deployment-with-docker.rst create mode 100644 docs/linters.rst create mode 100644 docs/live-reloading-and-sass-compilation.rst create mode 100644 docs/settings.rst diff --git a/.gitignore b/.gitignore index 967469bc6..111bf3070 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ sftp-config.json *.pot *.pyc .idea +_build # Project Specific Stuff local_settings.py diff --git a/README.rst b/README.rst index 98cbb590d..f1b03db32 100644 --- a/README.rst +++ b/README.rst @@ -125,9 +125,12 @@ Now take a look at your repo. Don't forget to carefully look at the generated RE For development, see the following for local development: -* Developing locally +* `Developing locally`_ * Developing locally using docker +.. _`Developing locally`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally.html +.. _`Developing locally using docker`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally-docker.html + For Readers of Two Scoops of Django 1.8 -------------------------------------------- diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst new file mode 100644 index 000000000..782eb641b --- /dev/null +++ b/docs/deployment-on-heroku.rst @@ -0,0 +1,34 @@ +Deployment on Heroku +==================== + +You can either push the 'deploy' button in your generated README.rst or run these commands to deploy the project to Heroku: + +.. code-block:: bash + + heroku create --buildpack https://github.com/heroku/heroku-buildpack-python + + heroku addons:create heroku-postgresql:hobby-dev + heroku pg:backups schedule --at '02:00 America/Los_Angeles' DATABASE_URL + heroku pg:promote DATABASE_URL + + heroku addons:create heroku-redis:hobby-dev + heroku addons:create mailgun + + heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` + heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' + heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' + + heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE + heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE + heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE + + heroku config:set DJANGO_MAILGUN_SERVER_NAME=YOUR_MALGUN_SERVER + heroku config:set DJANGO_MAILGUN_API_KEY=YOUR_MAILGUN_API_KEY + + heroku config:set PYTHONHASHSEED=random + + git push heroku master + heroku run python manage.py migrate + heroku run python manage.py check --deploy + heroku run python manage.py createsuperuser + heroku open diff --git a/docs/deployment-with-docker.rst b/docs/deployment-with-docker.rst new file mode 100644 index 000000000..6b5fece14 --- /dev/null +++ b/docs/deployment-with-docker.rst @@ -0,0 +1,110 @@ +Deployment with Docker +================================================= + +TODO: Review and revise + +**Warning** + +Docker is evolving extremely fast, but it has still some rough edges here and there. Compose is currently (as of version 1.4) +not considered production ready. That means you won't be able to scale to multiple servers and you won't be able to run +zero downtime deployments out of the box. Consider all this as experimental until you understand all the implications +to run docker (with compose) on production. + +**Run your app with docker-compose** + +Prerequisites: + +* docker (tested with 1.8) +* docker-compose (tested with 0.4) + +Before you start, check out the `docker-compose.yml` file in the root of this project. This is where each component +of this application gets its configuration from. It consists of a `postgres` service that runs the database, `redis` +for caching, `nginx` as reverse proxy and last but not least the `django` application run by gunicorn. +{% if cookiecutter.use_celery == 'y' -%} +Since this application also runs Celery, there are two more services with a service called `celeryworker` that runs the +celery worker process and `celerybeat` that runs the celery beat process. +{% endif %} + + +All of these services except `redis` rely on environment variables set by you. There is an `env.example` file in the +root directory of this project as a starting point. Add your own variables to the file and rename it to `.env`. This +file won't be tracked by git by default so you'll have to make sure to use some other mechanism to copy your secret if +you are relying solely on git. + + +By default, the application is configured to listen on all interfaces on port 80. If you want to change that, open the +`docker-compose.yml` file and replace `0.0.0.0` with your own ip. If you are using `nginx-proxy`_ to run multiple +application stacks on one host, remove the port setting entirely and add `VIRTUAL_HOST={{cookiecutter.domain_name}}` to your env file. +This pass all incoming requests on `nginx-proxy`_ to the nginx service your application is using. + +.. _nginx-proxy: https://github.com/jwilder/nginx-proxy + +Postgres is saving its database files to `/data/{{cookiecutter.repo_name}}/postgres` by default. Change that if you wan't +something else and make sure to make backups since this is not done automatically. + +To get started, pull your code from source control (don't forget the `.env` file) and change to your projects root +directory. + +You'll need to build the stack first. To do that, run:: + + docker-compose build + +Once this is ready, you can run it with:: + + docker-compose up + + +To run a migration, open up a second terminal and run:: + + docker-compose run django python manage.py migrate + +To create a superuser, run:: + + docker-compose run django python manage.py createsuperuser + + +If you need a shell, run:: + + docker-compose run django python manage.py shell_plus + +To get an output of all running containers. + +To check your logs, run:: + + docker-compose logs + +If you want to scale your application, run:: + + docker-compose scale django=4 + docker-compose scale celeryworker=2 + + +**Don't run the scale command on postgres or celerybeat** + +Once you are ready with your initial setup, you wan't to make sure that your application is run by a process manager to +survive reboots and auto restarts in case of an error. You can use the process manager you are most familiar with. All +it needs to do is to run `docker-compose up` in your projects root directory. + +If you are using `supervisor`, you can use this file as a starting point:: + + [program:{{cookiecutter.repo_name}}] + command=docker-compose up + directory=/path/to/{{cookiecutter.repo_name}} + redirect_stderr=true + autostart=true + autorestart=true + priority=10 + + +Place it in `/etc/supervisor/conf.d/{{cookiecutter.repo_name}}.conf` and run:: + + supervisorctl reread + supervisorctl start {{cookiecutter.repo_name}} + +To get the status, run:: + + supervisorctl status + +If you have errors, you can always check your stack with `docker-compose`. Switch to your projects root directory and run:: + + docker-compose ps diff --git a/docs/index.rst b/docs/index.rst index a701fbee6..42f957545 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,11 @@ Contents: developing-locally developing-locally-docker + settings + linters + live-reloading-and-sass-compilation + deployment-on-heroku + deployment-with-docker Indices and tables ================== diff --git a/docs/linters.rst b/docs/linters.rst new file mode 100644 index 000000000..05b8e303e --- /dev/null +++ b/docs/linters.rst @@ -0,0 +1,4 @@ +Linters +======= + +TODO diff --git a/docs/live-reloading-and-sass-compilation.rst b/docs/live-reloading-and-sass-compilation.rst new file mode 100644 index 000000000..5996bc327 --- /dev/null +++ b/docs/live-reloading-and-sass-compilation.rst @@ -0,0 +1,24 @@ +Live reloading and Sass CSS compilation +======================================= + +If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with a little bit of prep work. + +Make sure that nodejs_ is installed. Then in the project root run:: + + $ npm install + +.. _nodejs: http://nodejs.org/download/ + +If you don't already have it, install `compass` (doesn't hurt if you run this command twice):: + + gem install compass + +Now you just need:: + + $ grunt serve + +The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled. + +To get live reloading to work you'll probably need to install an `appropriate browser extension`_ + +.. _appropriate browser extension: http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions- diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 000000000..0c36df1cd --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,42 @@ +Settings +========== + +This project 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 environment variables to their Django setting: + + +======================================= =========================== ============================================== ====================================================================== +Environment Variable Django Setting Development Default Production Default +======================================= =========================== ============================================== ====================================================================== +DJANGO_CACHES CACHES (default) locmem redis +DJANGO_DATABASES DATABASES (default) See code See code +DJANGO_DEBUG DEBUG True False +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 False +DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "your_project_name " +DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "your_project_name " +DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[your_project_name] " +DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['your_project_name}'] +======================================= =========================== ============================================== ====================================================================== + +The following table lists settings and their defaults for third-party applications, which may or may be part of your project: + +======================================= =========================== ============================================== ====================================================================== +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_SENTRY_DSN SENTRY_DSN n/a raises error +DJANGO_SENTRY_CLIENT SENTRY_CLIENT n/a raven.contrib.django.raven_compat.DjangoClient +DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO +DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error +DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error +======================================= =========================== ============================================== ====================================================================== diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index f0b0f61cd..ba7dc2165 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -9,76 +9,12 @@ LICENSE: BSD Settings ------------ -{{cookiecutter.project_name}} 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. +Moved to settings_. -For configuration purposes, the following table maps the '{{cookiecutter.project_name}}' environment variables to their Django setting: +.. _settings: http://cookiecutter-django.readthedocs.org/en/latest/settings.html -======================================= =========================== ============================================== ====================================================================== -Environment Variable Django Setting Development Default Production Default -======================================= =========================== ============================================== ====================================================================== -DJANGO_CACHES CACHES (default) locmem redis -DJANGO_DATABASES DATABASES (default) See code See code -DJANGO_DEBUG DEBUG True False -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 False -DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "{{cookiecutter.project_name}} " -DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "{{cookiecutter.project_name}} " -DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[{{cookiecutter.project_name}}] " -DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['{{cookiecutter.domain_name}}'] -======================================= =========================== ============================================== ====================================================================== - -The following table lists settings and their defaults for third-party applications: - -======================================= =========================== ============================================== ====================================================================== -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 -{% if cookiecutter.use_sentry == "y" -%}DJANGO_SENTRY_DSN SENTRY_DSN n/a raises error -DJANGO_SENTRY_CLIENT SENTRY_CLIENT n/a raven.contrib.django.raven_compat.DjangoClient -DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO{%- endif %} -DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error -DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error -======================================= =========================== ============================================== ====================================================================== - -Getting up and running ----------------------- - -Basics -^^^^^^ - -The steps below will get you up and running with a local development environment. We assume you have the following installed: - -* pip -* virtualenv -* PostgreSQL - -First make sure to create and activate a virtualenv_, then open a terminal at the project root and install the requirements for local development:: - - $ pip install -r requirements/local.txt - -.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/ - -Create a local PostgreSQL database:: - - $ createdb {{ cookiecutter.repo_name }} - -Run ``migrate`` on your new database:: - - $ python manage.py migrate - -You can now run the ``runserver_plus`` command:: - - $ python manage.py runserver_plus - -Open up your browser to http://127.0.0.1:8000/ to see the site running locally. +Basic Commands +-------------- Setting Up Your Users ^^^^^^^^^^^^^^^^^^^^^ @@ -103,27 +39,9 @@ To run the tests, check your test coverage, and generate an HTML coverage report Live reloading and Sass CSS compilation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with a little bit of prep work. +Moved to `Live reloading and SASS compilation`_. -Make sure that nodejs_ is installed. Then in the project root run:: - - $ npm install - -.. _nodejs: http://nodejs.org/download/ - -If you don't already have it, install `compass` (doesn't hurt if you run this command twice):: - - gem install compass - -Now you just need:: - - $ grunt serve - -The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled. - -To get live reloading to work you'll probably need to install an `appropriate browser extension`_ - -.. _appropriate browser extension: http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions- +.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.org/en/latest/live-reloading-and-sass-compilation.html {% if cookiecutter.use_celery == "y" %} @@ -218,143 +136,13 @@ Heroku .. image:: https://www.herokucdn.com/deploy/button.png :target: https://heroku.com/deploy -Run these commands to deploy the project to Heroku: +See detailed `cookiecutter-django Heroku documentation`_. -.. code-block:: bash - - heroku create --buildpack https://github.com/heroku/heroku-buildpack-python - - heroku addons:create heroku-postgresql:hobby-dev - heroku pg:backups schedule --at '02:00 America/Los_Angeles' DATABASE_URL - heroku pg:promote DATABASE_URL - - heroku addons:create heroku-redis:hobby-dev - heroku addons:create mailgun - - heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` - heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' - heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' - - heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE - heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE - heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE - - heroku config:set DJANGO_MAILGUN_SERVER_NAME=YOUR_MALGUN_SERVER - heroku config:set DJANGO_MAILGUN_API_KEY=YOUR_MAILGUN_API_KEY - - heroku config:set PYTHONHASHSEED=random - - git push heroku master - heroku run python manage.py migrate - heroku run python manage.py check --deploy - heroku run python manage.py createsuperuser - heroku open +.. _`cookiecutter-django Heroku documentation`: http://cookiecutter-django.readthedocs.org/en/latest/deployment-on-heroku.html Docker ^^^^^^ -**Warning** +See detailed `cookiecutter-django Docker documentation`_. -Docker is evolving extremely fast, but it has still some rough edges here and there. Compose is currently (as of version 1.4) -not considered production ready. That means you won't be able to scale to multiple servers and you won't be able to run -zero downtime deployments out of the box. Consider all this as experimental until you understand all the implications -to run docker (with compose) on production. - -**Run your app with docker-compose** - -Prerequisites: - -* docker (tested with 1.8) -* docker-compose (tested with 0.4) - -Before you start, check out the `docker-compose.yml` file in the root of this project. This is where each component -of this application gets its configuration from. It consists of a `postgres` service that runs the database, `redis` -for caching, `nginx` as reverse proxy and last but not least the `django` application run by gunicorn. -{% if cookiecutter.use_celery == 'y' -%} -Since this application also runs Celery, there are two more services with a service called `celeryworker` that runs the -celery worker process and `celerybeat` that runs the celery beat process. -{% endif %} - - -All of these services except `redis` rely on environment variables set by you. There is an `env.example` file in the -root directory of this project as a starting point. Add your own variables to the file and rename it to `.env`. This -file won't be tracked by git by default so you'll have to make sure to use some other mechanism to copy your secret if -you are relying solely on git. - - -By default, the application is configured to listen on all interfaces on port 80. If you want to change that, open the -`docker-compose.yml` file and replace `0.0.0.0` with your own ip. If you are using `nginx-proxy`_ to run multiple -application stacks on one host, remove the port setting entirely and add `VIRTUAL_HOST={{cookiecutter.domain_name}}` to your env file. -This pass all incoming requests on `nginx-proxy` to the nginx service your application is using. - -.. _nginx-proxy: https://github.com/jwilder/nginx-proxy - -Postgres is saving its database files to `/data/{{cookiecutter.repo_name}}/postgres` by default. Change that if you wan't -something else and make sure to make backups since this is not done automatically. - -To get started, pull your code from source control (don't forget the `.env` file) and change to your projects root -directory. - -You'll need to build the stack first. To do that, run:: - - docker-compose build - -Once this is ready, you can run it with:: - - docker-compose up - - -To run a migration, open up a second terminal and run:: - - docker-compose run django python manage.py migrate - -To create a superuser, run:: - - docker-compose run django python manage.py createsuperuser - - -If you need a shell, run:: - - docker-compose run django python manage.py shell_plus - -To get an output of all running containers. - -To check your logs, run:: - - docker-compose logs - -If you want to scale your application, run:: - - docker-compose scale django=4 - docker-compose scale celeryworker=2 - - -**Don't run the scale command on postgres or celerybeat** - -Once you are ready with your initial setup, you wan't to make sure that your application is run by a process manager to -survive reboots and auto restarts in case of an error. You can use the process manager you are most familiar with. All -it needs to do is to run `docker-compose up` in your projects root directory. - -If you are using `supervisor`, you can use this file as a starting point:: - - [program:{{cookiecutter.repo_name}}] - command=docker-compose up - directory=/path/to/{{cookiecutter.repo_name}} - redirect_stderr=true - autostart=true - autorestart=true - priority=10 - - -Place it in `/etc/supervisor/conf.d/{{cookiecutter.repo_name}}.conf` and run:: - - supervisorctl reread - supervisorctl start {{cookiecutter.repo_name}} - -To get the status, run:: - - supervisorctl status - -If you have errors, you can always check your stack with `docker-compose`. Switch to your projects root directory and run:: - - docker-compose ps +.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.org/en/latest/deployment-with-docker.html From 361ab459e8a63fbd88a59d471ee2677a4deed42d Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 18:24:06 +0100 Subject: [PATCH 069/402] Update Dockerfile --- {{cookiecutter.repo_name}}/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index d7d5e9e26..a6800b185 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -1,4 +1,4 @@ -{% if cookiecutter.use_python2= 'n' -%} +{% if cookiecutter.use_python2== 'n' -%} FROM python:3.4 {% else %} FROM python:2.7 From 6662ccbd94be9a67dfa702194da83f3036bd0d66 Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 18:24:18 +0100 Subject: [PATCH 070/402] Update runtime.txt --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 0c4eaa325..2180fd5d1 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ -{% if cookiecutter.use_python2= 'n' -%} +{% if cookiecutter.use_python2== 'n' -%} python-3.4.3 {% else %} From 44814f3cedbf15cc0bbf2adaee4f9e436fe69fb2 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 18 Sep 2015 10:55:06 -0700 Subject: [PATCH 071/402] Add FAQ and early work on file copier #335 --- docs/faq.rst | 15 +++++++++++++++ docs/index.rst | 1 + hooks/post_gen_project.py | 26 ++++++++++++++++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 docs/faq.rst diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 000000000..9079aaee7 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,15 @@ +FAQ +==== + +Why aren't you using just one configuration file (12-Factor App) +---------------------------------------------------------------------- + +TODO + +Why doesn't this follow the layout from Two Scoops of Django 1.8? +---------------------------------------------------------------------- + +You may notice that some elements of this project do not exactly match what we describe in chapter 3 of `Two Scoops of Django`_. The reason for that is this project, amongst other things, serves as a test bed for trying out new ideas and concepts. Sometimes they work, sometimes they don't, but the end result is that it won't necessarily match precisely what is described in the book I co-authored. + + +.. _`Two Scoops of Django`: http://twoscoopspress.com/products/two-scoops-of-django-1-8 diff --git a/docs/index.rst b/docs/index.rst index 42f957545..0b876a187 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Contents: live-reloading-and-sass-compilation deployment-on-heroku deployment-with-docker + faq Indices and tables ================== diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index e7ef83427..21432ffd2 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -3,6 +3,9 @@ Does the following: 1. Generates and saves random secret key 2. Removes the taskapp if celery isn't going to be used +3. Copy files from /docs/ to {{ cookiecutter.repo_name }}/docs/ + + TODO: this might have to be moved to a pre_gen_hook A portion of this code was adopted from Django's standard crypto functions and utilities, specifically: @@ -13,6 +16,8 @@ import os import random import shutil +from cookiecutter.config import DEFAULT_CONFIG + # Get the root project directory PROJECT_DIRECTORY = os.path.realpath(os.path.curdir) @@ -82,9 +87,30 @@ def remove_task_app(project_directory): ) shutil.rmtree(task_app_location) +# IN PROGRESS +# def copy_doc_files(project_directory): +# cookiecutters_dir = DEFAULT_CONFIG['cookiecutters_dir'] +# cookiecutter_django_dir = os.path.join( +# cookiecutters_dir, +# 'cookiecutter-django', +# 'docs' +# ) +# target_dir = os.path.join( +# project_directory, +# 'docs' +# ) +# for name in os.listdir(cookiecutter_django_dir): +# if name.endswith('.rst') and not name.startswith('index'): +# src = os.path.join(cookiecutter_django_dir, name) +# dst = os.path.join(target_dir, name) +# shutil.copyfile(src, dst) + # 1. Generates and saves random secret key make_secret_key(PROJECT_DIRECTORY) # 2. Removes the taskapp if celery isn't going to be used if '{{ cookiecutter.use_celery }}'.lower() == 'n': remove_task_app(PROJECT_DIRECTORY) + +# 3. Copy files from /docs/ to {{ cookiecutter.repo_name }}/docs/ +# copy_doc_files(PROJECT_DIRECTORY) From c77c8e0b83d5024be171315051fbf00297853501 Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 19:02:33 +0100 Subject: [PATCH 072/402] Update Dockerfile --- {{cookiecutter.repo_name}}/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index a6800b185..e1c875ff3 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -1,4 +1,4 @@ -{% if cookiecutter.use_python2== 'n' -%} +{% if cookiecutter.use_python2 == 'n' -%} FROM python:3.4 {% else %} FROM python:2.7 From 2489bf39abf21021b31a08b4c375917ae3c834c7 Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 19:02:42 +0100 Subject: [PATCH 073/402] Update runtime.txt --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 2180fd5d1..946c5e2ad 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ -{% if cookiecutter.use_python2== 'n' -%} +{% if cookiecutter.use_python2 == 'n' -%} python-3.4.3 {% else %} From cb44293d81451bd296efd05701b0fa8036a400da Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 19:04:17 +0100 Subject: [PATCH 074/402] Update runtime.txt --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 946c5e2ad..c3ff7c213 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ {% if cookiecutter.use_python2 == 'n' -%} python-3.4.3 -{% else %} +{% endif %} From e63d9fc7363b14522a372eded21e6535be790f24 Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 18 Sep 2015 19:07:09 +0100 Subject: [PATCH 075/402] Update runtime.txt --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index c3ff7c213..18104d92b 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ {% if cookiecutter.use_python2 == 'n' -%} python-3.4.3 -{% endif %} +{%- endif %} From 698c990cbdfcbd93a2dbe4e074231f05fef5edfe Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 18 Sep 2015 14:26:29 -0700 Subject: [PATCH 076/402] Refactored the Docker docs and added indexes. --- README.rst | 2 +- docs/deployment-on-heroku.rst | 2 + docs/deployment-with-docker.rst | 2 + docs/developing-locally-docker.rst | 108 ++++++++++++++++++++++++++++- docs/developing-locally.rst | 6 ++ docs/faq.rst | 2 + docs/index.rst | 4 +- docs/linters.rst | 2 +- 8 files changed, 124 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index f1b03db32..72b8713f6 100644 --- a/README.rst +++ b/README.rst @@ -126,7 +126,7 @@ Now take a look at your repo. Don't forget to carefully look at the generated RE For development, see the following for local development: * `Developing locally`_ -* Developing locally using docker +* `Developing locally using docker`_ .. _`Developing locally`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally.html .. _`Developing locally using docker`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally-docker.html diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index 782eb641b..6ee99fee2 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -1,6 +1,8 @@ Deployment on Heroku ==================== +.. index:: Heroku + You can either push the 'deploy' button in your generated README.rst or run these commands to deploy the project to Heroku: .. code-block:: bash diff --git a/docs/deployment-with-docker.rst b/docs/deployment-with-docker.rst index 6b5fece14..e5b0bfd45 100644 --- a/docs/deployment-with-docker.rst +++ b/docs/deployment-with-docker.rst @@ -1,6 +1,8 @@ Deployment with Docker ================================================= +.. index:: Docker, deployment + TODO: Review and revise **Warning** diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index e266f524d..41a09b479 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -1,6 +1,112 @@ Getting Up and Running with Docker ================================== +.. index:: Docker + +The steps below will get you up and running with a local development environment. + +Prerequisites +-------------- + +* docker +* docker-machine +* docker-compose +* virtualbox + +If you don't already have these installed, you can get them at: + +* https://github.com/docker/toolbox/releases +* https://www.virtualbox.org/wiki/Downloads + +Go to the Root of your Project +------------------------------ + +All of these commands assume you are in the root of your generated project. + +Create the Machine +------------------- + +:: + + $ docker-machine create --driver virtualbox dev1 + +**Note:** If you want to have more than one docker development environment, then +name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject', +'djangopackages', et al. + +Make the new machine the active unit +------------------------------------- + +This tells our computer that all future commands are specifically for the just +created machine. Using the ``eval`` command we can switch machines as needed. + +:: + + $ eval "$(docker-machine env dev1)" + +Get the IP Address +-------------------- + +Acquiring the IP Address is good for two reasons: + +1. Confirms that the machine is up and running. +2. Tells us the IP address where our Django project is being served. + +:: + + $ docker-machine ip dev1 + 123.456.789.012 + +Build the Stack +--------------- + +This can take a while, especially the first time you run this particular command +on your development system. + +:: + $ docker-compose build + +Boot the System +------------------------------ + +This brings up both Django and PostgreSQL. The first time it is run it might +take a while to get started, but subsequent runs will occur quickly. + +:: + + $ docker-compose -f dev.yml up + +If you want to run the entire system in production mode, then run: + +:: + + $ docker-compose up + +If you want to run the stack in detached mode (in the background), use the ``-d`` argument:: + +:: + + $ docker-compose up -d + +Running bash commands (i.e. management commands) +---------------------------------------------------- + +This is done using the ``docker-compose run`` command. In the following examples +we specify the ``django`` container as the location to run our management commands. + +Example: + + $ docker-compose run django python manage.py migrate + $ docker-compose run django python manage.py createsuperuser + + + +Deprecated +========== + +**Note:** This segment of documentation is being kept in this location as part of our documentation transition process. + + The steps below will get you up and running with a local development environment. We assume you have the following installed: * docker @@ -39,5 +145,5 @@ And then:: $ echo 'ln -sfn /mnt/sda1/data /data' >> /var/lib/boot2docker/bootlocal.sh In case you are wondering why you can't use a host volume to keep the files on your mac: As of `boot2docker` 1.7 you'll -run into permission problems with mounted host volumes if the container creates his own user and `chown`s the directories +run into permission problems with mounted host volumes if the container creates his own user and chown's the directories on the volume. Postgres is doing that, so we need this quick fix to ensure that all development data persists. diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 6b7d2effd..d4fd87745 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -1,6 +1,8 @@ Getting Up and Running Locally ============================== +.. index:: pip, virtualenv, PostgreSQL + The steps below will get you up and running with a local development environment. We assume you have the following installed: * pip @@ -33,8 +35,12 @@ django-allauth sends an email to verify users (and superusers) after signup and In development you can (optionally) use Maildump_ for email testing. Or alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` +.. _Maildump: https://github.com/ThiefMaster/maildump + In production basic email configuration is setup to send emails with Mailgun_ +.. _Mailgun: https://www.mailgun.com/ + **Live reloading and Sass CSS compilation** If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with the included Grunt task. diff --git a/docs/faq.rst b/docs/faq.rst index 9079aaee7..9ef546575 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,6 +1,8 @@ FAQ ==== +.. index:: FAQ, 12-Factor App + Why aren't you using just one configuration file (12-Factor App) ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 0b876a187..820844fc3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,5 +26,7 @@ Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` + +.. At some point it would be good to have a module index of the high level things +we are doing. Then we can * :ref:`modindex` back in. diff --git a/docs/linters.rst b/docs/linters.rst index 05b8e303e..3349faed9 100644 --- a/docs/linters.rst +++ b/docs/linters.rst @@ -1,4 +1,4 @@ Linters ======= -TODO +.. index:: linters From 8b3fbce4a2d43854c30689d6882e36b243e18772 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 18 Sep 2015 14:35:10 -0700 Subject: [PATCH 077/402] Add documentation refactor note #335 --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 820844fc3..32f6912ab 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,8 @@ A Cookiecutter_ template for Django. .. _cookiecutter: https://github.com/audreyr/cookiecutter +.. note:: This is an in-progress documentation reorganization. Locations of files may change dramatically over the course of the next few days. See https://github.com/pydanny/cookiecutter-django/issues/335 + Contents: .. toctree:: From 332f746d27bf9641c9bbeaebc0ea39d5ecd8a280 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Fri, 18 Sep 2015 15:22:35 -0700 Subject: [PATCH 078/402] Update outdated requirements. --- requirements.txt | 2 +- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- {{cookiecutter.repo_name}}/requirements/local.txt | 2 +- {{cookiecutter.repo_name}}/requirements/test.txt | 2 +- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 14 +++++++------- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/requirements.txt b/requirements.txt index 34ed238c9..c08cd1733 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,5 +9,5 @@ ipython==4.0.0 # Testing # ------------------------------------- -pytest==2.7.2 +pytest==2.8.0 git+git://github.com/mverteuil/pytest-ipdb.git diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 3348d10c6..5324037a1 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -11,7 +11,7 @@ whitenoise==2.0.3 # Forms django-braces==1.8.1 -django-crispy-forms==1.5.1 +django-crispy-forms==1.5.2 django-floppyforms==1.5.2 # Models diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index f9a5524f8..37d487179 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -15,7 +15,7 @@ ipdb==0.8.1 {% if cookiecutter.use_maildump == "y" -%} # Required by maildump. Need to pin dependency to gevent beta to be Python 3-compatible. -gevent==1.1b3 +gevent==1.1b5 # Enables better email testing maildump==0.5.1 {%- endif %} diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index 77d7d93fe..d403c7058 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -1,6 +1,6 @@ # Test dependencies go here. -r base.txt -coverage==4.0b2 +coverage==4.0b3 flake8==2.4.1 django-test-plus==1.0.9 factory_boy==2.5.2 diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index 681657210..ddb453bf8 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -2,13 +2,13 @@ click==5.1 colorama==0.3.3 faketime==0.9.6.3 hitchcron==0.2 -hitchpostgres==0.6.2 -hitchpython==0.3.4 -hitchredis==0.4.1 -hitchselenium==0.4 -hitchserve==0.4.3 +hitchpostgres==0.6.3 +hitchpython==0.3.5 +hitchredis==0.4.3 +hitchselenium==0.4.1 +hitchserve==0.4.4 hitchsmtp==0.2.1 -hitchtest==0.7.7 +hitchtest==0.8.0 humanize==0.5.1 ipython==4.0.0 Jinja2==2.8 @@ -19,7 +19,7 @@ python-build==0.2.3 pyuv==1.2.0 PyYAML==3.11 requests==2.7.0 -selenium==2.47.1 +selenium==2.47.3 six==1.9.0 tblib==1.1.0 tornado==4.2.1 From 0a8479925236c967d6546d4850f910d19dfbff2b Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Fri, 18 Sep 2015 15:27:56 -0700 Subject: [PATCH 079/402] Add dos, navbar fix, reqs update to changelog. --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3dcba2326..513a4f98d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-18] +### Changed +- Major reorganization of docs (@pydanny) +- Fix expanded navbar on mobile (@jayfk) +- Update various requirements (@audreyr) + ## [2015-09-17] ### Added - Fix for wsgi.py for Raven in dev (@yunti) From 379214348e48799d4f3965bc714921697c5673c5 Mon Sep 17 00:00:00 2001 From: Roman Afanaskin Date: Mon, 21 Sep 2015 22:36:06 +0300 Subject: [PATCH 080/402] Remove excess "loggers" from LOGGING setting --- .../config/settings/common.py | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index b74f72bae..575bb6fdf 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -260,15 +260,13 @@ LOGGING = { 'django.request': { 'handlers': ['mail_admins'], 'level': 'ERROR', - 'propagate': True, - }, - 'loggers': { - 'django.security.DisallowedHost': { - 'level': 'ERROR', - 'handlers': ['console', 'mail_admins'], - 'propagate': True, - }, + 'propagate': True }, + 'django.security.DisallowedHost': { + 'level': 'ERROR', + 'handlers': ['console', 'mail_admins'], + 'propagate': True + } } } {% if cookiecutter.use_celery == "y" %} From 4989efaeceab6834079984fb099a0e67ef4923c6 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Mon, 21 Sep 2015 15:54:13 -0700 Subject: [PATCH 081/402] Switch back to django-mailgun proper. As I'm now a maintainer, I feel confident that django-mailgun will be supported going forward. --- {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index 9910b5e96..e3546169a 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -17,7 +17,7 @@ Collectfast==0.2.3 # Mailgun Support # --------------- -django-mailgun-redux==0.3.0 +django-mailgun==0.6.0 {% if cookiecutter.use_sentry == "y" -%} # Raven is the Sentry client From 1da7e33007627cd150fb8c9ac0e6089470558679 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Mon, 21 Sep 2015 21:24:19 -0700 Subject: [PATCH 082/402] Add @siauPatrick to the contributors and changelog --- CHANGELOG.md | 6 ++++++ CONTRIBUTORS.txt | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 513a4f98d..a83883f4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-21] +### Changed +- django-mailgun-redux to django-mailgun, because @pydanny now has commit rights +### Removed +- Excess "loggers" from LOGGING setting (@siauPatrick) + ## [2015-09-18] ### Changed - Major reorganization of docs (@pydanny) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 471eda707..805d6bb05 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -46,13 +46,14 @@ Daniele Tricoli / @eriol Harry Percival / @hjwp Cullen Rhodes / @c-rhodes Burhan Khalid / @burhan -Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * +Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * Jannis Gebauer / @got_nil jayfk / @jayfk -stepmr / @stepmr +stepmr / @stepmr Adam Bogdał / @bogdal Barclay Gauld / @yunti Ian Lee / @IanLee1521 +Roman Afanaskin / @siauPatrick * Possesses commit rights From 7f9baab66b1c66ecb6f59c7bb27dd519446ede8a Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 22 Sep 2015 08:52:06 -0700 Subject: [PATCH 083/402] Add #336 to changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 513a4f98d..db040f5db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-17] +### Added +- Add Python version option for deployment (@yunti) + ## [2015-09-18] ### Changed - Major reorganization of docs (@pydanny) From 650d4f1dd21d1f75c8f9bb443e05a0c8f085e47e Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 22 Sep 2015 09:04:33 -0700 Subject: [PATCH 084/402] Copy mobile navbar fix from css to scss. --- .../static/sass/project.scss | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index 5352d3241..82a319fca 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -13,3 +13,20 @@ background-color: #f2dede; border-color: #eed3d7; } + +/* This is a fix for the bootstrap4 alpha release */ +@media (max-width: 47.9em) { + .navbar-nav .nav-item { + float: none; + width: 100%; + display: inline-block; + } + + .navbar-nav .nav-item + .nav-item { + margin-left: 0; + } + + .nav.navbar-nav.pull-right { + float: none !important; + } +} \ No newline at end of file From dc146fc0e89bd50509ebc75dfc3e85cecc678af2 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Tue, 22 Sep 2015 09:14:56 -0700 Subject: [PATCH 085/402] Update the Python3 in Dockerfile to 3.5 --- {{cookiecutter.repo_name}}/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index e1c875ff3..8810d8f98 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -1,5 +1,5 @@ {% if cookiecutter.use_python2 == 'n' -%} -FROM python:3.4 +FROM python:3.5 {% else %} FROM python:2.7 {%- endif %} From 97142763a6b543cc05ba832d98dbf0455ba50282 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Wed, 23 Sep 2015 23:53:33 -0700 Subject: [PATCH 086/402] Workaround for debug-toolbar conflict with Bootstrap 4. --- .../{{cookiecutter.repo_name}}/static/css/project.css | 8 ++++++++ .../{{cookiecutter.repo_name}}/static/sass/project.scss | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css index 78508b757..08505aeef 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css @@ -27,4 +27,12 @@ .nav.navbar-nav.pull-right { float: none !important; } +} + +/* Display django-debug-toolbar. + See https://github.com/django-debug-toolbar/django-debug-toolbar/issues/742 + and https://github.com/pydanny/cookiecutter-django/issues/317 +*/ +[hidden][style="display: block;"] { + display: block !important; } \ No newline at end of file diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index 82a319fca..a5e9fb99f 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -29,4 +29,12 @@ .nav.navbar-nav.pull-right { float: none !important; } +} + +/* Display django-debug-toolbar. + See https://github.com/django-debug-toolbar/django-debug-toolbar/issues/742 + and https://github.com/pydanny/cookiecutter-django/issues/317 +*/ +[hidden][style="display: block;"] { + display: block !important; } \ No newline at end of file From 8fa150a81f5cc445a1a0b3cdff58a2801df8a5b9 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 24 Sep 2015 00:33:33 -0700 Subject: [PATCH 087/402] Have flake8 ignore node_modules/ --- {{cookiecutter.repo_name}}/setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/setup.cfg b/{{cookiecutter.repo_name}}/setup.cfg index 51059eda1..e2bc1f401 100644 --- a/{{cookiecutter.repo_name}}/setup.cfg +++ b/{{cookiecutter.repo_name}}/setup.cfg @@ -1,4 +1,4 @@ [flake8] #ignore = E265 max-line-length = 120 -exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs +exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules From b642fed5bb73914e6fd5919810237c33a759553c Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 24 Sep 2015 00:38:04 -0700 Subject: [PATCH 088/402] Starter docs on our flake8 setup. --- docs/linters.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/linters.rst b/docs/linters.rst index 3349faed9..09d5744b5 100644 --- a/docs/linters.rst +++ b/docs/linters.rst @@ -2,3 +2,16 @@ Linters ======= .. index:: linters + + +flake8 +------- + +To run flake8: + + $ flake8 + +The config for flake8 is located in setup.cfg. It specifies: + +* Set max line length to 120 chars +* Exclude .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules From 9160a3443a198a29d342fcb358a7d662eab2311a Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 24 Sep 2015 00:39:42 -0700 Subject: [PATCH 089/402] Remove commented-out flake8 ignore rule. --- {{cookiecutter.repo_name}}/setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/setup.cfg b/{{cookiecutter.repo_name}}/setup.cfg index e2bc1f401..3084e4021 100644 --- a/{{cookiecutter.repo_name}}/setup.cfg +++ b/{{cookiecutter.repo_name}}/setup.cfg @@ -1,4 +1,3 @@ [flake8] -#ignore = E265 max-line-length = 120 exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules From 7c0e979ef3ce3d4ddc95b868824de816b887bc2a Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 24 Sep 2015 16:18:20 -0700 Subject: [PATCH 090/402] Update editorconfig to match existing project conventions for 2-space html, css, scss, json --- .editorconfig | 2 +- {{cookiecutter.repo_name}}/.editorconfig | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 517633b95..585e2abce 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,7 +12,7 @@ trim_trailing_whitespace = true indent_style = space indent_size = 4 -[*.yml] +[*.{html,css,scss,json,yml}] indent_style = space indent_size = 2 diff --git a/{{cookiecutter.repo_name}}/.editorconfig b/{{cookiecutter.repo_name}}/.editorconfig index e22324786..e7aa555a3 100644 --- a/{{cookiecutter.repo_name}}/.editorconfig +++ b/{{cookiecutter.repo_name}}/.editorconfig @@ -19,7 +19,7 @@ known_first_party={{ cookiecutter.repo_name }} multi_line_output=3 default_section=THIRDPARTY -[*.yml] +[*.{html,css,scss,json,yml}] indent_style = space indent_size = 2 From de4a717b9882558e44740882184b7b9971a52f0d Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 24 Sep 2015 16:19:38 -0700 Subject: [PATCH 091/402] Ignore user-uploaded media --- {{cookiecutter.repo_name}}/.gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore index 13567ebd0..de0584e32 100644 --- a/{{cookiecutter.repo_name}}/.gitignore +++ b/{{cookiecutter.repo_name}}/.gitignore @@ -55,3 +55,6 @@ node_modules/ # virtual environments .env + +# User-uploaded media +{{ cookiecutter.repo_name }}/media/ From 7c2777734b36f26f22a1d70467f3797e1cbe2656 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Fri, 25 Sep 2015 23:26:56 -0700 Subject: [PATCH 092/402] Updated django-mailgun requirement This not only has a nice feature, it also improves Python 3 support. --- {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index e3546169a..e3c05bba4 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -17,7 +17,7 @@ Collectfast==0.2.3 # Mailgun Support # --------------- -django-mailgun==0.6.0 +django-mailgun==0.7.2 {% if cookiecutter.use_sentry == "y" -%} # Raven is the Sentry client From 11f99c01bd5dec1ecc789cf54214661e678bdf56 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 25 Sep 2015 23:28:33 -0700 Subject: [PATCH 093/402] Changelog update --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 651869377..4b4055019 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-22] +### Changed +- django-mailgun requirement to 0.7.2 (@pydanny) +- Remove commented-out flake8 ignore rule. (@audreyr) + ## [2015-09-22] ### Added - Add Python version option for deployment (@yunti) From ee66f11e5e216e560604de68ecefb3dbe9e538a6 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:27:08 -0700 Subject: [PATCH 094/402] Sass linting. --- .../static/sass/project.scss | 36 ++++++++++++------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index a5e9fb99f..afa91d3da 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -2,24 +2,34 @@ // bootstrap alert CSS, translated to the django-standard levels of // debug, info, success, warning, error + +$alert-debug-bgcolor: #fff; +$alert-debug-border: #d6e9c6; +$alert-debug-color: #000; + +$alert-error-bgcolor: #f2dede; +$alert-error-border: #eed3d7; +$alert-error-color: #b94a48; + .alert-debug { - color: black; - background-color: white; - border-color: #d6e9c6; + background-color: $alert-debug-bgcolor; + border-color: $alert-debug-border; + color: $alert-debug-color; } .alert-error { - color: #b94a48; - background-color: #f2dede; - border-color: #eed3d7; + background-color: $alert-error-bgcolor; + border-color: $alert-error-border; + color: $alert-error-color; } -/* This is a fix for the bootstrap4 alpha release */ +// This is a fix for the bootstrap4 alpha release + @media (max-width: 47.9em) { .navbar-nav .nav-item { + display: inline-block; float: none; width: 100%; - display: inline-block; } .navbar-nav .nav-item + .nav-item { @@ -31,10 +41,10 @@ } } -/* Display django-debug-toolbar. - See https://github.com/django-debug-toolbar/django-debug-toolbar/issues/742 - and https://github.com/pydanny/cookiecutter-django/issues/317 -*/ +// Display django-debug-toolbar. +// See https://github.com/django-debug-toolbar/django-debug-toolbar/issues/742 +// and https://github.com/pydanny/cookiecutter-django/issues/317 + [hidden][style="display: block;"] { display: block !important; -} \ No newline at end of file +} From 5e1ea0940c8de9e3247e1e0e543a38556b39f69b Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:29:39 -0700 Subject: [PATCH 095/402] Sass alert improvements (better variables). --- .../static/sass/project.scss | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index afa91d3da..37c69e454 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -1,26 +1,27 @@ // project specific CSS goes here +// Alert colors + +$white: #fff; +$mint-green: #d6e9c6; +$black: #000; +$pink: #f2dede; +$dark-pink: #eed3d7; +$red: #b94a48; + // bootstrap alert CSS, translated to the django-standard levels of // debug, info, success, warning, error -$alert-debug-bgcolor: #fff; -$alert-debug-border: #d6e9c6; -$alert-debug-color: #000; - -$alert-error-bgcolor: #f2dede; -$alert-error-border: #eed3d7; -$alert-error-color: #b94a48; - .alert-debug { - background-color: $alert-debug-bgcolor; - border-color: $alert-debug-border; - color: $alert-debug-color; + background-color: $white; + border-color: $mint-green; + color: $black; } .alert-error { - background-color: $alert-error-bgcolor; - border-color: $alert-error-border; - color: $alert-error-color; + background-color: $pink; + border-color: $dark-pink; + color: $red; } // This is a fix for the bootstrap4 alpha release From 481bdb71b3ee836de67f5ba505bf2e8d16e74038 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:35:55 -0700 Subject: [PATCH 096/402] More linter documentation in prep for merging #283. --- docs/linters.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/linters.rst b/docs/linters.rst index 09d5744b5..21c849aa4 100644 --- a/docs/linters.rst +++ b/docs/linters.rst @@ -15,3 +15,17 @@ The config for flake8 is located in setup.cfg. It specifies: * Set max line length to 120 chars * Exclude .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules + +pylint +------ + +This is included in flake8's checks, but you can also run it separately to see a more detailed report: + + $ pylint + +pep8 +----- + +This is included in flake8's checks, but you can also run it separately to see a more detailed report: + + $ pep8 From 8facd2448dc1d4d128b845d9b1c428b7faaa9ffc Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:40:39 -0700 Subject: [PATCH 097/402] Better .pep8 excludes --- {{cookiecutter.repo_name}}/.pep8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/.pep8 b/{{cookiecutter.repo_name}}/.pep8 index 5c558cdd6..3996f1ae5 100644 --- a/{{cookiecutter.repo_name}}/.pep8 +++ b/{{cookiecutter.repo_name}}/.pep8 @@ -1,3 +1,3 @@ [pep8] max-line-length = 120 -exclude=*/migrations/* +exclude=.tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules From f0cc78f01f8b19180d163b52ce3d76a0e90806eb Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:47:44 -0700 Subject: [PATCH 098/402] Move .pep8 to setup.cfg. --- {{cookiecutter.repo_name}}/.pep8 | 3 --- {{cookiecutter.repo_name}}/setup.cfg | 4 ++++ 2 files changed, 4 insertions(+), 3 deletions(-) delete mode 100644 {{cookiecutter.repo_name}}/.pep8 diff --git a/{{cookiecutter.repo_name}}/.pep8 b/{{cookiecutter.repo_name}}/.pep8 deleted file mode 100644 index 3996f1ae5..000000000 --- a/{{cookiecutter.repo_name}}/.pep8 +++ /dev/null @@ -1,3 +0,0 @@ -[pep8] -max-line-length = 120 -exclude=.tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules diff --git a/{{cookiecutter.repo_name}}/setup.cfg b/{{cookiecutter.repo_name}}/setup.cfg index 3084e4021..c18b80d95 100644 --- a/{{cookiecutter.repo_name}}/setup.cfg +++ b/{{cookiecutter.repo_name}}/setup.cfg @@ -1,3 +1,7 @@ [flake8] max-line-length = 120 exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules + +[pep8] +max-line-length = 120 +exclude=.tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules From 42fe4f645b0a0ac1a95cd4eaba8872eb8ac4b8b5 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 00:50:54 -0700 Subject: [PATCH 099/402] Update pylint and pep8 docs. --- docs/linters.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/linters.rst b/docs/linters.rst index 21c849aa4..c2f76f352 100644 --- a/docs/linters.rst +++ b/docs/linters.rst @@ -23,9 +23,21 @@ This is included in flake8's checks, but you can also run it separately to see a $ pylint +The config for pylint is located in .pylintrc. It specifies: + +* Use the pylint_common and pylint_django plugins. If using Celery, also use pylint_celery. +* Set max line length to 120 chars +* Disable linting messages for missing docstring and invalid name +* max-parents=13 + pep8 ----- This is included in flake8's checks, but you can also run it separately to see a more detailed report: $ pep8 + +The config for pep8 is located in setup.cfg. It specifies: + +* Set max line length to 120 chars +* Exclude .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules \ No newline at end of file From 55e0895dc6b44b05fc929127a7a83155814fc1ce Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 01:06:18 -0700 Subject: [PATCH 100/402] Tons of changelog updates. --- CHANGELOG.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b4055019..0157a05f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,31 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -## [2015-09-22] +## [2015-09-26] +### Added +- Add .pylintrc and .pep8 (@kaidokert) + +### Changed +- Move pep8 rules to setup.cfg (@audreyr) +- Better pep8 rules for exclusion (@audreyr) +- Document all linters (@audreyr) +- Sass linting and improvements to alerts (@audreyr) + +## [2015-09-25] ### Changed - django-mailgun requirement to 0.7.2 (@pydanny) - Remove commented-out flake8 ignore rule. (@audreyr) +## [2015-09-24] +### Changed +- Add user-uploaded media dir to .gitignore (@audreyr) +- Update .editorconfig to use 2 spaces for html, css, scss, json (@audreyr) +- Have flake8 ignore node_modules dir (@audreyr) + +## [2015-09-23] +### Changed +- Add workaround for django-debug-toolbar conflict with Bootstrap 4 (@audreyr) + ## [2015-09-22] ### Added - Add Python version option for deployment (@yunti) From 598bf20826fb9a0642b5ea28ffdfd6b725065dcd Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 26 Sep 2015 01:08:04 -0700 Subject: [PATCH 101/402] Add @kaidokert to contributors list. --- CONTRIBUTORS.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 805d6bb05..ee289588d 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -54,6 +54,7 @@ Adam Bogdał / @bogdal Barclay Gauld / @yunti Ian Lee / @IanLee1521 Roman Afanaskin / @siauPatrick +@kaidokert * Possesses commit rights From 73c19f6046556cd9d1ef7885249c095273a35fda Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sat, 26 Sep 2015 10:36:16 +0200 Subject: [PATCH 102/402] Rename CONTRIBUTORS.txt to rst --- CONTRIBUTORS.txt => CONTRIBUTORS.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTORS.txt => CONTRIBUTORS.rst (100%) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.rst similarity index 100% rename from CONTRIBUTORS.txt rename to CONTRIBUTORS.rst From 900385c0da9a29b5c5bc2771b0deb4930f25d1af Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sat, 26 Sep 2015 10:47:21 +0200 Subject: [PATCH 103/402] Add rst bullet points to CONTRIBUTORS.rst --- CONTRIBUTORS.rst | 116 +++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index ee289588d..d779f16f8 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -1,68 +1,68 @@ Code Contributors ================= -Daniel Greenfeld* -a7p -Lukas Klein -Ben Lopatin -Bouke Haarsma -Agam Dua -Vitaly Babiy -Jim Munro* -Tom Offermann -Lyla Fischer -Taylor Baldwin -Chris Curvey (@ccurvey) -Fábio C. Barrionuevo da Luz (@luzfcb)* -Saurabh Kumar (gh: theskumar / @_theskumar)* -Ashley Camba -Yaroslav Halchenko -Pablo / @oubiga -Tom Atkins / @knitatoms -Julio Castillo / @juliocc -Kevin A. Stone -mozillazg / @mozillazg -Henrique G. G. Pereira / @ikkebr -Travis McNeill / gh: Tavistock / @tavistock_esq -Matt Linares -Russell Davies -Sławek Ehlert / @slafs -Alberto Sanchez / @alb3rto -Eyad Al Sibai / @eyadsibai -Chris Franklin -Benjamin Abel -Felipe Arruda / @arruda -Matt Warren / @mfwarren -Martin Blech -Andy Rose -Andrew Mikhnevich / @zcho -Kevin Ndung'u / @kevgathuku -Kaveh / @ka7eh -Alex Tsai / @caffodian -Garry Cairns / @garry-cairns -Lin Xianyi / @iynaix -Adam Dobrawy / @ad-m -Daniele Tricoli / @eriol -Harry Percival / @hjwp -Cullen Rhodes / @c-rhodes -Burhan Khalid / @burhan -Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * -Jannis Gebauer / @got_nil -jayfk / @jayfk -stepmr / @stepmr -Adam Bogdał / @bogdal -Barclay Gauld / @yunti -Ian Lee / @IanLee1521 -Roman Afanaskin / @siauPatrick -@kaidokert +* Daniel Greenfeld* +* a7p +* Lukas Klein +* Ben Lopatin +* Bouke Haarsma +* Agam Dua +* Vitaly Babiy +* Jim Munro* +* Tom Offermann +* Lyla Fischer +* Taylor Baldwin +* Chris Curvey (@ccurvey) +* Fábio C. Barrionuevo da Luz (@luzfcb)* +* Saurabh Kumar (gh: theskumar / @_theskumar)* +* Ashley Camba +* Yaroslav Halchenko +* Pablo / @oubiga +* Tom Atkins / @knitatoms +* Julio Castillo / @juliocc +* Kevin A. Stone +* mozillazg / @mozillazg +* Henrique G. G. Pereira / @ikkebr +* Travis McNeill / gh: Tavistock / @tavistock_esq +* Matt Linares +* Russell Davies +* Sławek Ehlert / @slafs +* Alberto Sanchez / @alb3rto +* Eyad Al Sibai / @eyadsibai +* Chris Franklin +* Benjamin Abel +* Felipe Arruda / @arruda +* Matt Warren / @mfwarren +* Martin Blech +* Andy Rose +* Andrew Mikhnevich / @zcho +* Kevin Ndung'u / @kevgathuku +* Kaveh / @ka7eh +* Alex Tsai / @caffodian +* Garry Cairns / @garry-cairns +* Lin Xianyi / @iynaix +* Adam Dobrawy / @ad-m +* Daniele Tricoli / @eriol +* Harry Percival / @hjwp +* Cullen Rhodes / @c-rhodes +* Burhan Khalid / @burhan +* Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * +* Jannis Gebauer / @got_nil +* jayfk / @jayfk +* stepmr / @stepmr +* Adam Bogdał / @bogdal +* Barclay Gauld / @yunti +* Ian Lee / @IanLee1521 +* Roman Afanaskin / @siauPatrick +* @kaidokert -* Possesses commit rights +\* Possesses commit rights Special Thanks ============== The following haven't provided code directly, but have provided guidance and advice. -Jannis Leidel (django-configurations) -Nate Aune -Barry Morrison +* Jannis Leidel (django-configurations) +* Nate Aune +* Barry Morrison From 81878429710f1ccb7c17e821b3e1e42e8455e95c Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sat, 26 Sep 2015 11:01:56 +0200 Subject: [PATCH 104/402] Add a blank before core committer mark to be consistent --- CONTRIBUTORS.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index d779f16f8..192451942 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -1,20 +1,20 @@ Code Contributors ================= -* Daniel Greenfeld* +* Daniel Greenfeld * * a7p * Lukas Klein * Ben Lopatin * Bouke Haarsma * Agam Dua * Vitaly Babiy -* Jim Munro* +* Jim Munro * * Tom Offermann * Lyla Fischer * Taylor Baldwin * Chris Curvey (@ccurvey) -* Fábio C. Barrionuevo da Luz (@luzfcb)* -* Saurabh Kumar (gh: theskumar / @_theskumar)* +* Fábio C. Barrionuevo da Luz (@luzfcb) * +* Saurabh Kumar (gh: theskumar / @_theskumar) * * Ashley Camba * Yaroslav Halchenko * Pablo / @oubiga From 17b3814193dfef970d53a3ec038e93f82694d547 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sat, 26 Sep 2015 11:07:49 +0200 Subject: [PATCH 105/402] Add @hackebrot to contributors --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 192451942..48e8fe141 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -55,6 +55,7 @@ Code Contributors * Ian Lee / @IanLee1521 * Roman Afanaskin / @siauPatrick * @kaidokert +* Raphael Pierzina / @hackebrot \* Possesses commit rights From bdd916835e1bad1f2a97191d1ffcf35b0c3a8ecc Mon Sep 17 00:00:00 2001 From: "Alvaro [Andor]" Date: Sun, 27 Sep 2015 19:42:21 +0200 Subject: [PATCH 106/402] Fixed reStructuredText (RST) format The lack of a space between the '::' tag and the text did that the block around the code didn't appear. --- docs/developing-locally-docker.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 41a09b479..897a5699c 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -64,6 +64,7 @@ This can take a while, especially the first time you run this particular command on your development system. :: + $ docker-compose build Boot the System From d8a7081d4cfb3af0fc689aba17b2cf9c8f741eda Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Mon, 28 Sep 2015 09:42:13 +0200 Subject: [PATCH 107/402] Added advice on how to persist changes with boot2docker --- docs/developing-locally-docker.rst | 39 +++++++++++++++++------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 41a09b479..42782f4ae 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -57,6 +57,28 @@ Acquiring the IP Address is good for two reasons: $ docker-machine ip dev1 123.456.789.012 +Saving changes +-------------- + +If you are using OS X or Windows, you need to create a /data partition inside the +virtual machine that runs the docker deamon in order make all changes persistent. +If you don't do that your /data directory will get wiped out on every reboot. + +To create a persistent folder, log into the virtual machine by running: + +:: + + $ docker-machine ssh dev1 + $ sudo su + $ echo 'ln -sfn /mnt/sda1/data /data' >> /var/lib/boot2docker/bootlocal.sh + + +In case you are wondering why you can't use a host volume to keep the files on +your mac: As of `boot2docker` 1.7 you'll run into permission problems with mounted +host volumes if the container creates his own user and chown's the directories +on the volume. Postgres is doing that, so we need this quick fix to ensure that +all development data persists. + Build the Stack --------------- @@ -130,20 +152,3 @@ To migrate your app and to create a superuser, run:: $ docker-compose run django python manage.py migrate $ docker-compose run django python manage.py createsuperuser - - -If you are using `boot2docker` to develop on OS X or Windows, you need to create a `/data` partition inside your boot2docker -vm to make all changes persistent. If you don't do that your `/data` directory will get wiped out on every reboot. - -To create a persistent folder, log into the `boot2docker` vm by running:: - - $ bootdocker ssh - -And then:: - - $ sudo su - $ echo 'ln -sfn /mnt/sda1/data /data' >> /var/lib/boot2docker/bootlocal.sh - -In case you are wondering why you can't use a host volume to keep the files on your mac: As of `boot2docker` 1.7 you'll -run into permission problems with mounted host volumes if the container creates his own user and chown's the directories -on the volume. Postgres is doing that, so we need this quick fix to ensure that all development data persists. From ba85552732e165de2db7182d8827cfb403a99a44 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Mon, 28 Sep 2015 09:42:35 +0200 Subject: [PATCH 108/402] Removed duplicate --- CONTRIBUTORS.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 48e8fe141..f33ead5fc 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -47,8 +47,7 @@ Code Contributors * Cullen Rhodes / @c-rhodes * Burhan Khalid / @burhan * Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * -* Jannis Gebauer / @got_nil -* jayfk / @jayfk +* Jannis Gebauer / @jayfk * * stepmr / @stepmr * Adam Bogdał / @bogdal * Barclay Gauld / @yunti From 2b5e8c1a1be8d3fc97ea3da98d4398e42db84d3f Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Mon, 28 Sep 2015 09:43:20 +0200 Subject: [PATCH 109/402] Added recent changes to contributors & boot2docker --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0157a05f4..cfe01c3ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-27] +### Added +- Added advice on how to persist changes with boot2docker (@jayfk) + +###Changed +- Removed duplicate from `CONTRIBUTORS.rst` (@jayfk) + ## [2015-09-26] ### Added - Add .pylintrc and .pep8 (@kaidokert) From 8b38a1229e03eb446a6ef0363b5c634620d26c6a Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 29 Sep 2015 11:13:13 -0700 Subject: [PATCH 110/402] Add @andor-pierdelacabeza to contributors. Add #350 to changelog. --- CHANGELOG.md | 4 ++++ CONTRIBUTORS.rst | 1 + 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cfe01c3ec..b5bd8cb18 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-29] +### Changed +- Fix RST in Docker docs (@andor-pierdelacabeza) + ## [2015-09-27] ### Added - Added advice on how to persist changes with boot2docker (@jayfk) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index f33ead5fc..172667b86 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -55,6 +55,7 @@ Code Contributors * Roman Afanaskin / @siauPatrick * @kaidokert * Raphael Pierzina / @hackebrot +* Alvaro [Andor] / @andor-pierdelacabeza \* Possesses commit rights From 25326d5560816e16e3cef2b8f62da01003d08884 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Wed, 30 Sep 2015 10:37:46 +0200 Subject: [PATCH 111/402] added pyflakes and pep8 to requirements (used for testing) --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements.txt b/requirements.txt index c08cd1733..a37aed2b7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,3 +11,5 @@ ipython==4.0.0 # ------------------------------------- pytest==2.8.0 git+git://github.com/mverteuil/pytest-ipdb.git +pep8==1.6.2 +pyflakes==1.0.0 From b465ccc9b26bdf6f06cfc3f72df2cbdb01c597e4 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Wed, 30 Sep 2015 10:39:25 +0200 Subject: [PATCH 112/402] fix sentry logging in conjunction with celery --- .../{{cookiecutter.repo_name}}/taskapp/celery.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index 8155204ab..f5b65d77f 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -4,6 +4,10 @@ import os from celery import Celery from django.apps import AppConfig from django.conf import settings +{% if cookiecutter.use_sentry == "y" -%} +from raven import Client +from raven.contrib.celery import register_signal +{%- endif %} if not settings.configured: # set the default Django settings module for the 'celery' program. @@ -23,6 +27,13 @@ class CeleryConfig(AppConfig): app.config_from_object('django.conf:settings') app.autodiscover_tasks(lambda: settings.INSTALLED_APPS, force=True) + {% if cookiecutter.use_sentry == "y" -%} + if hasattr(settings, 'RAVEN_CONFIG'): + # Celery signal registration + client = Client(dsn=settings.RAVEN_CONFIG['dsn']) + register_signal(client) + {%- endif %} + @app.task(bind=True) def debug_task(self): From b75bdf5faa7796b591f0f5c031cc113cd021a8dc Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Wed, 30 Sep 2015 10:40:09 +0200 Subject: [PATCH 113/402] fixed sentry logging, added testing requirements --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b5bd8cb18..56a91c2b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-09-30] +### Changed +- Fixed Sentry logging with celery (@jayfk) +- Added pep8 and pyflakes to requirements (@jayfk) + ## [2015-09-29] ### Changed - Fix RST in Docker docs (@andor-pierdelacabeza) From 5150f0ec2d127e349876916a7fff04f455dee18f Mon Sep 17 00:00:00 2001 From: Roman Afanaskin Date: Wed, 30 Sep 2015 18:13:16 +0300 Subject: [PATCH 114/402] String view arguments to url() is deprecated in django 1.9 --- {{cookiecutter.repo_name}}/config/urls.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/urls.py b/{{cookiecutter.repo_name}}/config/urls.py index 106445512..8cf2596d3 100644 --- a/{{cookiecutter.repo_name}}/config/urls.py +++ b/{{cookiecutter.repo_name}}/config/urls.py @@ -6,6 +6,7 @@ from django.conf.urls import include, url from django.conf.urls.static import static from django.contrib import admin from django.views.generic import TemplateView +from django.views import defaults as default_views urlpatterns = [ url(r'^$', TemplateView.as_view(template_name='pages/home.html'), name="home"), @@ -27,8 +28,8 @@ if settings.DEBUG: # This allows the error pages to be debugged during development, just visit # these url in browser to see how these error pages look like. urlpatterns += [ - url(r'^400/$', 'django.views.defaults.bad_request'), - url(r'^403/$', 'django.views.defaults.permission_denied'), - url(r'^404/$', 'django.views.defaults.page_not_found'), - url(r'^500/$', 'django.views.defaults.server_error'), + url(r'^400/$', default_views.bad_request), + url(r'^403/$', default_views.permission_denied), + url(r'^404/$', default_views.page_not_found), + url(r'^500/$', default_views.server_error), ] From 50ff5810bef59279ad5a380b4629913bdeba38be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 30 Sep 2015 12:59:51 -0300 Subject: [PATCH 115/402] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56a91c2b9..352ed0881 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Fixed Sentry logging with celery (@jayfk) - Added pep8 and pyflakes to requirements (@jayfk) +- Fixed url() arguments in urls.py because String view arguments to url() is deprecated in django 1.9 (@siauPatrick) ## [2015-09-29] ### Changed From 0fb5f5d854336ccb365eaf5cc7e0c85ef557270b Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Wed, 30 Sep 2015 15:10:12 -0300 Subject: [PATCH 116/402] Update version of requirements cookiecutter, coverage, django-environ, django-extensions, hitchpython, hitchselenium, hitchserve, pytest, pytz, whitenoise --- requirements.txt | 4 ++-- {{cookiecutter.repo_name}}/requirements/base.txt | 6 +++--- {{cookiecutter.repo_name}}/requirements/local.txt | 4 ++-- {{cookiecutter.repo_name}}/requirements/test.txt | 2 +- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 6 +++--- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/requirements.txt b/requirements.txt index a37aed2b7..2f2756096 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -cookiecutter==1.0.0 +cookiecutter==1.1.0 flake8==2.4.1 sh @@ -9,7 +9,7 @@ ipython==4.0.0 # Testing # ------------------------------------- -pytest==2.8.0 +pytest==2.8.1 git+git://github.com/mverteuil/pytest-ipdb.git pep8==1.6.2 pyflakes==1.0.0 diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 5324037a1..88561d5d2 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -2,10 +2,10 @@ django==1.8.4 # Configuration -django-environ==0.3.0 +django-environ==0.4.0 django-secure==1.0.1 {% if cookiecutter.use_whitenoise == 'y' -%} -whitenoise==2.0.3 +whitenoise==2.0.4 {%- endif %} @@ -32,7 +32,7 @@ unicode-slugify==0.1.3 django-autoslug==1.8.0 # Time zones support -pytz==2015.4 +pytz==2015.6 # Redis support django-redis==4.2.0 diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 37d487179..2ed754bc6 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,8 +1,8 @@ # Local development dependencies go here -r base.txt -coverage==3.7.1 +coverage==4.0 Sphinx -django-extensions==1.5.6 +django-extensions==1.5.7 Werkzeug==0.10.4 django-test-plus==1.0.9 factory_boy==2.5.2 diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index d403c7058..f2896ab73 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -1,6 +1,6 @@ # Test dependencies go here. -r base.txt -coverage==4.0b3 +coverage==4.0 flake8==2.4.1 django-test-plus==1.0.9 factory_boy==2.5.2 diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index ddb453bf8..740b349fb 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -3,10 +3,10 @@ colorama==0.3.3 faketime==0.9.6.3 hitchcron==0.2 hitchpostgres==0.6.3 -hitchpython==0.3.5 +hitchpython==0.3.8 hitchredis==0.4.3 -hitchselenium==0.4.1 -hitchserve==0.4.4 +hitchselenium==0.4.3 +hitchserve==0.4.5 hitchsmtp==0.2.1 hitchtest==0.8.0 humanize==0.5.1 From 376cf9382abf22e658c45bbca295caead60083a9 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Wed, 30 Sep 2015 15:11:42 -0300 Subject: [PATCH 117/402] Update 'now' date in cookiecutter.json --- cookiecutter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookiecutter.json b/cookiecutter.json index 09dcd42ee..f214fad19 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -7,7 +7,7 @@ "domain_name": "example.com", "version": "0.1.0", "timezone": "UTC", - "now": "2015/01/13", + "now": "2015/09/30", "year": "{{ cookiecutter.now[:4] }}", "use_whitenoise": "y", "use_celery": "n", From a1fff49481bfdd0874cd94b863ba63ca4770397f Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Wed, 30 Sep 2015 15:12:38 -0300 Subject: [PATCH 118/402] Update the usage example --- README.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 72b8713f6..5bde07f5c 100644 --- a/README.rst +++ b/README.rst @@ -98,14 +98,15 @@ It prompts you for questions. Answer them:: description [A short description of the project.]: A reddit clone. domain_name [example.com]: myreddit.com version [0.1.0]: 0.0.1 - timezone [UTC]: - now [2015/01/13]: 2015/08/30 - year [2015]: + timezone [UTC]: + now [2015/01/13]: 2015/09/30 + year [2015]: use_whitenoise [y]: n use_celery [n]: y - use_maildump [n]: y + use_maildump [n]: n use_sentry [n]: y - windows [n]: + windows [n]: n + use_python2 [n]: y Enter the project and take a look around:: From 8a7ecb0ca74a4e3376eb3bc79dcaedd6f3e94244 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Wed, 30 Sep 2015 15:13:20 -0300 Subject: [PATCH 119/402] update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 352ed0881..808b5d738 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Fixed Sentry logging with celery (@jayfk) - Added pep8 and pyflakes to requirements (@jayfk) - Fixed url() arguments in urls.py because String view arguments to url() is deprecated in django 1.9 (@siauPatrick) +- Update version of cookiecutter, coverage, django-environ, django-extensions, hitchpython, hitchselenium, hitchserve, pytest, pytz, whitenoise (@luzfcb) +- Update the usage example in README (@luzfcb) +- Update 'now' date in cookiecutter.json (@luzfcb) ## [2015-09-29] ### Changed From 25e0fe1baa9a624f04f4638ec93ff2eb0e8394e7 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 14:09:43 -0700 Subject: [PATCH 120/402] Spread the word about twoscoops.academy --- README.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 5bde07f5c..28d1b4453 100644 --- a/README.rst +++ b/README.rst @@ -98,9 +98,9 @@ It prompts you for questions. Answer them:: description [A short description of the project.]: A reddit clone. domain_name [example.com]: myreddit.com version [0.1.0]: 0.0.1 - timezone [UTC]: - now [2015/01/13]: 2015/09/30 - year [2015]: + timezone [UTC]: + now [2015/01/13]: 2015/09/30 + year [2015]: use_whitenoise [y]: n use_celery [n]: y use_maildump [n]: n @@ -132,6 +132,13 @@ For development, see the following for local development: .. _`Developing locally`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally.html .. _`Developing locally using docker`: http://cookiecutter-django.readthedocs.org/en/latest/developing-locally-docker.html +Support This Project +--------------------------- + +Spread the word about `Two Scoops Academy`_. + +.. _`Two Scoops Academy`: http://www.twoscoops.academy/ + For Readers of Two Scoops of Django 1.8 -------------------------------------------- From bf98d7340b9e651ab3a3a69db6253d7723b48fcc Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 14:12:58 -0700 Subject: [PATCH 121/402] Support this projecy --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 28d1b4453..f0972d7a1 100644 --- a/README.rst +++ b/README.rst @@ -135,9 +135,13 @@ For development, see the following for local development: Support This Project --------------------------- -Spread the word about `Two Scoops Academy`_. +This project is maintained by volunteers. Support their efforts by spreading the word about: -.. _`Two Scoops Academy`: http://www.twoscoops.academy/ +.. image:: https://s3.amazonaws.com/tsacademy/images/tsa-logo-250x60-transparent-01.png + :name: Two Scoops Academy + :align: center + :alt: Two Scoops Academy + :target: http://www.twoscoops.academy/ For Readers of Two Scoops of Django 1.8 -------------------------------------------- From 58ec2fe113ac00172380fc9704e49589f747833e Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 14:54:29 -0700 Subject: [PATCH 122/402] URL to django.contrib.admin is now configurable --- docs/deployment-on-heroku.rst | 1 + docs/settings.rst | 1 + {{cookiecutter.repo_name}}/config/settings/common.py | 4 ++++ {{cookiecutter.repo_name}}/config/settings/production.py | 4 ++++ {{cookiecutter.repo_name}}/config/urls.py | 4 ++-- {{cookiecutter.repo_name}}/env.example | 3 ++- 6 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index 6ee99fee2..2190ba827 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -16,6 +16,7 @@ You can either push the 'deploy' button in your generated README.rst or run thes heroku addons:create heroku-redis:hobby-dev heroku addons:create mailgun + heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' diff --git a/docs/settings.rst b/docs/settings.rst index 0c36df1cd..6364ea4b2 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -9,6 +9,7 @@ For configuration purposes, the following table maps environment variables to th ======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default ======================================= =========================== ============================================== ====================================================================== +DJANGO_ADMIN_URL n/a r'^admin/' raises error DJANGO_CACHES CACHES (default) locmem redis DJANGO_DATABASES DATABASES (default) See code See code DJANGO_DEBUG DEBUG True False diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index 575bb6fdf..194420103 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -277,4 +277,8 @@ INSTALLED_APPS += ('kombu.transport.django',) BROKER_URL = env("CELERY_BROKER_URL", default='django://') ########## END CELERY {% endif %} + +# Location of root django.contrib.admin URL, use {% url 'admin:index' %} +ADMIN_URL = r'^admin/' + # Your common stuff: Below this line define 3rd party library settings diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 7c9fc4006..ba9c533ea 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -217,4 +217,8 @@ RAVEN_CONFIG = { 'DSN': SENTRY_DSN } {% endif %} + +# Custom Admin URL, use {% url 'admin:index' %} +ADMIN_URL = env('ADMIN_URL') + # Your production stuff: Below this line define 3rd party library settings diff --git a/{{cookiecutter.repo_name}}/config/urls.py b/{{cookiecutter.repo_name}}/config/urls.py index 8cf2596d3..c2afcc633 100644 --- a/{{cookiecutter.repo_name}}/config/urls.py +++ b/{{cookiecutter.repo_name}}/config/urls.py @@ -12,8 +12,8 @@ urlpatterns = [ url(r'^$', TemplateView.as_view(template_name='pages/home.html'), name="home"), url(r'^about/$', TemplateView.as_view(template_name='pages/about.html'), name="about"), - # Django Admin - url(r'^admin/', include(admin.site.urls)), + # Django Admin, use {% url 'admin:index' %} + url(settings.ADMIN_URL, include(admin.site.urls)), # User management url(r'^users/', include("{{ cookiecutter.repo_name }}.users.urls", namespace="users")), diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index 381a3cf0b..eb2a1529f 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -1,6 +1,7 @@ POSTGRES_PASSWORD=mysecretpass POSTGRES_USER=postgresuser +ADMIN_URL= DJANGO_SETTINGS_MODULE=config.settings.production DJANGO_SECRET_KEY= DJANGO_ALLOWED_HOSTS= @@ -10,4 +11,4 @@ DJANGO_AWS_STORAGE_BUCKET_NAME= DJANGO_MAILGUN_API_KEY= DJANGO_MAILGUN_SERVER_NAME= DJANGO_SERVER_EMAIL= -DJANGO_SECURE_SSL_REDIRECT=False \ No newline at end of file +DJANGO_SECURE_SSL_REDIRECT=False From ab62fdb4acbf0bfcb84431127f10f631a923edd0 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 14:58:09 -0700 Subject: [PATCH 123/402] Obfuscating the Django admin URL on Heroku --- docs/deployment-on-heroku.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index 2190ba827..ef6dee596 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -16,7 +16,7 @@ You can either push the 'deploy' button in your generated README.rst or run thes heroku addons:create heroku-redis:hobby-dev heroku addons:create mailgun - heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` + heroku config:set DJANGO_ADMIN_URL=`openssl rand -base64 32` heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' From 6dbf4e88d6eef9f6b8ecfb38b6bf44c294f89393 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 15:01:35 -0700 Subject: [PATCH 124/402] Add the DJANGO_ADMIN_URL to app.json --- {{cookiecutter.repo_name}}/app.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/{{cookiecutter.repo_name}}/app.json b/{{cookiecutter.repo_name}}/app.json index 1af80c5d0..92358ffa3 100644 --- a/{{cookiecutter.repo_name}}/app.json +++ b/{{cookiecutter.repo_name}}/app.json @@ -12,6 +12,10 @@ "description": "Comma-separated list of hosts", "value": ".herokuapp.com" }, + "DJANGO_ADMIN_URL": { + "description": "A secret URL for the Django admin", + "generator": "secret" + }, "DJANGO_AWS_ACCESS_KEY_ID": "", "DJANGO_AWS_SECRET_ACCESS_KEY": "", "DJANGO_AWS_STORAGE_BUCKET_NAME": "", From 606e1de1572ff12ed7331b487859184ec0df86da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Sat, 3 Oct 2015 19:35:27 -0300 Subject: [PATCH 125/402] escape admin url usage example in comment --- {{cookiecutter.repo_name}}/config/urls.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/urls.py b/{{cookiecutter.repo_name}}/config/urls.py index c2afcc633..8afe9c069 100644 --- a/{{cookiecutter.repo_name}}/config/urls.py +++ b/{{cookiecutter.repo_name}}/config/urls.py @@ -12,7 +12,7 @@ urlpatterns = [ url(r'^$', TemplateView.as_view(template_name='pages/home.html'), name="home"), url(r'^about/$', TemplateView.as_view(template_name='pages/about.html'), name="about"), - # Django Admin, use {% url 'admin:index' %} + # Django Admin, use {% raw %}{% url 'admin:index' %}{% endraw %} url(settings.ADMIN_URL, include(admin.site.urls)), # User management From 9b34bf16ecc7843962cc4524f8f67554d46399e7 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 15:42:33 -0700 Subject: [PATCH 126/402] Fixing the build --- {{cookiecutter.repo_name}}/config/settings/common.py | 2 +- {{cookiecutter.repo_name}}/config/settings/production.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index 194420103..836f099e0 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -278,7 +278,7 @@ BROKER_URL = env("CELERY_BROKER_URL", default='django://') ########## END CELERY {% endif %} -# Location of root django.contrib.admin URL, use {% url 'admin:index' %} +# Location of root django.contrib.admin URL, use {% raw %}{% url 'admin:index' %}{% endraw %} ADMIN_URL = r'^admin/' # Your common stuff: Below this line define 3rd party library settings diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index ba9c533ea..144b07ee4 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -218,7 +218,7 @@ RAVEN_CONFIG = { } {% endif %} -# Custom Admin URL, use {% url 'admin:index' %} +# Custom Admin URL, use {% raw %}{% url 'admin:index' %}{% endraw %} ADMIN_URL = env('ADMIN_URL') # Your production stuff: Below this line define 3rd party library settings From 4781c2baa2e7cbc4b77f5059559eed9df937853a Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 15:58:49 -0700 Subject: [PATCH 127/402] Flake8 fix --- {{cookiecutter.repo_name}}/config/settings/production.py | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 144b07ee4..436286591 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -217,7 +217,6 @@ RAVEN_CONFIG = { 'DSN': SENTRY_DSN } {% endif %} - # Custom Admin URL, use {% raw %}{% url 'admin:index' %}{% endraw %} ADMIN_URL = env('ADMIN_URL') From 6258583fb15730e47dc81e0e47d6b12244ed4014 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:15:02 -0700 Subject: [PATCH 128/402] Docker Toolbox includes Virtualbox. No need to repeat. --- docs/developing-locally-docker.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index ee6305456..d8a998503 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -16,7 +16,6 @@ Prerequisites If you don't already have these installed, you can get them at: * https://github.com/docker/toolbox/releases -* https://www.virtualbox.org/wiki/Downloads Go to the Root of your Project ------------------------------ From 606b026a8ca009c4ecaadd55a1d0b610779b730f Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:21:08 -0700 Subject: [PATCH 129/402] Simplify docs and un-deprecate the part that's still valid. --- docs/developing-locally-docker.rst | 43 ++++++++++++------------------ 1 file changed, 17 insertions(+), 26 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index d8a998503..132bcb0a6 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -4,6 +4,7 @@ Getting Up and Running with Docker .. index:: Docker The steps below will get you up and running with a local development environment. +All of these commands assume you are in the root of your generated project. Prerequisites -------------- @@ -17,11 +18,6 @@ If you don't already have these installed, you can get them at: * https://github.com/docker/toolbox/releases -Go to the Root of your Project ------------------------------- - -All of these commands assume you are in the root of your generated project. - Create the Machine ------------------- @@ -33,15 +29,6 @@ Create the Machine name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject', 'djangopackages', et al. -Make the new machine the active unit -------------------------------------- - -This tells our computer that all future commands are specifically for the just -created machine. Using the ``eval`` command we can switch machines as needed. - -:: - - $ eval "$(docker-machine env dev1)" Get the IP Address -------------------- @@ -122,17 +109,8 @@ Example: $ docker-compose run django python manage.py createsuperuser - -Deprecated -========== - -**Note:** This segment of documentation is being kept in this location as part of our documentation transition process. - - -The steps below will get you up and running with a local development environment. We assume you have the following installed: - -* docker -* docker-compose +Working With Your Container +----------------------------- Open a terminal at the project root and run the following for local development:: @@ -146,9 +124,22 @@ And then run:: $ docker-compose up - To migrate your app and to create a superuser, run:: $ docker-compose run django python manage.py migrate $ docker-compose run django python manage.py createsuperuser + + +Other Useful Tips +------------------ + +Make a machine the active unit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This tells our computer that all future commands are specifically for the dev1 machine. +Using the ``eval`` command we can switch machines as needed. + +:: + + $ eval "$(docker-machine env dev1)" From 765bb32fbe11ecdd3b7c631b29e9bd7c7ae85c11 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:35:48 -0700 Subject: [PATCH 130/402] Simplify redundant parts of docker-compose instructions. --- docs/developing-locally-docker.rst | 43 +++++++++++++----------------- 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 132bcb0a6..809a796d5 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -75,28 +75,6 @@ on your development system. $ docker-compose build -Boot the System ------------------------------- - -This brings up both Django and PostgreSQL. The first time it is run it might -take a while to get started, but subsequent runs will occur quickly. - -:: - - $ docker-compose -f dev.yml up - -If you want to run the entire system in production mode, then run: - -:: - - $ docker-compose up - -If you want to run the stack in detached mode (in the background), use the ``-d`` argument:: - -:: - - $ docker-compose up -d - Running bash commands (i.e. management commands) ---------------------------------------------------- @@ -108,9 +86,13 @@ Example: $ docker-compose run django python manage.py migrate $ docker-compose run django python manage.py createsuperuser +Boot the System +--------------- -Working With Your Container ------------------------------ +This brings up both Django and PostgreSQL. + +The first time it is run it might take a while to get started, but subsequent +runs will occur quickly. Open a terminal at the project root and run the following for local development:: @@ -130,6 +112,10 @@ To migrate your app and to create a superuser, run:: $ docker-compose run django python manage.py createsuperuser +Production Mode +~~~~~~~~~~~~~~~~ + +Instead of using `dev.yml`, you would use `docker-compose.yml`. Other Useful Tips ------------------ @@ -143,3 +129,12 @@ Using the ``eval`` command we can switch machines as needed. :: $ eval "$(docker-machine env dev1)" + +Detached Mode +~~~~~~~~~~~~~ + +If you want to run the stack in detached mode (in the background), use the ``-d`` argument:: + +:: + + $ docker-compose up -d \ No newline at end of file From c9b4d1f16ef6a1797a4e521aec3b5ab92d0e6075 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:44:43 -0700 Subject: [PATCH 131/402] Unify docker-compose run sections. --- docs/developing-locally-docker.rst | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 809a796d5..fa3e670c4 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -69,23 +69,10 @@ Build the Stack --------------- This can take a while, especially the first time you run this particular command -on your development system. - -:: +on your development system:: $ docker-compose build -Running bash commands (i.e. management commands) ----------------------------------------------------- - -This is done using the ``docker-compose run`` command. In the following examples -we specify the ``django`` container as the location to run our management commands. - -Example: - - $ docker-compose run django python manage.py migrate - $ docker-compose run django python manage.py createsuperuser - Boot the System --------------- @@ -105,13 +92,20 @@ You can also set the environment variable ``COMPOSE_FILE`` pointing to ``dev.yml And then run:: $ docker-compose up + +Running management commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As with any shell command that we wish to run in our container, this is done +using the ``docker-compose run`` command. To migrate your app and to create a superuser, run:: $ docker-compose run django python manage.py migrate - $ docker-compose run django python manage.py createsuperuser +Here we specify the ``django`` container as the location to run our management commands. + Production Mode ~~~~~~~~~~~~~~~~ From 2d609432b916735d20018bde7b2f3ebcd973aba7 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:54:01 -0700 Subject: [PATCH 132/402] Add @jayfk's note from #356. --- docs/developing-locally-docker.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index fa3e670c4..ec7686f1a 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -18,10 +18,14 @@ If you don't already have these installed, you can get them at: * https://github.com/docker/toolbox/releases -Create the Machine -------------------- +Create the Machine (Optional) +------------------------------- -:: +On Ubuntu you have native Docker, so you don't need to create a VM with +docker-machine to use it. + +However, on Mac/Windows/other systems without native Docker, you'll want to +start by creating a VM with docker-machine:: $ docker-machine create --driver virtualbox dev1 @@ -29,7 +33,6 @@ Create the Machine name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject', 'djangopackages', et al. - Get the IP Address -------------------- From d09abc8d86370eabf5efd6650150f216ae735efc Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:56:53 -0700 Subject: [PATCH 133/402] More simplification. --- docs/developing-locally-docker.rst | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index ec7686f1a..0568d5d14 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -36,16 +36,13 @@ name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject', Get the IP Address -------------------- -Acquiring the IP Address is good for two reasons: - -1. Confirms that the machine is up and running. -2. Tells us the IP address where our Django project is being served. - -:: +Once your machine is up and running, run this:: $ docker-machine ip dev1 123.456.789.012 +This is also the IP address where the Django project will be served from. + Saving changes -------------- @@ -53,15 +50,12 @@ If you are using OS X or Windows, you need to create a /data partition inside th virtual machine that runs the docker deamon in order make all changes persistent. If you don't do that your /data directory will get wiped out on every reboot. -To create a persistent folder, log into the virtual machine by running: - -:: +To create a persistent folder, log into the virtual machine by running:: $ docker-machine ssh dev1 $ sudo su $ echo 'ln -sfn /mnt/sda1/data /data' >> /var/lib/boot2docker/bootlocal.sh - In case you are wondering why you can't use a host volume to keep the files on your mac: As of `boot2docker` 1.7 you'll run into permission problems with mounted host volumes if the container creates his own user and chown's the directories From d19ddbcf1e2ee048cf7ce0db73577ca095e6053f Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 16:59:52 -0700 Subject: [PATCH 134/402] Explain Docker Toolbox better. --- docs/developing-locally-docker.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 0568d5d14..145eda5ea 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -9,14 +9,14 @@ All of these commands assume you are in the root of your generated project. Prerequisites -------------- +If you don't already have these installed, get them all by installing `Docker Toolbox`_. + * docker * docker-machine * docker-compose * virtualbox -If you don't already have these installed, you can get them at: - -* https://github.com/docker/toolbox/releases +.. _`Docker Toolbox`: https://github.com/docker/toolbox/releases Create the Machine (Optional) ------------------------------- From a6e10f6600489a122158aeec38bb7f7ca40203db Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 3 Oct 2015 17:08:11 -0700 Subject: [PATCH 135/402] Correct production name --- {{cookiecutter.repo_name}}/config/settings/production.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 436286591..e21bc59b9 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -218,6 +218,6 @@ RAVEN_CONFIG = { } {% endif %} # Custom Admin URL, use {% raw %}{% url 'admin:index' %}{% endraw %} -ADMIN_URL = env('ADMIN_URL') +ADMIN_URL = env('DJANGO_ADMIN_URL') # Your production stuff: Below this line define 3rd party library settings From e23e9ceb7e4bed319ee75b4364711913a3e6937b Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 3 Oct 2015 20:06:33 -0700 Subject: [PATCH 136/402] Multiple Dockerfiles. Implementation of #360. --- {{cookiecutter.repo_name}}/Dockerfile | 6 ++---- {{cookiecutter.repo_name}}/Dockerfile-dev | 25 +++++++++++++++++++++++ {{cookiecutter.repo_name}}/dev.yml | 2 ++ 3 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 {{cookiecutter.repo_name}}/Dockerfile-dev diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index 8810d8f98..b7933b216 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -6,11 +6,9 @@ FROM python:2.7 ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work -ADD ./requirements /requirements -ADD ./requirements.txt /requirements.txt +ADD ./requirements/production.txt /requirements/production.txt -RUN pip install -r /requirements.txt -RUN pip install -r /requirements/local.txt +RUN pip install -r /requirements/production.txt RUN groupadd -r django && useradd -r -g django django ADD . /app diff --git a/{{cookiecutter.repo_name}}/Dockerfile-dev b/{{cookiecutter.repo_name}}/Dockerfile-dev new file mode 100644 index 000000000..6f6d061b9 --- /dev/null +++ b/{{cookiecutter.repo_name}}/Dockerfile-dev @@ -0,0 +1,25 @@ +{% if cookiecutter.use_python2 == 'n' -%} +FROM python:3.5 +{% else %} +FROM python:2.7 +{%- endif %} +ENV PYTHONUNBUFFERED 1 + +# Requirements have to be pulled and installed here, otherwise caching won't work +ADD ./requirements/local.txt /requirements/local.txt + +RUN pip install -r /requirements/local.txt + +RUN groupadd -r django && useradd -r -g django django +ADD . /app +RUN chown -R django /app + +ADD ./compose/django/gunicorn.sh /gunicorn.sh +ADD ./compose/django/entrypoint.sh /entrypoint.sh + +RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh +RUN chmod +x /gunicorn.sh && chown django /gunicorn.sh + +WORKDIR /app + +ENTRYPOINT ["/entrypoint.sh"] diff --git a/{{cookiecutter.repo_name}}/dev.yml b/{{cookiecutter.repo_name}}/dev.yml index 98146ffed..4993ef759 100644 --- a/{{cookiecutter.repo_name}}/dev.yml +++ b/{{cookiecutter.repo_name}}/dev.yml @@ -1,3 +1,5 @@ +dockerfile: Dockerfile-dev + postgres: image: postgres volumes: From faa534b3c1b96fb0f24725e6fc39bccf2dae8ff5 Mon Sep 17 00:00:00 2001 From: Jay Date: Sun, 4 Oct 2015 12:13:42 +0200 Subject: [PATCH 137/402] Enhances #360 --- {{cookiecutter.repo_name}}/Dockerfile | 2 +- {{cookiecutter.repo_name}}/Dockerfile-dev | 2 +- {{cookiecutter.repo_name}}/dev.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index b7933b216..2a038555b 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -6,7 +6,7 @@ FROM python:2.7 ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work -ADD ./requirements/production.txt /requirements/production.txt +ADD ./requirements /requirements RUN pip install -r /requirements/production.txt diff --git a/{{cookiecutter.repo_name}}/Dockerfile-dev b/{{cookiecutter.repo_name}}/Dockerfile-dev index 6f6d061b9..f382b9133 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile-dev +++ b/{{cookiecutter.repo_name}}/Dockerfile-dev @@ -6,7 +6,7 @@ FROM python:2.7 ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work -ADD ./requirements/local.txt /requirements/local.txt +ADD ./requirements /requirements RUN pip install -r /requirements/local.txt diff --git a/{{cookiecutter.repo_name}}/dev.yml b/{{cookiecutter.repo_name}}/dev.yml index 4993ef759..63b172d39 100644 --- a/{{cookiecutter.repo_name}}/dev.yml +++ b/{{cookiecutter.repo_name}}/dev.yml @@ -1,4 +1,3 @@ -dockerfile: Dockerfile-dev postgres: image: postgres @@ -8,6 +7,7 @@ postgres: - /data/{{cookiecutter.repo_name}}/postgres:/var/lib/postgresql/data django: + dockerfile: Dockerfile-dev build: . command: python /app/manage.py runserver_plus 0.0.0.0:8000 volumes: From c0c0bc6ca3a5a1de3ea5837edb1816a2177cb3ef Mon Sep 17 00:00:00 2001 From: Amjith Ramanujam Date: Sun, 4 Oct 2015 05:06:20 -0700 Subject: [PATCH 138/402] Add newrelic for monitoring. --- README.rst | 3 +++ cookiecutter.json | 1 + {{cookiecutter.repo_name}}/app.json | 3 ++- {{cookiecutter.repo_name}}/config/settings/production.py | 5 +++++ {{cookiecutter.repo_name}}/config/wsgi.py | 9 +++++++++ {{cookiecutter.repo_name}}/requirements/production.txt | 6 ++++++ 6 files changed, 26 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f0972d7a1..c4cbc1465 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,7 @@ Features * Pre configured Celery_ (optional) * Integration with Maildump_ for local email testing (optional) * Integration with Sentry_ for error logging (optional) +* Integration with NewRelic_ for performance monitoring (optional) * Docker support using docker-compose_ for dev and prod * Procfile_ for deploying to Heroku @@ -53,6 +54,7 @@ Features .. _Celery: http://www.celeryproject.org/ .. _Maildump: https://github.com/ThiefMaster/maildump .. _Sentry: https://getsentry.com +.. _NewRelic: https://newrelic.com .. _docker-compose: https://www.github.com/docker/compose @@ -105,6 +107,7 @@ It prompts you for questions. Answer them:: use_celery [n]: y use_maildump [n]: n use_sentry [n]: y + use_newrelic [n]: y windows [n]: n use_python2 [n]: y diff --git a/cookiecutter.json b/cookiecutter.json index f214fad19..5bbcdc12f 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -13,6 +13,7 @@ "use_celery": "n", "use_maildump": "n", "use_sentry": "n", + "use_newrelic": "n", "windows": "n", "use_python2": "n" } diff --git a/{{cookiecutter.repo_name}}/app.json b/{{cookiecutter.repo_name}}/app.json index 92358ffa3..eb2bd723b 100644 --- a/{{cookiecutter.repo_name}}/app.json +++ b/{{cookiecutter.repo_name}}/app.json @@ -21,7 +21,8 @@ "DJANGO_AWS_STORAGE_BUCKET_NAME": "", "DJANGO_MAILGUN_SERVER_NAME": "", "DJANGO_MAILGUN_API_KEY": ""{% if cookiecutter.use_sentry == "y" -%}, - "DJANGO_SENTRY_DSN": ""{%- endif %} + "DJANGO_SENTRY_DSN": ""{%- endif %}{% if cookiecutter.use_newrelic == "y -%"}, + "NEW_RELIC_LICENSE_KEY": ""{%- endif %} }, "scripts": { "postdeploy": "python manage.py migrate" diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index e21bc59b9..edcf74a54 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -131,6 +131,11 @@ MAILGUN_SERVER_NAME = env('DJANGO_MAILGUN_SERVER_NAME') EMAIL_SUBJECT_PREFIX = env("DJANGO_EMAIL_SUBJECT_PREFIX", default='[{{cookiecutter.project_name}}] ') SERVER_EMAIL = env('DJANGO_SERVER_EMAIL', default=DEFAULT_FROM_EMAIL) +{% if cookiecutter.use_newrelic == 'y'-%} +NEW_RELIC_LICENSE_KEY = env('NEW_RELIC_LICENSE_KEY') +{%- endif %} + + # TEMPLATE CONFIGURATION # ------------------------------------------------------------------------------ # See: diff --git a/{{cookiecutter.repo_name}}/config/wsgi.py b/{{cookiecutter.repo_name}}/config/wsgi.py index 697aa5b31..9f2df6cf5 100644 --- a/{{cookiecutter.repo_name}}/config/wsgi.py +++ b/{{cookiecutter.repo_name}}/config/wsgi.py @@ -15,6 +15,11 @@ framework. """ import os +{% if cookiecutter.use_newrelic == "y" -%} +if os.environ.get("DJANGO_SETTINGS_MODULE") == "config.settings.production": + import newrelic.agent + newrelic.agent.initialize() +{%- endif %} from django.core.wsgi import get_wsgi_application {% if cookiecutter.use_whitenoise == 'y' -%} from whitenoise.django import DjangoWhiteNoise @@ -44,6 +49,10 @@ application = DjangoWhiteNoise(application) if os.environ.get("DJANGO_SETTINGS_MODULE") == "config.settings.production": application = Sentry(application) {%- endif %} +{% if cookiecutter.use_newrelic == "y" -%} +if os.environ.get("DJANGO_SETTINGS_MODULE") == "config.settings.production": + application = newrelic.agent.WSGIApplicationWrapper(application) +{%- endif %} # Apply WSGI middleware here. # from helloworld.wsgi import HelloWorldApplication diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index e3c05bba4..a27fb8fa1 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -24,3 +24,9 @@ django-mailgun==0.7.2 # -------------------------- raven {%- endif %} + +{% if cookiecutter.use_newrelic == "y" -%} +# Newrelic agent for performance monitoring +# ----------------------------------------- +newrelic +{%- endif %} From c35d759b74212434d6ee1bd318c611242ce6e922 Mon Sep 17 00:00:00 2001 From: Amjith Ramanujam Date: Sun, 4 Oct 2015 05:51:09 -0700 Subject: [PATCH 139/402] Fix the template syntax error. --- {{cookiecutter.repo_name}}/app.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/app.json b/{{cookiecutter.repo_name}}/app.json index eb2bd723b..495770c78 100644 --- a/{{cookiecutter.repo_name}}/app.json +++ b/{{cookiecutter.repo_name}}/app.json @@ -20,9 +20,11 @@ "DJANGO_AWS_SECRET_ACCESS_KEY": "", "DJANGO_AWS_STORAGE_BUCKET_NAME": "", "DJANGO_MAILGUN_SERVER_NAME": "", + {% if cookiecutter.use_newrelic == "y" -%} + "NEW_RELIC_LICENSE_KEY": "", + {%- endif %} "DJANGO_MAILGUN_API_KEY": ""{% if cookiecutter.use_sentry == "y" -%}, - "DJANGO_SENTRY_DSN": ""{%- endif %}{% if cookiecutter.use_newrelic == "y -%"}, - "NEW_RELIC_LICENSE_KEY": ""{%- endif %} + "DJANGO_SENTRY_DSN": ""{%- endif %} }, "scripts": { "postdeploy": "python manage.py migrate" From 694bbb2e810408c9224c07b74fdfd1b02c515801 Mon Sep 17 00:00:00 2001 From: Chris Franklin Date: Sun, 4 Oct 2015 15:44:06 +0100 Subject: [PATCH 140/402] Fixes #363 - Remove stray closing tags, fix navbar margin Removes stray tags that don't seem like they should be there. Reduces topbar bottom margin because it looked bad. --- .../{{cookiecutter.repo_name}}/templates/base.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 50944cd2c..0931ca8fb 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -31,7 +31,7 @@ -
+
{% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html index 51e75a10b..fcd746ef6 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html @@ -39,7 +39,7 @@ {% if redirect_field_value %} {% endif %} - + {% trans "Forgot Password?" %}
diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html index 7fb21cf06..c8f1c75df 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html @@ -21,7 +21,7 @@ {% if redirect_field_value %} {% endif %} - +
diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 0931ca8fb..147daa323 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -51,8 +51,8 @@ {% trans "My Profile" %} {% trans "Logout" %} {% else %} - {% trans "Sign Up" %} - {% trans "Log In" %} + {% trans "Sign Up" %} + {% trans "Log In" %} {% endif %}
From f01cddeae691ff015879a1a658c677a8288560f0 Mon Sep 17 00:00:00 2001 From: Saurabh Kumar Date: Thu, 22 Oct 2015 00:19:24 +0530 Subject: [PATCH 166/402] fix requirement, update django-autoslug to 1.9.3 Thanks @cdvv7788 / @aniketmaithani --- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index c94ee52d7..1ebdac4b0 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -34,7 +34,7 @@ psycopg2==2.6.1 # Unicode slugification unicode-slugify==0.1.3 -django-autoslug==1.9.2 +django-autoslug==1.9.3 # Time zones support pytz==2015.6 From 676739332adda9986ace626ef864deec2783d9ea Mon Sep 17 00:00:00 2001 From: Saurabh Kumar Date: Thu, 22 Oct 2015 00:24:18 +0530 Subject: [PATCH 167/402] Update requirement, coverage, factory-boy --- {{cookiecutter.repo_name}}/requirements/local.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 3906fc918..ea6663f89 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,11 +1,11 @@ # Local development dependencies go here -r base.txt -coverage==4.0 +coverage==4.0.1 Sphinx django-extensions==1.5.7 Werkzeug==0.10.4 django-test-plus==1.0.9 -factory_boy==2.5.2 +factory_boy==2.6.0 # django-debug-toolbar that works with Django 1.5+ django-debug-toolbar==1.4 From 2b550a75d5fec2b53747ab9fbb5cd56dd22dd358 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Wed, 21 Oct 2015 13:19:08 -0700 Subject: [PATCH 168/402] removed isort link --- {{cookiecutter.repo_name}}/.editorconfig | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/.editorconfig b/{{cookiecutter.repo_name}}/.editorconfig index e7aa555a3..78c90f9c7 100644 --- a/{{cookiecutter.repo_name}}/.editorconfig +++ b/{{cookiecutter.repo_name}}/.editorconfig @@ -13,7 +13,6 @@ indent_style = space indent_size = 4 [*.py] -# https://github.com/timothycrosley/isort/wiki/isort-Settings line_length=120 known_first_party={{ cookiecutter.repo_name }} multi_line_output=3 From 3d6169c2b9ec73db5eb1c1d52b5ff2ceb90a1d7b Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 22 Oct 2015 12:35:55 -0700 Subject: [PATCH 169/402] Use COPY instead of ADD as per https://docs.docker.com/articles/dockerfile_best-practices/#add-or-copy --- {{cookiecutter.repo_name}}/Dockerfile | 8 ++++---- {{cookiecutter.repo_name}}/Dockerfile-dev | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile b/{{cookiecutter.repo_name}}/Dockerfile index 2a038555b..08d43f619 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile +++ b/{{cookiecutter.repo_name}}/Dockerfile @@ -6,16 +6,16 @@ FROM python:2.7 ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work -ADD ./requirements /requirements +COPY ./requirements /requirements RUN pip install -r /requirements/production.txt RUN groupadd -r django && useradd -r -g django django -ADD . /app +COPY . /app RUN chown -R django /app -ADD ./compose/django/gunicorn.sh /gunicorn.sh -ADD ./compose/django/entrypoint.sh /entrypoint.sh +COPY ./compose/django/gunicorn.sh /gunicorn.sh +COPY ./compose/django/entrypoint.sh /entrypoint.sh RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh RUN chmod +x /gunicorn.sh && chown django /gunicorn.sh diff --git a/{{cookiecutter.repo_name}}/Dockerfile-dev b/{{cookiecutter.repo_name}}/Dockerfile-dev index f382b9133..7f9985baa 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile-dev +++ b/{{cookiecutter.repo_name}}/Dockerfile-dev @@ -6,16 +6,16 @@ FROM python:2.7 ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work -ADD ./requirements /requirements +COPY ./requirements /requirements RUN pip install -r /requirements/local.txt RUN groupadd -r django && useradd -r -g django django -ADD . /app +COPY . /app RUN chown -R django /app -ADD ./compose/django/gunicorn.sh /gunicorn.sh -ADD ./compose/django/entrypoint.sh /entrypoint.sh +COPY ./compose/django/gunicorn.sh /gunicorn.sh +COPY ./compose/django/entrypoint.sh /entrypoint.sh RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh RUN chmod +x /gunicorn.sh && chown django /gunicorn.sh From f9f4876e1154526cea7f2bb0b5fb9298d2a7ab67 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 22 Oct 2015 12:37:14 -0700 Subject: [PATCH 170/402] Remove unnecessary gitkeep. Already another file in that dir. --- .../{{cookiecutter.repo_name}}/static/images/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 {{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/images/.gitkeep diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/images/.gitkeep b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/images/.gitkeep deleted file mode 100644 index e69de29bb..000000000 From e852bfe5b94b5d43366b7797d49a5eebf61e5294 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 22 Oct 2015 12:42:53 -0700 Subject: [PATCH 171/402] Update history. Add TODOs for @pydanny and @theskumar to update for your changes :bell: --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b55e1f88..076a5e57b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-22] +### Removed +- Remove unnecessary .gitkeep in static/images/ (@audreyr) + +## [2015-10-21] +### Changed +- TODO (@pydanny) +- TODO (@theskumar) + ## [2015-10-19] ### Changed - On Windows, don't install psycopg2 locally. Still install it in test/prod which are assumed to be Unix. (@audreyr) From 571530dd09653e401ae29d1b2d5e04a20bdd4b32 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 24 Oct 2015 19:22:08 +0200 Subject: [PATCH 172/402] removed unused commands from development dockerfile --- {{cookiecutter.repo_name}}/Dockerfile-dev | 8 -------- 1 file changed, 8 deletions(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile-dev b/{{cookiecutter.repo_name}}/Dockerfile-dev index 7f9985baa..b2c87d2c8 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile-dev +++ b/{{cookiecutter.repo_name}}/Dockerfile-dev @@ -7,18 +7,10 @@ ENV PYTHONUNBUFFERED 1 # Requirements have to be pulled and installed here, otherwise caching won't work COPY ./requirements /requirements - RUN pip install -r /requirements/local.txt -RUN groupadd -r django && useradd -r -g django django -COPY . /app -RUN chown -R django /app - -COPY ./compose/django/gunicorn.sh /gunicorn.sh COPY ./compose/django/entrypoint.sh /entrypoint.sh - RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh -RUN chmod +x /gunicorn.sh && chown django /gunicorn.sh WORKDIR /app From fe497c6dd0327110329099c80cf220faa3d8a9ec Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 24 Oct 2015 19:23:43 +0200 Subject: [PATCH 173/402] move development postgres data volume to /data/dev to avoid conflicts with production volume --- {{cookiecutter.repo_name}}/dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/dev.yml b/{{cookiecutter.repo_name}}/dev.yml index ffb40a0cb..d50959d24 100644 --- a/{{cookiecutter.repo_name}}/dev.yml +++ b/{{cookiecutter.repo_name}}/dev.yml @@ -3,7 +3,7 @@ postgres: volumes: # If you are using boot2docker, postgres data has to live in the VM for now until #581 is fixed # for more info see here: https://github.com/boot2docker/boot2docker/issues/581 - - /data/{{cookiecutter.repo_name}}/postgres:/var/lib/postgresql/data + - /data/dev/{{cookiecutter.repo_name}}/postgres:/var/lib/postgresql/data django: dockerfile: Dockerfile-dev From fc54af7b158023011af5d54c43ec839e1c47d634 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 24 Oct 2015 19:25:46 +0200 Subject: [PATCH 174/402] use REDIS_URL instead of DJANGO_CACHE_URL, fixes #379 --- {{cookiecutter.repo_name}}/compose/django/entrypoint.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/compose/django/entrypoint.sh b/{{cookiecutter.repo_name}}/compose/django/entrypoint.sh index 8c07a6411..ffae90097 100644 --- a/{{cookiecutter.repo_name}}/compose/django/entrypoint.sh +++ b/{{cookiecutter.repo_name}}/compose/django/entrypoint.sh @@ -4,7 +4,7 @@ set -e # Since docker-compose relies heavily on environment variables itself for configuration, we'd have to define multiple # environment variables just to support cookiecutter out of the box. That makes no sense, so this little entrypoint # does all this for us. -export DJANGO_CACHE_URL=redis://redis:6379/0 +export REDIS_URL=redis://redis:6379/0 # the official postgres image uses 'postgres' as default user if not set explictly. if [ -z "$POSTGRES_ENV_POSTGRES_USER" ]; then @@ -13,6 +13,6 @@ fi export DATABASE_URL=postgres://$POSTGRES_ENV_POSTGRES_USER:$POSTGRES_ENV_POSTGRES_PASSWORD@postgres:5432/$POSTGRES_ENV_POSTGRES_USER {% if cookiecutter.use_celery == 'y' %} -export CELERY_BROKER_URL=$DJANGO_CACHE_URL +export CELERY_BROKER_URL=$REDIS_URL {% endif %} exec "$@" \ No newline at end of file From 8fe03fe5531c0981d9b7b5a8c931f91590c0cd84 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 24 Oct 2015 19:27:04 +0200 Subject: [PATCH 175/402] no need to chown the file --- {{cookiecutter.repo_name}}/Dockerfile-dev | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/Dockerfile-dev b/{{cookiecutter.repo_name}}/Dockerfile-dev index b2c87d2c8..f07fe36a1 100644 --- a/{{cookiecutter.repo_name}}/Dockerfile-dev +++ b/{{cookiecutter.repo_name}}/Dockerfile-dev @@ -10,7 +10,7 @@ COPY ./requirements /requirements RUN pip install -r /requirements/local.txt COPY ./compose/django/entrypoint.sh /entrypoint.sh -RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh +RUN chmod +x /entrypoint.sh WORKDIR /app From 683872bc207cec7377cbff4043d0b5832c3b3385 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 24 Oct 2015 19:38:06 +0200 Subject: [PATCH 176/402] added the docker related changes from @audreyr and @jayfk --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 076a5e57b..194d0177e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-24] +### Changed +- Replaced ADD with COPY in dockerfiles (@audreyr) +- Simplified development dockerfile (@jayfk) +- Moved the docker postgres volume on the development environment to it's own subfolder (@jayfk) +- Renamed DJANGO_CACHE_URL to REDIS_URL (@jayfk / proposed by @pydanny) + ## [2015-10-22] ### Removed - Remove unnecessary .gitkeep in static/images/ (@audreyr) From d04a59fbe87aadc6ee9f84c0774e7b1e87e18716 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sat, 24 Oct 2015 20:31:36 -0500 Subject: [PATCH 177/402] Update nav in base template to latest Bootstrap 4 version. --- CHANGELOG.md | 1 + .../templates/base.html | 38 ++++++++++++------- 2 files changed, 26 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 194d0177e..79806011a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-24] ### Changed +- Update nav in base template to latest Bootstrap 4 version (@audreyr) - Replaced ADD with COPY in dockerfiles (@audreyr) - Simplified development dockerfile (@jayfk) - Moved the docker postgres volume on the development environment to it's own subfolder (@jayfk) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 0931ca8fb..a30c03c08 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -30,31 +30,43 @@ - +
From 0351c29295a5a6175a3da8242337126834ac4051 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 25 Oct 2015 08:36:20 -0700 Subject: [PATCH 178/402] Added so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. --- CHANGELOG.md | 8 ++++++-- setup.py | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 setup.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 79806011a..79c19d62e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-25] +- Added `setup.py` so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. + ## [2015-10-24] ### Changed - Update nav in base template to latest Bootstrap 4 version (@audreyr) @@ -16,8 +19,9 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-21] ### Changed -- TODO (@pydanny) -- TODO (@theskumar) +- Updated requirements (@theskumar) +### Removed +- editorconfig comment that was just a isort settings link (@pydanny) ## [2015-10-19] ### Changed diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..2e2652aae --- /dev/null +++ b/setup.py @@ -0,0 +1,54 @@ +#!/usr/bin/env python + +import os +import platform +import sys + +try: + from setuptools import setup +except ImportError: + from distutils.core import setup + +version = "1.0" + +if sys.argv[-1] == 'tag': + os.system("git tag -a %s -m 'version %s'" % (version, version)) + os.system("git push --tags") + sys.exit() + +with open('README.rst') as readme_file: + long_description = readme_file.read() + +setup( + name='cookiecutter-django', + version=version, + description='A Cookiecutter template for creating production-ready Django projects quickly.', + long_description=long_description, + author='Daniel Roy Greenfeld', + author_email='pydanny@gmail.com', + url='https://github.com/pydanny/cookiecutter-django', + packages=[], + license='BSD', + zip_safe=False, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Console', + 'Framework :: Django :: 1.8', + 'Intended Audience :: Developers', + 'Natural Language :: English', + 'License :: OSI Approved :: BSD License', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Software Development', + ], + keywords=( + 'cookiecutter, Python, projects, project templates, django, ' + 'skeleton, scaffolding, project directory, setup.py' + ), +) From b76f402541a4d1eb7e2582dd804f3b4f4946b86f Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 25 Oct 2015 09:29:43 -0700 Subject: [PATCH 179/402] Added version and tagging policy --- CHANGELOG.md | 4 +++- setup.py | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 79c19d62e..e3fb8232d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,9 @@ All enhancements and patches to cookiecutter-django will be documented in this f This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-25] -- Added `setup.py` so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. +### Added +- `setup.py` so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. (@pydanny) +- Versioning and tagging policy (@pydanny) ## [2015-10-24] ### Changed diff --git a/setup.py b/setup.py index 2e2652aae..2d7bfee29 100644 --- a/setup.py +++ b/setup.py @@ -9,7 +9,9 @@ try: except ImportError: from distutils.core import setup -version = "1.0" +# Our version ALWAYS matches the version of Django we support +# If Django has a new release, we branch, tag, then update this setting after the tag. +version = "1.8.5" if sys.argv[-1] == 'tag': os.system("git tag -a %s -m 'version %s'" % (version, version)) From 0c80d91112bd9910b6b214cafde9a8cc9b64a325 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 25 Oct 2015 09:30:19 -0700 Subject: [PATCH 180/402] Version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2d7bfee29..31edec6c4 100644 --- a/setup.py +++ b/setup.py @@ -33,7 +33,7 @@ setup( license='BSD', zip_safe=False, classifiers=[ - 'Development Status :: 5 - Production/Stable', + 'Development Status :: 4 - Beta', 'Environment :: Console', 'Framework :: Django :: 1.8', 'Intended Audience :: Developers', From 8307e43d15b5f20d9f0d7e5f88a30a97ed73b67c Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Sun, 25 Oct 2015 17:30:36 -0500 Subject: [PATCH 181/402] Move LOGGING setting to production from common, since it's not useful locally. --- CHANGELOG.md | 1 + .../config/settings/common.py | 48 ------------------- .../config/settings/production.py | 48 +++++++++++++++++++ 3 files changed, 49 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3fb8232d..66e36ee70 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-25] ### Added +- Move current logging config into production.py since it's not useful locally anyway. Used only if not using Sentry. (@audreyr) - `setup.py` so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. (@pydanny) - Versioning and tagging policy (@pydanny) diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index 836f099e0..a0389349b 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -221,54 +221,6 @@ LOGIN_URL = 'account_login' # SLUGLIFIER AUTOSLUG_SLUGIFY_FUNCTION = 'slugify.slugify' - -# LOGGING CONFIGURATION -# ------------------------------------------------------------------------------ -# See: https://docs.djangoproject.com/en/dev/ref/settings/#logging -# A sample logging configuration. The only tangible logging -# performed by this configuration is to send an email to -# the site admins on every HTTP 500 error when DEBUG=False. -# See http://docs.djangoproject.com/en/dev/topics/logging for -# more details on how to customize your logging configuration. -LOGGING = { - 'version': 1, - 'disable_existing_loggers': False, - 'filters': { - 'require_debug_false': { - '()': 'django.utils.log.RequireDebugFalse' - } - }, - 'formatters': { - 'verbose': { - 'format': '%(levelname)s %(asctime)s %(module)s ' - '%(process)d %(thread)d %(message)s' - }, - }, - 'handlers': { - 'mail_admins': { - 'level': 'ERROR', - 'filters': ['require_debug_false'], - 'class': 'django.utils.log.AdminEmailHandler' - }, - 'console': { - 'level': 'DEBUG', - 'class': 'logging.StreamHandler', - 'formatter': 'verbose', - }, - }, - 'loggers': { - 'django.request': { - 'handlers': ['mail_admins'], - 'level': 'ERROR', - 'propagate': True - }, - 'django.security.DisallowedHost': { - 'level': 'ERROR', - 'handlers': ['console', 'mail_admins'], - 'propagate': True - } - } -} {% if cookiecutter.use_celery == "y" %} ########## CELERY INSTALLED_APPS += ('{{cookiecutter.repo_name}}.taskapp.celery.CeleryConfig',) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index e21bc59b9..2a14ae9d2 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -216,6 +216,54 @@ RAVEN_CONFIG = { 'CELERY_LOGLEVEL': env.int('DJANGO_SENTRY_LOG_LEVEL', logging.INFO), 'DSN': SENTRY_DSN } +{% elif cookiecutter.use_sentry == "n" %} +# LOGGING CONFIGURATION +# ------------------------------------------------------------------------------ +# See: https://docs.djangoproject.com/en/dev/ref/settings/#logging +# A sample logging configuration. The only tangible logging +# performed by this configuration is to send an email to +# the site admins on every HTTP 500 error when DEBUG=False. +# See http://docs.djangoproject.com/en/dev/topics/logging for +# more details on how to customize your logging configuration. +LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'filters': { + 'require_debug_false': { + '()': 'django.utils.log.RequireDebugFalse' + } + }, + 'formatters': { + 'verbose': { + 'format': '%(levelname)s %(asctime)s %(module)s ' + '%(process)d %(thread)d %(message)s' + }, + }, + 'handlers': { + 'mail_admins': { + 'level': 'ERROR', + 'filters': ['require_debug_false'], + 'class': 'django.utils.log.AdminEmailHandler' + }, + 'console': { + 'level': 'DEBUG', + 'class': 'logging.StreamHandler', + 'formatter': 'verbose', + }, + }, + 'loggers': { + 'django.request': { + 'handlers': ['mail_admins'], + 'level': 'ERROR', + 'propagate': True + }, + 'django.security.DisallowedHost': { + 'level': 'ERROR', + 'handlers': ['console', 'mail_admins'], + 'propagate': True + } + } +} {% endif %} # Custom Admin URL, use {% raw %}{% url 'admin:index' %}{% endraw %} ADMIN_URL = env('DJANGO_ADMIN_URL') From 084fb2529e28d60f328efaa1e107389409f72699 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 25 Oct 2015 17:37:34 -0700 Subject: [PATCH 182/402] Fixed flake8 issue --- CHANGELOG.md | 1 + {{cookiecutter.repo_name}}/config/settings/common.py | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66e36ee70..05ca170e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Move current logging config into production.py since it's not useful locally anyway. Used only if not using Sentry. (@audreyr) - `setup.py` so we can list it on PyPI and therefore displayed on djangopackages.com as compatible with Python 3. (@pydanny) - Versioning and tagging policy (@pydanny) +- Fixed flake8 issue (@pydanny) ## [2015-10-24] ### Changed diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index a0389349b..a0ab6063e 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -220,7 +220,6 @@ LOGIN_URL = 'account_login' # SLUGLIFIER AUTOSLUG_SLUGIFY_FUNCTION = 'slugify.slugify' - {% if cookiecutter.use_celery == "y" %} ########## CELERY INSTALLED_APPS += ('{{cookiecutter.repo_name}}.taskapp.celery.CeleryConfig',) From 7a304981cd1ae3790cf31fcc9ef23c2e392a8117 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 27 Oct 2015 23:01:10 -0500 Subject: [PATCH 183/402] Add #378 to changelog. --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 05ca170e5..baa80010f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-27] +### Added +- Added sudo: true to the travis file (@MathijsHoogland) + ## [2015-10-25] ### Added - Move current logging config into production.py since it's not useful locally anyway. Used only if not using Sentry. (@audreyr) From aedba0b1f5894464aa5c67ed710eac88dc1e1107 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Thu, 29 Oct 2015 20:05:41 -0500 Subject: [PATCH 184/402] Add #371 to changelog. --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index baa80010f..b53483004 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-28] +### Changed +- Update deployment-on-heroku.rst for ADMIN_URL (@yunti) + ## [2015-10-27] ### Added - Added sudo: true to the travis file (@MathijsHoogland) From 8c2a4cc3178c952013bd0bb306b1712bfd816d1b Mon Sep 17 00:00:00 2001 From: mcho421 Date: Sat, 31 Oct 2015 12:17:00 +1100 Subject: [PATCH 185/402] Fix gevent requirement for Python 3 --- {{cookiecutter.repo_name}}/requirements/local.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index ea6663f89..c97d5481e 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -14,8 +14,13 @@ django-debug-toolbar==1.4 ipdb==0.8.1 {% if cookiecutter.use_maildump == "y" -%} -# Required by maildump. Need to pin dependency to gevent beta to be Python 3-compatible. +# Required by maildump. +{% if cookiecutter.use_python2 == 'n' -%} +# Need to pin dependency to gevent beta to be Python 3-compatible. +gevent==1.1b6 +{% else -%} gevent==1.0.2 +{% endif -%} # Enables better email testing maildump==0.5.1 {%- endif %} From 7f3fad80ce128500112f7b51e49a44eaf714a617 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20Segonds?= Date: Tue, 3 Nov 2015 16:23:00 +0100 Subject: [PATCH 186/402] Update .travis.yml fix python version issue --- {{cookiecutter.repo_name}}/.travis.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/{{cookiecutter.repo_name}}/.travis.yml b/{{cookiecutter.repo_name}}/.travis.yml index f5b02a013..9796896f6 100644 --- a/{{cookiecutter.repo_name}}/.travis.yml +++ b/{{cookiecutter.repo_name}}/.travis.yml @@ -8,7 +8,11 @@ before_install: - sudo apt-get install -qq libsqlite3-dev libxml2 libxml2-dev libssl-dev libbz2-dev wget curl llvm language: python python: +{% if cookiecutter.use_python2 == 'n' -%} - "3.4" +{% else %} + - "2.7" +{%- endif %} install: - "pip install hitch" - "cd tests" From dbe5bcc690bfd8380fd1cdae582a91db2eee1c22 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrionuevo da Luz" Date: Wed, 4 Nov 2015 23:24:49 -0300 Subject: [PATCH 187/402] update requirements --- CHANGELOG.md | 6 ++++++ cookiecutter.json | 2 +- requirements.txt | 6 +++--- {{cookiecutter.repo_name}}/requirements/base.txt | 8 ++++---- {{cookiecutter.repo_name}}/requirements/local.txt | 2 +- {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- {{cookiecutter.repo_name}}/requirements/test.txt | 6 +++--- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 8 files changed, 20 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b53483004..40d5fc1db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-04] +### Changed +- Update version of Django, cookiecutter, celery, coverage, django-mailgun, django-redis, factory_boy, flake8, pytest and pytz (@luzfcb) +- Update AngularJS version to 1.4.7 (@luzfcb) +- Update 'now' date in cookiecutter.json (@luzfcb) + ## [2015-10-28] ### Changed - Update deployment-on-heroku.rst for ADMIN_URL (@yunti) diff --git a/cookiecutter.json b/cookiecutter.json index f214fad19..64e433bad 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -7,7 +7,7 @@ "domain_name": "example.com", "version": "0.1.0", "timezone": "UTC", - "now": "2015/09/30", + "now": "2015/11/04", "year": "{{ cookiecutter.now[:4] }}", "use_whitenoise": "y", "use_celery": "n", diff --git a/requirements.txt b/requirements.txt index 2f2756096..b8ad0567c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ -cookiecutter==1.1.0 -flake8==2.4.1 +cookiecutter==1.2.1 +flake8==2.5.0 sh # Debugging @@ -9,7 +9,7 @@ ipython==4.0.0 # Testing # ------------------------------------- -pytest==2.8.1 +pytest==2.8.2 git+git://github.com/mverteuil/pytest-ipdb.git pep8==1.6.2 pyflakes==1.0.0 diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 1ebdac4b0..5f0a43ed0 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -1,5 +1,5 @@ # Bleeding edge Django -django==1.8.5 +django==1.8.6 # Configuration django-environ==0.4.0 @@ -37,14 +37,14 @@ unicode-slugify==0.1.3 django-autoslug==1.9.3 # Time zones support -pytz==2015.6 +pytz==2015.7 # Redis support -django-redis==4.2.0 +django-redis==4.3.0 redis>=2.10.0 {% if cookiecutter.use_celery == "y" %} -celery==3.1.18 +celery==3.1.19 {% endif %} # Your custom requirements go here diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index ea6663f89..71b6d44e8 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,6 +1,6 @@ # Local development dependencies go here -r base.txt -coverage==4.0.1 +coverage==4.0.2 Sphinx django-extensions==1.5.7 Werkzeug==0.10.4 diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index a4e069316..be1fc61bc 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -24,7 +24,7 @@ Collectfast==0.2.3 # Mailgun Support # --------------- -django-mailgun==0.7.2 +django-mailgun==0.8.0 {% if cookiecutter.use_sentry == "y" -%} # Raven is the Sentry client diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index 2c8085fc5..6d70d4bc6 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -7,7 +7,7 @@ psycopg2==2.6.1 {%- endif %} -coverage==4.0 -flake8==2.4.1 +coverage==4.0.2 +flake8==2.5.0 django-test-plus==1.0.9 -factory_boy==2.5.2 +factory_boy==2.6.0 diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index a30c03c08..519e002a0 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -24,7 +24,7 @@ {% endblock %} {% block angular %} - + {% endblock %} From ea9dec49d7a00e8a7172ffe73fa26b50f00dd829 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Wed, 4 Nov 2015 20:28:23 -0800 Subject: [PATCH 188/402] Bump Django in setup.py --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 31edec6c4..00438c8da 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ except ImportError: # Our version ALWAYS matches the version of Django we support # If Django has a new release, we branch, tag, then update this setting after the tag. -version = "1.8.5" +version = "1.8.6" if sys.argv[-1] == 'tag': os.system("git tag -a %s -m 'version %s'" % (version, version)) From 8c05e0140b6bc93465da4962f353ba85574ba889 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Thu, 5 Nov 2015 10:02:05 -0300 Subject: [PATCH 189/402] update django-extensions to 1.5.8 --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/requirements/local.txt | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 40d5fc1db..5a9500ce0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-05] +### Changed +- Update version of django-extensions (@luzfcb) + ## [2015-11-04] ### Changed - Update version of Django, cookiecutter, celery, coverage, django-mailgun, django-redis, factory_boy, flake8, pytest and pytz (@luzfcb) diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 71b6d44e8..ad41849c2 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -2,7 +2,7 @@ -r base.txt coverage==4.0.2 Sphinx -django-extensions==1.5.7 +django-extensions==1.5.8 Werkzeug==0.10.4 django-test-plus==1.0.9 factory_boy==2.6.0 From 85e0471911c6247d05ede918747d95c69312f77c Mon Sep 17 00:00:00 2001 From: Chris Pappalardo Date: Fri, 6 Nov 2015 10:23:44 -0800 Subject: [PATCH 190/402] changed ADMIN_URL to DJANGO_ADMIN_URL in env.example; the former is not an expected env variable --- {{cookiecutter.repo_name}}/env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index 932744dc7..03348839c 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -1,7 +1,7 @@ POSTGRES_PASSWORD=mysecretpass POSTGRES_USER=postgresuser -ADMIN_URL= +DJANGO_ADMIN_URL= DJANGO_SETTINGS_MODULE=config.settings.production DJANGO_SECRET_KEY=CHANGEME!!! DJANGO_ALLOWED_HOSTS=.{{ cookiecutter.domain_name }} From fe9be62cf5c526a48916e77a535fb5e7d9d2bf5e Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 6 Nov 2015 16:21:16 -0800 Subject: [PATCH 191/402] Added *tests* to , because including it is cheating --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/.coveragerc | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a9500ce0..475d90c70 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-06] +### Changed +- Added *tests* to `.coveragerc`, because including it is cheating! (@pydanny) + ## [2015-11-05] ### Changed - Update version of django-extensions (@luzfcb) diff --git a/{{cookiecutter.repo_name}}/.coveragerc b/{{cookiecutter.repo_name}}/.coveragerc index 403f3303e..0354b3c19 100644 --- a/{{cookiecutter.repo_name}}/.coveragerc +++ b/{{cookiecutter.repo_name}}/.coveragerc @@ -1,3 +1,3 @@ [run] include = {{cookiecutter.repo_name}}/* -omit = *migrations* +omit = *migrations*, *tests* From 1c1ca396180b48a57c0d7be8d47c5a167b6307b0 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Fri, 6 Nov 2015 19:07:11 -0800 Subject: [PATCH 192/402] Add #391 to changelog. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 475d90c70..f5b233915 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-05] ### Changed - Update version of django-extensions (@luzfcb) +- Fix gevent requirement for Python 3 (@mcho421) ## [2015-11-04] ### Changed From 7e8f58d6ec472f6e5effc291f00471d32d64c686 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Fri, 6 Nov 2015 19:44:10 -0800 Subject: [PATCH 193/402] Fix test failure due to favicon.ico being opened by DjangoCookieTestCase.check_paths(). --- requirements.txt | 1 + tests/base.py | 12 +++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/requirements.txt b/requirements.txt index b8ad0567c..9cb442071 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,7 @@ cookiecutter==1.2.1 flake8==2.5.0 sh +binaryornot==0.4.0 # Debugging # ------------------------------------- diff --git a/tests/base.py b/tests/base.py index 25e9daf7c..9b15198c3 100644 --- a/tests/base.py +++ b/tests/base.py @@ -4,6 +4,7 @@ import shutil import unittest from os.path import exists, dirname, join +from binaryornot.check import is_binary import sh from cookiecutter.main import cookiecutter @@ -26,11 +27,12 @@ class DjangoCookieTestCase(unittest.TestCase): # Assert that no match is found in any of the files for path in paths: - for line in open(path, 'r'): - match = re_obj.search(line) - self.assertIsNone( - match, - "cookiecutter variable not replaced in {}".format(path)) + if not is_binary(path): + for line in open(path, 'r'): + match = re_obj.search(line) + self.assertIsNone( + match, + "cookiecutter variable not replaced in {}".format(path)) def generate_project(self, extra_context=None): ctx = { From 21d1c887e37c6bb8b4542e1d504d104d245c8a10 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Fri, 6 Nov 2015 19:46:11 -0800 Subject: [PATCH 194/402] Ignore .cache/ generated by running the cookiecutter-django tests. --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 111bf3070..925680bb8 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,6 @@ _build local_settings.py repo_name my_test_project/* + +# Generated when running py.test for the cookiecutter-django generation tests +.cache/ From 2f605ce73117b844132b5c731d84a2cd6a93b9b2 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 6 Nov 2015 19:53:16 -0800 Subject: [PATCH 195/402] Update travis to support Python 3.4 and 3.5 --- .travis.yml | 5 ++++- CHANGELOG.md | 6 +++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 41486605d..980294d56 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,9 @@ language: python +python: + - 3.5 + - 3.4 + - 2.7 sudo: false - install: - pip install -r requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index f5b233915..d2041388f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,8 +3,12 @@ All enhancements and patches to cookiecutter-django will be documented in this f This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-06] +### Added +- \*tests\* to `.coveragerc`, because including it is cheating! (@pydanny) +- Binaryornot to cookiecutter-django's own tests because otherwise Python 3 blows up (@audreyr) ### Changed -- Added *tests* to `.coveragerc`, because including it is cheating! (@pydanny) +- `.travis.yml` configuration to support Python 3.4 and 3.5 (@pydanny) +- `.gitignore` configuration so py.test cache files don't show up in git status. ## [2015-11-05] ### Changed From 66eb4b099ffa2e59e4d4b913ea46f4373f623955 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 6 Nov 2015 19:51:43 -0800 Subject: [PATCH 196/402] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d2041388f..59ebd2f22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Added - \*tests\* to `.coveragerc`, because including it is cheating! (@pydanny) - Binaryornot to cookiecutter-django's own tests because otherwise Python 3 blows up (@audreyr) + ### Changed - `.travis.yml` configuration to support Python 3.4 and 3.5 (@pydanny) - `.gitignore` configuration so py.test cache files don't show up in git status. From 8b8405ddf771fa3255f9d657dc14f1c248ce2d1a Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 18:45:26 +0100 Subject: [PATCH 197/402] added @ChrisPappalardo to contributors --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 636cd110f..ad5cdb9a3 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -59,6 +59,7 @@ Code Contributors * Chris Franklin / @hairychris * Anna Callahan / @jazztpt * Mathijs Hoogland / @MathijsHoogland +* Chris Pappalardo / @ChrisPappalardo \* Possesses commit rights From fbd58319c9fba367d0fb499819a2e43cf8fbb1b1 Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 18:45:40 +0100 Subject: [PATCH 198/402] added @ChrisPappalardo's change --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 59ebd2f22..2c52d1617 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-10-24] +### Changed +- Renamed ADMIN_URL to DJANGO_ADMIN_URL in env.example (@ChrisPappalardo) + ## [2015-11-06] ### Added - \*tests\* to `.coveragerc`, because including it is cheating! (@pydanny) From 87c5360b187f658fc2130af8a69a070ec7ad5e1a Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 19:04:19 +0100 Subject: [PATCH 199/402] added DJANGO_SENTRY_DSN --- {{cookiecutter.repo_name}}/env.example | 3 +++ 1 file changed, 3 insertions(+) diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index 03348839c..d8807a5e7 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -12,3 +12,6 @@ DJANGO_MAILGUN_API_KEY= DJANGO_MAILGUN_SERVER_NAME= DJANGO_SERVER_EMAIL= DJANGO_SECURE_SSL_REDIRECT=False +{% if cookiecutter.use_whitenoise == 'y' -%} +DJANGO_SENTRY_DSN= +{% endif %} From 205ac33abcd3321db6e5e3b05b926ad0a8f2375f Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 19:05:56 +0100 Subject: [PATCH 200/402] 'dsn'.upper() --- .../{{cookiecutter.repo_name}}/taskapp/celery.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index 544607ae8..30fda6eae 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -29,7 +29,7 @@ class CeleryConfig(AppConfig): # Celery signal registration from raven import Client from raven.contrib.celery import register_signal - client = Client(dsn=settings.RAVEN_CONFIG['dsn']) + client = Client(dsn=settings.RAVEN_CONFIG['DSN']) register_signal(client) {%- endif %} From 67a17bf2263dcdfa6e31d35779f06bcce6fbc2a2 Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 19:44:26 +0100 Subject: [PATCH 201/402] added changes regarding sentry on docker --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c52d1617..86476617d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-24] ### Changed +- Fixed an error where celery could'nt load the sentry DSN from settings (@jayfk) +- Added DJANGO_SENTRY_DSN to env.example (@jayfk) - Renamed ADMIN_URL to DJANGO_ADMIN_URL in env.example (@ChrisPappalardo) ## [2015-11-06] From fba95ab96ddd60f9e8d25ada3313465e608ab405 Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 20:15:41 +0100 Subject: [PATCH 202/402] added Amjith Ramanujam to contributors --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index ad5cdb9a3..3c1a02140 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -60,6 +60,7 @@ Code Contributors * Anna Callahan / @jazztpt * Mathijs Hoogland / @MathijsHoogland * Chris Pappalardo / @ChrisPappalardo +* Amjith Ramanujam / @amjith \* Possesses commit rights From 6699e6d1258a6a4f22eaf6071ab738821ac19d1f Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 20:18:11 +0100 Subject: [PATCH 203/402] added NEW_RELIC_APP_NAME so that it appears on the dashboard --- {{cookiecutter.repo_name}}/config/settings/production.py | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 0136c01e3..27ba946e4 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -132,6 +132,7 @@ EMAIL_SUBJECT_PREFIX = env("DJANGO_EMAIL_SUBJECT_PREFIX", default='[{{cookiecutt SERVER_EMAIL = env('DJANGO_SERVER_EMAIL', default=DEFAULT_FROM_EMAIL) {% if cookiecutter.use_newrelic == 'y'-%} NEW_RELIC_LICENSE_KEY = env('NEW_RELIC_LICENSE_KEY') +NEW_RELIC_APP_NAME = '{{cookiecutter.project_name}}' {%- endif %} # TEMPLATE CONFIGURATION From 1ce169d5de0f177752957ed08c49444d567be166 Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 20:20:19 +0100 Subject: [PATCH 204/402] added NEW_RELIC_LICENSE_KEY to environment variables --- docs/settings.rst | 1 + {{cookiecutter.repo_name}}/env.example | 3 +++ 2 files changed, 4 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index 6364ea4b2..08a95bf09 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -40,4 +40,5 @@ DJANGO_SENTRY_CLIENT SENTRY_CLIENT n/a DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error +NEW_RELIC_LICENSE_KEY NEW_RELIC_LICENSE_KEY n/a raises error ======================================= =========================== ============================================== ====================================================================== diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index d8807a5e7..3420db7cb 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -15,3 +15,6 @@ DJANGO_SECURE_SSL_REDIRECT=False {% if cookiecutter.use_whitenoise == 'y' -%} DJANGO_SENTRY_DSN= {% endif %} +{% if cookiecutter.use_newrelic == 'y' -%} +NEW_RELIC_LICENSE_KEY +{% endif %} From 3ad8f52eb7323364d4800d97d813e55d10adb560 Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 20:21:03 +0100 Subject: [PATCH 205/402] added newrelic support thanks to @amjith --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86476617d..fa9152c7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-10-24] ### Changed +- Added newrelic support (@amjith) - Fixed an error where celery could'nt load the sentry DSN from settings (@jayfk) - Added DJANGO_SENTRY_DSN to env.example (@jayfk) - Renamed ADMIN_URL to DJANGO_ADMIN_URL in env.example (@ChrisPappalardo) From 3ac1d1edb9e07b05f97e1ac891b77576a97dff0d Mon Sep 17 00:00:00 2001 From: Jay Date: Sat, 7 Nov 2015 20:23:46 +0100 Subject: [PATCH 206/402] =?UTF-8?q?use=20the=20correct=20date=20?= =?UTF-8?q?=F0=9F=93=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fa9152c7b..eaf483f58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -## [2015-10-24] +## [2015-11-7] ### Changed - Added newrelic support (@amjith) - Fixed an error where celery could'nt load the sentry DSN from settings (@jayfk) From 439766ea8f85149a09646cb125f7d00fd3d9afc7 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 7 Nov 2015 19:47:31 -0800 Subject: [PATCH 207/402] Slight change to post_gen_hook --- CHANGELOG.md | 9 ++++++--- hooks/post_gen_project.py | 4 +--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eaf483f58..52a3a9e37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,10 +3,13 @@ All enhancements and patches to cookiecutter-django will be documented in this f This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-7] +### Added +- newrelic support (@amjith) +- DJANGO_SENTRY_DSN to env.example (@jayfk) + ### Changed -- Added newrelic support (@amjith) -- Fixed an error where celery could'nt load the sentry DSN from settings (@jayfk) -- Added DJANGO_SENTRY_DSN to env.example (@jayfk) +- Made `post_gen_hook.set_secret_key()` only changes one CHANGEME!!! at a time. +- Fixed an error where celery couldn't load the sentry DSN from settings (@jayfk) - Renamed ADMIN_URL to DJANGO_ADMIN_URL in env.example (@ChrisPappalardo) ## [2015-11-06] diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index 90c1b45fd..9570e9f46 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -62,10 +62,9 @@ def set_secret_key(setting_file_location): # Generate a SECRET_KEY that matches the Django standard SECRET_KEY = get_random_string() - SECRET_KEY = 'CHANGEME!!!' + SECRET_KEY # Replace "CHANGEME!!!" with SECRET_KEY - file_ = file_.replace('CHANGEME!!!', SECRET_KEY) + file_ = file_.replace('CHANGEME!!!', SECRET_KEY, 1) # Write the results to the locals.py module with open(setting_file_location, 'w') as f: @@ -92,7 +91,6 @@ def make_secret_key(project_directory): set_secret_key(env_file) - def remove_task_app(project_directory): """Removes the taskapp if celery isn't going to be used""" # Determine the local_setting_file_location From d92d6e6feca673d259cee232a81e4a7054014f9a Mon Sep 17 00:00:00 2001 From: Garry Polley Date: Sun, 8 Nov 2015 14:58:07 -0600 Subject: [PATCH 208/402] Update django-extensions to current release. Fixes #400 --- {{cookiecutter.repo_name}}/requirements/local.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index e4c4628ba..883903ba0 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -2,7 +2,7 @@ -r base.txt coverage==4.0.2 Sphinx -django-extensions==1.5.8 +django-extensions==1.5.9 Werkzeug==0.10.4 django-test-plus==1.0.9 factory_boy==2.6.0 From 01d756d57d7626c0d4b01ed6e4661883f163d4d6 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 8 Nov 2015 15:01:36 -0800 Subject: [PATCH 209/402] Changelog update --- CHANGELOG.md | 8 ++++++-- CONTRIBUTORS.rst | 1 + 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 52a3a9e37..313a8c797 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,17 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -## [2015-11-7] +## [2015-11-08] +### Changed +- bump django-extensions version (@garrypolley) + +## [2015-11-07] ### Added - newrelic support (@amjith) - DJANGO_SENTRY_DSN to env.example (@jayfk) ### Changed -- Made `post_gen_hook.set_secret_key()` only changes one CHANGEME!!! at a time. +- Made `post_gen_hook.set_secret_key()` only changes one CHANGEME!!! at a time. (@pydanny) - Fixed an error where celery couldn't load the sentry DSN from settings (@jayfk) - Renamed ADMIN_URL to DJANGO_ADMIN_URL in env.example (@ChrisPappalardo) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 3c1a02140..3b683140d 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -61,6 +61,7 @@ Code Contributors * Mathijs Hoogland / @MathijsHoogland * Chris Pappalardo / @ChrisPappalardo * Amjith Ramanujam / @amjith +* Garry Polley / @garrypolley \* Possesses commit rights From ae9e912b62567285dc8bcc90a697f52459a78abf Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 21:52:29 +0100 Subject: [PATCH 210/402] Implement a basic tox.ini based on requirements.txt --- tox.ini | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 tox.ini diff --git a/tox.ini b/tox.ini new file mode 100644 index 000000000..b85191c1d --- /dev/null +++ b/tox.ini @@ -0,0 +1,7 @@ +[tox] +skipsdist = true +envlist = py27,py34,py35 + +[testenv] +deps = -rrequirements.txt +commands = py.test {posargs:tests} From cc74c48588ef872bc7fb1c1ada4374d12a04825c Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 23:04:41 +0100 Subject: [PATCH 211/402] Add .coverage, .tox and .cache to .gitignore --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 925680bb8..0e0a592c2 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,8 @@ my_test_project/* # Generated when running py.test for the cookiecutter-django generation tests .cache/ + +# Unit test / coverage reports +.coverage +.tox +.cache From bea23a7a911ff9f73cd23074569e43a746421b17 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 23:05:17 +0100 Subject: [PATCH 212/402] Add pytest-cookies to testenv dependencies --- tox.ini | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index b85191c1d..a7bb3e97d 100644 --- a/tox.ini +++ b/tox.ini @@ -3,5 +3,7 @@ skipsdist = true envlist = py27,py34,py35 [testenv] -deps = -rrequirements.txt +deps = + -rrequirements.txt + pytest-cookies commands = py.test {posargs:tests} From 6c339a14170ea77926bc8eb47bd7e61c80db4a42 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 23:05:32 +0100 Subject: [PATCH 213/402] Implement a basic test with cookies.bake() --- tests/test_cookiecutter_generation.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 tests/test_cookiecutter_generation.py diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py new file mode 100644 index 000000000..e7658809f --- /dev/null +++ b/tests/test_cookiecutter_generation.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- + +import pytest + +@pytest.fixture +def context(): + return { + "project_name": "My Test Project", + "repo_name": "my_test_project", + "author_name": "Test Author", + "email": "test@example.com", + "description": "A short description of the project.", + "domain_name": "example.com", + "version": "0.1.0", + "timezone": "UTC", + "now": "2015/01/13", + "year": "2015" + } + + +def test_default_configuration(cookies, context): + result = cookies.bake(extra_context=context) + assert result.exit_code == 0 From 646e376a8e9bdc1daaa38ebee2de39e945ab443d Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 23:46:38 +0100 Subject: [PATCH 214/402] Integrate additional checks of base.py with slight improvements --- tests/test_cookiecutter_generation.py | 38 +++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index e7658809f..9fcf42d2d 100644 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -1,6 +1,14 @@ # -*- coding: utf-8 -*- +import os +import re + import pytest +from binaryornot.check import is_binary + +PATTERN = "{{(\s?cookiecutter)[.](.*?)}}" +RE_OBJ = re.compile(PATTERN) + @pytest.fixture def context(): @@ -18,6 +26,36 @@ def context(): } +def build_files_list(root_dir): + """Build a list containing absolute paths to the generated files.""" + return [ + os.path.join(dirpath, file_path) + for dirpath, subdirs, files in os.walk(root_dir) + for file_path in files + ] + + +def check_paths(paths): + """Method to check all paths have correct substitutions, + used by other tests cases + """ + # Assert that no match is found in any of the files + for path in paths: + if is_binary(path): + continue + for line in open(path, 'r'): + match = RE_OBJ.search(line) + msg = "cookiecutter variable not replaced in {}" + assert match is None, msg.format(path) + + def test_default_configuration(cookies, context): result = cookies.bake(extra_context=context) assert result.exit_code == 0 + assert result.exception is None + assert result.project.basename == context['repo_name'] + assert result.project.isdir() + + paths = build_files_list(str(result.project)) + assert paths + check_paths(paths) From f579cf08ac1098134d1c0701392471a985db0c76 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Sun, 8 Nov 2015 23:59:10 +0100 Subject: [PATCH 215/402] Implement parametrized test for enabled features --- tests/test_cookiecutter_generation.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index 9fcf42d2d..650d4e1fb 100644 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -59,3 +59,21 @@ def test_default_configuration(cookies, context): paths = build_files_list(str(result.project)) assert paths check_paths(paths) + + +@pytest.fixture(params=['use_maildump', 'use_celery', 'windows']) +def feature_context(request, context): + context.update({request.param: 'y'}) + return context + + +def test_enabled_features(cookies, feature_context): + result = cookies.bake(extra_context=feature_context) + assert result.exit_code == 0 + assert result.exception is None + assert result.project.basename == feature_context['repo_name'] + assert result.project.isdir() + + paths = build_files_list(str(result.project)) + assert paths + check_paths(paths) From 664c72d291e0c8f62538e837f126fdbcb7db2367 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:02:07 +0100 Subject: [PATCH 216/402] Implement test for flake8 compliance --- tests/test_cookiecutter_generation.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index 650d4e1fb..74f8947c6 100644 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -2,6 +2,7 @@ import os import re +import sh import pytest from binaryornot.check import is_binary @@ -34,7 +35,7 @@ def build_files_list(root_dir): for file_path in files ] - + def check_paths(paths): """Method to check all paths have correct substitutions, used by other tests cases @@ -77,3 +78,13 @@ def test_enabled_features(cookies, feature_context): paths = build_files_list(str(result.project)) assert paths check_paths(paths) + + +def test_flake8_compliance(cookies): + """generated project should pass flake8""" + result = cookies.bake() + + try: + sh.flake8(str(result.project)) + except sh.ErrorReturnCode as e: + pytest.fail(e) From 87025216c29966e975f9d8976eac2242dcd63435 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:12:30 +0100 Subject: [PATCH 217/402] Remove unittest modules altogether --- tests/__init__.py | 0 tests/base.py | 71 ------------------------- tests/test_cookiecutter_substitution.py | 33 ------------ 3 files changed, 104 deletions(-) delete mode 100644 tests/__init__.py delete mode 100644 tests/base.py delete mode 100644 tests/test_cookiecutter_substitution.py diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/tests/base.py b/tests/base.py deleted file mode 100644 index 9b15198c3..000000000 --- a/tests/base.py +++ /dev/null @@ -1,71 +0,0 @@ -import os -import re -import shutil -import unittest -from os.path import exists, dirname, join - -from binaryornot.check import is_binary -import sh - -from cookiecutter.main import cookiecutter - - -class DjangoCookieTestCase(unittest.TestCase): - - root_dir = dirname(dirname(__file__)) - ctx = {} - destpath = None - - def check_paths(self, paths): - """ - Method to check all paths have correct substitutions, - used by other tests cases - """ - # Construct the cookiecutter search pattern - pattern = "{{(\s?cookiecutter)[.](.*?)}}" - re_obj = re.compile(pattern) - - # Assert that no match is found in any of the files - for path in paths: - if not is_binary(path): - for line in open(path, 'r'): - match = re_obj.search(line) - self.assertIsNone( - match, - "cookiecutter variable not replaced in {}".format(path)) - - def generate_project(self, extra_context=None): - ctx = { - "project_name": "My Test Project", - "repo_name": "my_test_project", - "author_name": "Test Author", - "email": "test@example.com", - "description": "A short description of the project.", - "domain_name": "example.com", - "version": "0.1.0", - "timezone": "UTC", - "now": "2015/01/13", - "year": "2015" - } - if extra_context: - assert isinstance(extra_context, dict) - ctx.update(extra_context) - - self.ctx = ctx - self.destpath = join(self.root_dir, self.ctx['repo_name']) - - cookiecutter(template='./', checkout=None, no_input=True, extra_context=ctx) - - # Build a list containing absolute paths to the generated files - paths = [os.path.join(dirpath, file_path) - for dirpath, subdirs, files in os.walk(self.destpath) - for file_path in files] - return paths - - def clean(self): - if exists(self.destpath): - shutil.rmtree(self.destpath) - sh.cd(self.root_dir) - - def tearDown(self): - self.clean() diff --git a/tests/test_cookiecutter_substitution.py b/tests/test_cookiecutter_substitution.py deleted file mode 100644 index 5ac07406f..000000000 --- a/tests/test_cookiecutter_substitution.py +++ /dev/null @@ -1,33 +0,0 @@ -from __future__ import absolute_import -import sh - -from .base import DjangoCookieTestCase - - -class TestCookiecutterSubstitution(DjangoCookieTestCase): - """Test that all cookiecutter instances are substituted""" - - def test_default_configuration(self): - # Build a list containing absolute paths to the generated files - paths = self.generate_project() - self.check_paths(paths) - - def test_maildump_enabled(self): - paths = self.generate_project(extra_context={'use_maildump': 'y'}) - self.check_paths(paths) - - def test_celery_enabled(self): - paths = self.generate_project(extra_context={'use_celery': 'y'}) - self.check_paths(paths) - - def test_windows_enabled(self): - paths = self.generate_project(extra_context={'windows': 'y'}) - self.check_paths(paths) - - def test_flake8_compliance(self): - """generated project should pass flake8""" - self.generate_project() - try: - sh.flake8(self.destpath) - except sh.ErrorReturnCode as e: - raise AssertionError(e) From cca450878c646119d3349b788f8d789c9afddb50 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:32:16 +0100 Subject: [PATCH 218/402] Write docs on running the test suite with tox, resolve #399 --- CONTRIBUTING.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a6b732594..d05ea0dbd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,3 +9,48 @@ Getting your pull request merged in #. Keep it small. The smaller the pull request the more likely I'll pull it in. #. Pull requests that fix a current issue get priority for review. #. If you're not already in the `CONTRIBUTORS.rst` file, add yourself! + +Testing +------- + +Installation +~~~~~~~~~~~~ + +Please install `tox`_, which is a generic virtualenv management and test command line tool. + +`tox`_ is available for download from `PyPI`_ via `pip`_:: + + $ pip install tox + +It will automatically create a fresh virtual environment and install our test dependencies, +such as `pytest-cookies`_ and `flake8`_. + +Run the Tests +~~~~~~~~~~~~~ + +Tox uses py.test under the hood, hence it supports the same syntax for selecting tests. + +For further information please consult the `pytest usage docs`_. + +To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.:: + + $ tox + +It is possible to tests with some versions of python, to do this the command +is:: + + $ tox -e py27,py34 + +Will run py.test with the python2.7, and python3.4 interpreters, for +example. + +To run a particular test with tox for against your current Python version:: + + $ tox -e py -- -k test_default_configuration + +.. _`pytest usage docs`: https://pytest.org/latest/usage.html#specifying-tests-selecting-tests +.. _`tox`: https://tox.readthedocs.org/en/latest/ +.. _`pip`: https://pypi.python.org/pypi/pip/ +.. _`pytest-cookies`: https://pypi.python.org/pypi/pytest-cookies/ +.. _`flake8`: https://pypi.python.org/pypi/flake8/ +.. _`PyPI`: https://pypi.python.org/pypi From b68e89279fc1eb674677d7e3b2b4dfcaa3d08e18 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:35:21 +0100 Subject: [PATCH 219/402] Add tox v2.1.1 to requirements.txt --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 9cb442071..aadbfa9ee 100644 --- a/requirements.txt +++ b/requirements.txt @@ -14,3 +14,4 @@ pytest==2.8.2 git+git://github.com/mverteuil/pytest-ipdb.git pep8==1.6.2 pyflakes==1.0.0 +tox==2.1.1 From adf10a03baed49f153717e2ab58b2b20e520392c Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:38:52 +0100 Subject: [PATCH 220/402] Update travis config to use tox instead of pytest --- .travis.yml | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/.travis.yml b/.travis.yml index 980294d56..4608b31cc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,14 +1,17 @@ -language: python -python: - - 3.5 - - 3.4 - - 2.7 -sudo: false -install: -- pip install -r requirements.txt +# Config file for automatic testing at travis-ci.org -script: - - py.test +sudo: false +language: python +python: 3.5 +env: + - TOX_ENV=py27 + - TOX_ENV=py34 + - TOX_ENV=py35 + +script: tox -e $TOX_ENV + +install: + - pip install tox notifications: email: From 54267d0dce67867e94a8b06017c40332a76fa517 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:41:35 +0100 Subject: [PATCH 221/402] Remove requirements.txt from tox.ini in favor of explicit testenv deps --- tox.ini | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index a7bb3e97d..2cd7a3cb1 100644 --- a/tox.ini +++ b/tox.ini @@ -4,6 +4,8 @@ envlist = py27,py34,py35 [testenv] deps = - -rrequirements.txt + binaryornot + flake8 pytest-cookies + sh commands = py.test {posargs:tests} From 7664194ab84451b8661906b39392f44eab02d2a3 Mon Sep 17 00:00:00 2001 From: Raphael Pierzina Date: Mon, 9 Nov 2015 00:54:48 +0100 Subject: [PATCH 222/402] Ensure that tox passes on certain environment variables --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index 2cd7a3cb1..deb1dd503 100644 --- a/tox.ini +++ b/tox.ini @@ -3,6 +3,7 @@ skipsdist = true envlist = py27,py34,py35 [testenv] +passenv = LC_ALL, LANG, HOME deps = binaryornot flake8 From 45bbcf0687af87fc007b2bedeb39db44783beafc Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Mon, 9 Nov 2015 07:17:55 -0800 Subject: [PATCH 223/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 313a8c797..72f32c96d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-09] +### Changed +- Now using py.test for our test suite!! (@hackebrot) + ## [2015-11-08] ### Changed - bump django-extensions version (@garrypolley) From 9c2b33c5abe571e3db12eeefbee0b07228afcd1b Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Mon, 9 Nov 2015 07:20:37 -0800 Subject: [PATCH 224/402] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 72f32c96d..d24ec37b5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-09] ### Changed - Now using py.test for our test suite!! (@hackebrot) +- Python version in travis.yml is now correct for the selected version of Django (@show0k) ## [2015-11-08] ### Changed From 28fe8317009a30c73a1321dbb73447b13c7e0645 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Mon, 9 Nov 2015 07:21:40 -0800 Subject: [PATCH 225/402] Update CONTRIBUTORS.rst --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 3b683140d..7c4f20f1a 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -62,6 +62,7 @@ Code Contributors * Chris Pappalardo / @ChrisPappalardo * Amjith Ramanujam / @amjith * Garry Polley / @garrypolley +* Théo Segonds / show0k \* Possesses commit rights From 88c6a1775b04bee1d2a95aa09d2411a4211169a5 Mon Sep 17 00:00:00 2001 From: Adam Dobrawy Date: Thu, 12 Nov 2015 05:51:15 +0100 Subject: [PATCH 226/402] Added default password to UserFactory --- .../{{cookiecutter.repo_name}}/users/tests/factories.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py index aa35d3b75..aa5a04a71 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py @@ -5,6 +5,8 @@ import factory class UserFactory(factory.django.DjangoModelFactory): username = factory.Sequence(lambda n: 'user-{0}'.format(n)) email = factory.Sequence(lambda n: 'user-{0}@example.com'.format(n)) + password = factory.PosteGnerationMethodCall('set_password', 'password') class Meta: - model = models.User + model = 'users.User' + django_get_or_create = ('username', ) From 794c9f1ce78f7e74e916675f7f388fa93df445a5 Mon Sep 17 00:00:00 2001 From: Adam Dobrawy Date: Thu, 12 Nov 2015 05:54:38 +0100 Subject: [PATCH 227/402] Fix flake erros in UserFactory --- .../{{cookiecutter.repo_name}}/users/tests/factories.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py index aa5a04a71..e36ba8f77 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py @@ -8,5 +8,5 @@ class UserFactory(factory.django.DjangoModelFactory): password = factory.PosteGnerationMethodCall('set_password', 'password') class Meta: - model = 'users.User' + model = models.User django_get_or_create = ('username', ) From d1de33fb3e7b8e1744fd9e43f0dcb4b0ffb8b7d7 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Wed, 11 Nov 2015 21:07:16 -0800 Subject: [PATCH 228/402] Use django_coverage_plugin to check template test coverage. --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/.coveragerc | 2 ++ {{cookiecutter.repo_name}}/requirements/local.txt | 1 + {{cookiecutter.repo_name}}/requirements/test.txt | 1 + 4 files changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d24ec37b5..9bbcbbf4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-11] +### Added +- Added django_coverage_plugin to measure Django template coverage (@audreyr) + ## [2015-11-09] ### Changed - Now using py.test for our test suite!! (@hackebrot) diff --git a/{{cookiecutter.repo_name}}/.coveragerc b/{{cookiecutter.repo_name}}/.coveragerc index 0354b3c19..525cd2ff0 100644 --- a/{{cookiecutter.repo_name}}/.coveragerc +++ b/{{cookiecutter.repo_name}}/.coveragerc @@ -1,3 +1,5 @@ [run] include = {{cookiecutter.repo_name}}/* omit = *migrations*, *tests* +plugins = + django_coverage_plugin diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 883903ba0..a9b63d442 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,6 +1,7 @@ # Local development dependencies go here -r base.txt coverage==4.0.2 +django_coverage_plugin==1.0 Sphinx django-extensions==1.5.9 Werkzeug==0.10.4 diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index 6d70d4bc6..b12b4d231 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -8,6 +8,7 @@ psycopg2==2.6.1 {%- endif %} coverage==4.0.2 +django_coverage_plugin==1.0 flake8==2.5.0 django-test-plus==1.0.9 factory_boy==2.6.0 From 219afa91533f156c856fb4e9ae0650d0f474266a Mon Sep 17 00:00:00 2001 From: yunti Date: Thu, 12 Nov 2015 12:43:56 +0000 Subject: [PATCH 229/402] Update base.txt --- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 5f0a43ed0..853abcfcf 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -22,7 +22,7 @@ Pillow==3.0.0 # For user registration, either via email or social # Well-built with regular release cycles! -django-allauth==0.23.0 +django-allauth==0.24.1 {% if cookiecutter.windows == 'y' -%} # On Windows, you must download/install psycopg2 manually From 40f74a8e89fe4556b672fbe8d6a9d8d802fed9eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Thu, 12 Nov 2015 09:50:33 -0300 Subject: [PATCH 230/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9bbcbbf4d..5cc287374 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-12] +### Changed +- Update version of django-allauth (@yunti) + ## [2015-11-11] ### Added - Added django_coverage_plugin to measure Django template coverage (@audreyr) From 1ae2d85dd6f1b03fc9a1eec5539fad07d06e2c86 Mon Sep 17 00:00:00 2001 From: Barclay StudyPC Date: Thu, 12 Nov 2015 15:07:22 +0000 Subject: [PATCH 231/402] Load url tags removed - deprecated in django 1.9 --- .../templates/account/email.html | 9 ++++----- .../templates/account/email_confirm.html | 3 +-- .../templates/account/login.html | 1 - .../templates/account/logout.html | 3 +-- .../templates/account/password_reset_from_key.html | 1 - .../templates/account/password_reset_from_key_done.html | 3 +-- .../templates/account/signup.html | 1 - .../templates/account/signup_closed.html | 3 +-- .../templates/account/verified_email_required.html | 3 +-- 9 files changed, 9 insertions(+), 18 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email.html index 2dab7e931..e757f21f3 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email.html @@ -1,7 +1,6 @@ {% raw %}{% extends "account/base.html" %} {% load i18n %} -{% load url from future %} {% load crispy_forms_tags %} {% block head_title %}{% trans "Account" %}{% endblock %} @@ -13,7 +12,7 @@

{% trans "E-mail Addresses" %}

{% if user.emailaddress_set.all %}

{% trans 'The following e-mail addresses are associated with your account:' %}

- + - {% else %} + {% else %}

{% trans 'Warning:'%} {% trans "You currently do not have any e-mail address set up. You should really add an e-mail address so you can receive notifications, reset your password, etc." %}

{% endif %}

{% trans "Add E-mail Address" %}

- +
{% csrf_token %} {{ form|crispy }} @@ -78,4 +77,4 @@ })(); {% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email_confirm.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email_confirm.html index d03430347..d7886239a 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email_confirm.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/email_confirm.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% load account %} @@ -16,7 +15,7 @@ {% if confirmation %} {% user_display confirmation.email_address.user as user_display %} - +

{% blocktrans with confirmation.email_address.email as email %}Please confirm that {{ email }} is an e-mail address for user {{ user_display }}.{% endblocktrans %}

diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html index fcd746ef6..acbc50c21 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/login.html @@ -3,7 +3,6 @@ {% load i18n %} {% load account %} {% load socialaccount %} -{% load url from future %} {% load crispy_forms_tags %} {% block head_title %}{% trans "Sign In" %}{% endblock %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/logout.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/logout.html index cf21b87e6..039dc7be9 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/logout.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/logout.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% block head_title %}{% trans "Sign Out" %}{% endblock %} @@ -26,4 +25,4 @@
{% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key.html index 603c25de7..8e1b39e26 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% load crispy_forms_tags %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key_done.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key_done.html index 9fb922e88..015028e4a 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key_done.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/password_reset_from_key_done.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% block head_title %}{% trans "Change Password" %}{% endblock %} @@ -14,4 +13,4 @@
{% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html index c8f1c75df..63e57a5fc 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% load crispy_forms_tags %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup_closed.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup_closed.html index 5de5361db..f5976dad5 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup_closed.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/signup_closed.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% block head_title %}{% trans "Sign Up Closed" %}{% endblock %} @@ -16,4 +15,4 @@
{% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/verified_email_required.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/verified_email_required.html index f6355fb63..7d071c6a6 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/verified_email_required.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/account/verified_email_required.html @@ -1,6 +1,5 @@ {% raw %}{% extends "account/base.html" %} -{% load url from future %} {% load i18n %} {% block head_title %}{% trans "Verify Your E-mail Address" %}{% endblock %} @@ -26,4 +25,4 @@ {% endblock %} -{% endraw %} \ No newline at end of file +{% endraw %} From 5214d6ca658f04738cad22839be509227d0cc947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Thu, 12 Nov 2015 17:33:42 -0300 Subject: [PATCH 232/402] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5cc287374..b77b46c82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Update version of django-allauth (@yunti) +### Removed +- remove ```{% load url from future %}``` in templates - deprecated in django 1.9 (@yunti) + ## [2015-11-11] ### Added - Added django_coverage_plugin to measure Django template coverage (@audreyr) From 782f93c68e5567c4c0e9409040f800f925247d30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Thu, 12 Nov 2015 17:39:30 -0300 Subject: [PATCH 233/402] add Cristian Vargas in CONTRIBUTORS list --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 7c4f20f1a..8505d2559 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -63,6 +63,7 @@ Code Contributors * Amjith Ramanujam / @amjith * Garry Polley / @garrypolley * Théo Segonds / show0k +* Cristian Vargas / @cdvv7788 \* Possesses commit rights From da956975e757e2f06c7a3e5478fdfec2aa01ca93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Thu, 12 Nov 2015 17:42:34 -0300 Subject: [PATCH 234/402] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b77b46c82..bfe913a94 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-12] ### Changed - Update version of django-allauth (@yunti) +- Added a warning in README.rst: ```repo_name must be a valid Python module``` @cdvv7788 ### Removed - remove ```{% load url from future %}``` in templates - deprecated in django 1.9 (@yunti) From c86d5c928cdefd09aca102b2a5c37f662e1426a6 Mon Sep 17 00:00:00 2001 From: Adam Dobrawy Date: Sat, 14 Nov 2015 14:15:00 +0100 Subject: [PATCH 235/402] Fix typo & import in UserFactory --- .../{{cookiecutter.repo_name}}/users/tests/factories.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py index e36ba8f77..e2c967de7 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/tests/factories.py @@ -1,12 +1,11 @@ -from feder.users import models import factory class UserFactory(factory.django.DjangoModelFactory): username = factory.Sequence(lambda n: 'user-{0}'.format(n)) email = factory.Sequence(lambda n: 'user-{0}@example.com'.format(n)) - password = factory.PosteGnerationMethodCall('set_password', 'password') + password = factory.PostGenerationMethodCall('set_password', 'password') class Meta: - model = models.User + model = 'users.User' django_get_or_create = ('username', ) From 9920c6d5b9559536e407abadd392443dff75962e Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 14:20:19 +0300 Subject: [PATCH 236/402] upstream merge --- README.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 3a607447c..a61530686 100644 --- a/README.rst +++ b/README.rst @@ -32,14 +32,20 @@ Features * Grunt build for compass and livereload * Basic e-mail configurations for sending emails via Mailgun_ * Media storage using Amazon S3 -* Serve static files from Amazon S3 or Whitenoise_ (optional) -* Pre configured Celery_ (optional) -* Integration with Maildump_ for local email testing (optional) -* Integration with Sentry_ for error logging (optional) -* Integration with NewRelic_ for performance monitoring (optional) -* Docker support using docker-compose_ for dev and prod +* Docker support using docker-compose_ for development and production * Procfile_ for deploying to Heroku +Optional Integrations +--------------------- + +*These features can be enabled during initial project setup.* + +* Serve static files from Amazon S3 or Whitenoise_ +* Configuration for Celery_ +* Integration with Maildump_ for local email testing +* Integration with Sentry_ for error logging +* Integration with NewRelic_ for performance monitoring + .. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest .. _Bootstrap: https://github.com/twbs/bootstrap From 9c28c8e0df4a3e7d35cda2d72b1b04673297c96a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Mon, 16 Nov 2015 08:36:51 -0300 Subject: [PATCH 237/402] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bfe913a94..ce3628867 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-16] +### Changed +- Cleanup of main README (@burhan) + +## [2015-11-15] +### Added +- Added `UserFactory` for users.User tests (@ad-m) + ## [2015-11-12] ### Changed - Update version of django-allauth (@yunti) From 005dd8c29664594ad789680e3262eac464747c59 Mon Sep 17 00:00:00 2001 From: Tom Atkins Date: Mon, 16 Nov 2015 11:45:29 +0000 Subject: [PATCH 238/402] Replace Maildump with MailHog --- README.rst | 22 ++++++++++++------- cookiecutter.json | 2 +- docs/developing-locally.rst | 11 ++++++++-- docs/project-generation-options.rst | 10 ++++----- tests/test_cookiecutter_generation.py | 2 +- {{cookiecutter.repo_name}}/Gruntfile.js | 20 +++++------------ {{cookiecutter.repo_name}}/README.rst | 21 ++++++++---------- .../config/settings/local.py | 2 +- .../requirements/local.txt | 12 ---------- 9 files changed, 46 insertions(+), 56 deletions(-) diff --git a/README.rst b/README.rst index 3a607447c..bf20b7119 100644 --- a/README.rst +++ b/README.rst @@ -32,14 +32,20 @@ Features * Grunt build for compass and livereload * Basic e-mail configurations for sending emails via Mailgun_ * Media storage using Amazon S3 -* Serve static files from Amazon S3 or Whitenoise_ (optional) -* Pre configured Celery_ (optional) -* Integration with Maildump_ for local email testing (optional) -* Integration with Sentry_ for error logging (optional) -* Integration with NewRelic_ for performance monitoring (optional) -* Docker support using docker-compose_ for dev and prod +* Docker support using docker-compose_ for development and production * Procfile_ for deploying to Heroku +Optional Integrations +--------------------- + +*These features can be enabled during initial project setup.* + +* Serve static files from Amazon S3 or Whitenoise_ +* Configuration for Celery_ +* Integration with MailHog_ for local email testing +* Integration with Sentry_ for error logging +* Integration with NewRelic_ for performance monitoring + .. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest .. _Bootstrap: https://github.com/twbs/bootstrap @@ -52,7 +58,7 @@ Features .. _Mailgun: https://mailgun.com/ .. _Whitenoise: https://whitenoise.readthedocs.org/ .. _Celery: http://www.celeryproject.org/ -.. _Maildump: https://github.com/ThiefMaster/maildump +.. _MailHog: https://github.com/mailhog/MailHog .. _Sentry: https://getsentry.com .. _NewRelic: https://newrelic.com .. _docker-compose: https://www.github.com/docker/compose @@ -107,7 +113,7 @@ It prompts you for questions. Answer them:: year [2015]: use_whitenoise [y]: n use_celery [n]: y - use_maildump [n]: n + use_mailhog [n]: n use_sentry [n]: y use_newrelic [n]: y windows [n]: n diff --git a/cookiecutter.json b/cookiecutter.json index 213c18422..c8b6deee9 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -11,7 +11,7 @@ "year": "{{ cookiecutter.now[:4] }}", "use_whitenoise": "y", "use_celery": "n", - "use_maildump": "n", + "use_mailhog": "n", "use_sentry": "n", "use_newrelic": "n", "windows": "n", diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index ae737dc4f..349c9120b 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -31,9 +31,16 @@ django-allauth sends an email to verify users (and superusers) after signup and .. _configure your email backend: http://docs.djangoproject.com/en/1.8/topics/email/#smtp-backend -In development you can (optionally) use Maildump_ for email testing. Or alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` +In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog:: -.. _Maildump: https://github.com/ThiefMaster/maildump +1. `Download the latest release`_ for your operating system +2. Rename the executable to ``mailhog`` and copy it to the root of your project directory +3. Make sure it is executable (e.g. ``chmod +x mailhog``) + +.. _Mailhog: https://github.com/mailhog/MailHog/ +.. _Download the latest release: https://github.com/mailhog/MailHog/releases + +Alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` In production basic email configuration is setup to send emails with Mailgun_ diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 2ed91bbbb..d879b8ff5 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -34,10 +34,10 @@ use_celery [n] Whether to use Celery_. This gives you the ability to use distributed task queues in your project. -use_maildump [n] - Whether to use Maildump_. Maildump is a tool that simulates email receiving - for development purposes. It runs a super simple SMTP server which catches - any message sent to it. Then messages are displayed in a web interface. +use_mailhog [n] + Whether to use MailHog_. MailHog is a tool that simulates email receiving + for development purposes. It runs a simple SMTP server which catches + any message sent to it. Messages are displayed in a web interface which runs at ``http://localhost:8025/`` You need to download the MailHog executable for your operating system, see the 'Developing Locally' docs for instructions. use_sentry [n] Whether to use Sentry_ to log errors from your project. @@ -51,5 +51,5 @@ use_python2 [n] .. _WhiteNoise: https://github.com/evansd/whitenoise .. _Celery: https://github.com/celery/celery -.. _Maildump: https://github.com/ThiefMaster/maildump +.. _MailHog: https://github.com/mailhog/MailHog .. _Sentry: https://github.com/getsentry/sentry diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index 74f8947c6..0f982660f 100644 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -62,7 +62,7 @@ def test_default_configuration(cookies, context): check_paths(paths) -@pytest.fixture(params=['use_maildump', 'use_celery', 'windows']) +@pytest.fixture(params=['use_mailhog', 'use_celery', 'windows']) def feature_context(request, context): context.update({request.param: 'y'}) return context diff --git a/{{cookiecutter.repo_name}}/Gruntfile.js b/{{cookiecutter.repo_name}}/Gruntfile.js index b88b11725..1eaade285 100644 --- a/{{cookiecutter.repo_name}}/Gruntfile.js +++ b/{{cookiecutter.repo_name}}/Gruntfile.js @@ -22,7 +22,6 @@ module.exports = function (grunt) { images: this.app + '/static/images', js: this.app + '/static/js', manageScript: 'manage.py', - {% if cookiecutter.use_maildump=="y" -%}mailserverpid: 'mailserver.pid',{%- endif %} } }; @@ -79,7 +78,7 @@ module.exports = function (grunt) { }, } }, - + //see https://github.com/nDmitry/grunt-postcss postcss: { options: { @@ -113,16 +112,16 @@ module.exports = function (grunt) { runDjango: { cmd: 'python <%= paths.manageScript %> runserver' }, - {% if cookiecutter.use_maildump == "y" -%}runMailDump: { - cmd: 'maildump -p <%= paths.mailserverpid %>' - }, - stopMailDump: { - cmd: 'maildump -p <%= paths.mailserverpid %> --stop' + {% if cookiecutter.use_mailhog == "y" -%}runMailHog: { + cmd: './mailhog' },{%- endif %} } }); grunt.registerTask('serve', [ + {% if cookiecutter.use_mailhog == "y" -%} + 'bgShell:runMailHog', + {%- endif %} 'bgShell:runDjango', 'watch' ]); @@ -135,12 +134,5 @@ module.exports = function (grunt) { grunt.registerTask('default', [ 'build' ]); - {% if cookiecutter.use_maildump == "y" -%} - grunt.registerTask('start-email-server', [ - 'bgShell:runMailDump' - ]); - grunt.registerTask('stop-email-server', [ - 'bgShell:stopMailDump' - ]);{%- endif %} }; diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index ba7dc2165..cbbe32542 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -61,28 +61,25 @@ Please note: For Celerys import magic to work, it is important *where* the celer {% endif %} -{% if cookiecutter.use_maildump == "y" %} +{% if cookiecutter.use_mailhog == "y" %} Email Server ^^^^^^^^^^^^ -In development, it is often nice to be able to see emails that are being sent from your application. For this purpose, -a Grunt task exists to start an instance of `maildump`_ which is a local SMTP server with an online interface. +In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use `MailHog`_ when generating the project a local SMTP server with a web interface will be available. -.. _maildump: https://github.com/ThiefMaster/maildump +.. _mailhog: https://github.com/mailhog/MailHog -Make sure you have nodejs installed, and then type the following:: +To start the service, make sure you have nodejs installed, and then type the following:: - $ grunt start-email-server + $ npm install + $ grunt serve -This will start an email server. The project is setup to deliver to the email server by default. To view messages -that are sent by your application, open your browser to http://127.0.0.1:1080 +(After the first run you only need to type ``grunt serve``) This will start an email server that listens on ``127.0.0.1:1025`` in addition to starting your Django project and a watch task for live reload. -To stop the email server:: +To view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025`` - $ grunt stop-email-server - -The email server listens on 127.0.0.1:1025 +The email server will exit when you exit the Grunt task on the CLI with Ctrl+C. {% endif %} diff --git a/{{cookiecutter.repo_name}}/config/settings/local.py b/{{cookiecutter.repo_name}}/config/settings/local.py index cbe5d58db..256138832 100644 --- a/{{cookiecutter.repo_name}}/config/settings/local.py +++ b/{{cookiecutter.repo_name}}/config/settings/local.py @@ -25,7 +25,7 @@ SECRET_KEY = env("DJANGO_SECRET_KEY", default='CHANGEME!!!') # ------------------------------------------------------------------------------ EMAIL_HOST = 'localhost' EMAIL_PORT = 1025 -{%if cookiecutter.use_maildump == "n" -%} +{%if cookiecutter.use_mailhog == "n" -%} EMAIL_BACKEND = env('DJANGO_EMAIL_BACKEND', default='django.core.mail.backends.console.EmailBackend') {%- endif %} diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index a9b63d442..04639e4f3 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -13,15 +13,3 @@ django-debug-toolbar==1.4 # improved REPL ipdb==0.8.1 - -{% if cookiecutter.use_maildump == "y" -%} -# Required by maildump. -{% if cookiecutter.use_python2 == 'n' -%} -# Need to pin dependency to gevent beta to be Python 3-compatible. -gevent==1.1b6 -{% else -%} -gevent==1.0.2 -{% endif -%} -# Enables better email testing -maildump==0.5.1 -{%- endif %} From 727281e99ada711d53639a9fdbb27312e0606027 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 18:55:37 +0300 Subject: [PATCH 239/402] initial configuration to support opbeat --- README.rst | 3 +++ cookiecutter.json | 1 + docs/settings.rst | 3 +++ .../config/settings/production.py | 18 +++++++++++++++++- .../requirements/production.txt | 6 ++++++ 5 files changed, 30 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a61530686..f44db0931 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,7 @@ Optional Integrations * Integration with Maildump_ for local email testing * Integration with Sentry_ for error logging * Integration with NewRelic_ for performance monitoring +* Integration with Opbeat_ for performance monitoring .. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest @@ -62,6 +63,7 @@ Optional Integrations .. _Sentry: https://getsentry.com .. _NewRelic: https://newrelic.com .. _docker-compose: https://www.github.com/docker/compose +.. _Opbeat: https://opbeat.com/ Constraints @@ -116,6 +118,7 @@ It prompts you for questions. Answer them:: use_maildump [n]: n use_sentry [n]: y use_newrelic [n]: y + use_obpeat [n]: y windows [n]: n use_python2 [n]: y diff --git a/cookiecutter.json b/cookiecutter.json index 213c18422..4367b8b1f 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -14,6 +14,7 @@ "use_maildump": "n", "use_sentry": "n", "use_newrelic": "n", + "use_opbeat": "n", "windows": "n", "use_python2": "n" } diff --git a/docs/settings.rst b/docs/settings.rst index 08a95bf09..bdd2075f3 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -41,4 +41,7 @@ DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error NEW_RELIC_LICENSE_KEY NEW_RELIC_LICENSE_KEY n/a raises error +DJANGO_OPBEAT_APP_ID OPBEAT['APP_ID'] n/a raises error +DJANGO_OPBEAT_SECRET_TOKEN OPBEAT['SECRET_TOKEN'] n/a raises error +DJANGO_OPBEAT_ORGANIZATION_ID OPBEAT['ORGANIZATION_ID'] n/a raises error ======================================= =========================== ============================================== ====================================================================== diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 27ba946e4..c065f6fca 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -9,6 +9,9 @@ Production Configurations {% if cookiecutter.use_sentry == "y" %} - Use sentry for error logging {% endif %} +{% if cookiecutter.use_opbeat == "y" %} +- Use opbeat for error reporting +{% endif %} ''' from __future__ import absolute_import, unicode_literals @@ -18,6 +21,7 @@ from django.utils import six import logging {% endif %} + from .common import * # noqa # SECRET CONFIGURATION @@ -52,7 +56,19 @@ MIDDLEWARE_CLASSES = SECURITY_MIDDLEWARE + \ MIDDLEWARE_CLASSES = SECURITY_MIDDLEWARE + MIDDLEWARE_CLASSES {%- endif %} - +{% if cookiecutter.use_opbeat == "y" -%} +# opbeat integration +# See https://opbeat.com/languages/django/ +INSTALLED_APPS += ('opbeat.contrib.django',) +OPBEAT = { + 'ORGANIZATION_ID': env('DJANGO_OPBEAT_ORGANIZATION_ID'), + 'APP_ID': env('DJANGO_OPBEAT_APP_ID'), + 'SECRET_TOKEN': env('DJANGO_OPBEAT_SECRET_TOKEN') +} +MIDDLEWARE_CLASSES += ( + 'opbeat.contrib.django.middleware.OpbeatAPMMiddleware', +) +{%- endif %} # set this to 60 seconds and then to 518400 when you can prove it works SECURE_HSTS_SECONDS = 60 SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool( diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index 4a0939a0b..b64f3dd72 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -37,3 +37,9 @@ raven # ----------------------------------------- newrelic {%- endif %} + +{% if cookiecutter.use_opbeat == "y" -%} +# Opbeat agent for performance monitoring +# ----------------------------------------- +opbeat +{%- endif %} From a68f256e5b23424a323e0ef78a0660cecf52e4de Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 19:04:07 +0300 Subject: [PATCH 240/402] fixing the middleware order --- {{cookiecutter.repo_name}}/config/settings/production.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index c065f6fca..09d11ef37 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -65,9 +65,9 @@ OPBEAT = { 'APP_ID': env('DJANGO_OPBEAT_APP_ID'), 'SECRET_TOKEN': env('DJANGO_OPBEAT_SECRET_TOKEN') } -MIDDLEWARE_CLASSES += ( +MIDDLEWARE_CLASSES = ( 'opbeat.contrib.django.middleware.OpbeatAPMMiddleware', -) +) + MIDDLEWARE_CLASSES {%- endif %} # set this to 60 seconds and then to 518400 when you can prove it works SECURE_HSTS_SECONDS = 60 From 07ec413f98b14c055c05adcda5d283bd24ceeda8 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 19:20:15 +0300 Subject: [PATCH 241/402] E303 too many blank lines fix --- {{cookiecutter.repo_name}}/config/settings/production.py | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 09d11ef37..be16818ae 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -21,7 +21,6 @@ from django.utils import six import logging {% endif %} - from .common import * # noqa # SECRET CONFIGURATION From b78b2ddf7356d5a18ee0d4969b4b98adf5501719 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 21:24:21 +0300 Subject: [PATCH 242/402] fixing error in settings --- docs/settings.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings.rst b/docs/settings.rst index 08a95bf09..78a4053a3 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -24,7 +24,7 @@ DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "your_project_name " DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "your_project_name " DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[your_project_name] " -DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['your_project_name}'] +DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['your_domain_name'] ======================================= =========================== ============================================== ====================================================================== The following table lists settings and their defaults for third-party applications, which may or may be part of your project: From 4c07b5dea68ab099cea68b8d04442d60b42f1c8f Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 18:55:37 +0300 Subject: [PATCH 243/402] initial configuration to support opbeat --- README.rst | 3 +++ cookiecutter.json | 1 + docs/settings.rst | 3 +++ .../config/settings/production.py | 18 +++++++++++++++++- .../requirements/production.txt | 6 ++++++ 5 files changed, 30 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a61530686..f44db0931 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,7 @@ Optional Integrations * Integration with Maildump_ for local email testing * Integration with Sentry_ for error logging * Integration with NewRelic_ for performance monitoring +* Integration with Opbeat_ for performance monitoring .. _alpha: http://blog.getbootstrap.com/2015/08/19/bootstrap-4-alpha/ .. _Hitch: https://github.com/hitchtest/hitchtest @@ -62,6 +63,7 @@ Optional Integrations .. _Sentry: https://getsentry.com .. _NewRelic: https://newrelic.com .. _docker-compose: https://www.github.com/docker/compose +.. _Opbeat: https://opbeat.com/ Constraints @@ -116,6 +118,7 @@ It prompts you for questions. Answer them:: use_maildump [n]: n use_sentry [n]: y use_newrelic [n]: y + use_obpeat [n]: y windows [n]: n use_python2 [n]: y diff --git a/cookiecutter.json b/cookiecutter.json index 213c18422..4367b8b1f 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -14,6 +14,7 @@ "use_maildump": "n", "use_sentry": "n", "use_newrelic": "n", + "use_opbeat": "n", "windows": "n", "use_python2": "n" } diff --git a/docs/settings.rst b/docs/settings.rst index 78a4053a3..629e60f43 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -41,4 +41,7 @@ DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error NEW_RELIC_LICENSE_KEY NEW_RELIC_LICENSE_KEY n/a raises error +DJANGO_OPBEAT_APP_ID OPBEAT['APP_ID'] n/a raises error +DJANGO_OPBEAT_SECRET_TOKEN OPBEAT['SECRET_TOKEN'] n/a raises error +DJANGO_OPBEAT_ORGANIZATION_ID OPBEAT['ORGANIZATION_ID'] n/a raises error ======================================= =========================== ============================================== ====================================================================== diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 27ba946e4..c065f6fca 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -9,6 +9,9 @@ Production Configurations {% if cookiecutter.use_sentry == "y" %} - Use sentry for error logging {% endif %} +{% if cookiecutter.use_opbeat == "y" %} +- Use opbeat for error reporting +{% endif %} ''' from __future__ import absolute_import, unicode_literals @@ -18,6 +21,7 @@ from django.utils import six import logging {% endif %} + from .common import * # noqa # SECRET CONFIGURATION @@ -52,7 +56,19 @@ MIDDLEWARE_CLASSES = SECURITY_MIDDLEWARE + \ MIDDLEWARE_CLASSES = SECURITY_MIDDLEWARE + MIDDLEWARE_CLASSES {%- endif %} - +{% if cookiecutter.use_opbeat == "y" -%} +# opbeat integration +# See https://opbeat.com/languages/django/ +INSTALLED_APPS += ('opbeat.contrib.django',) +OPBEAT = { + 'ORGANIZATION_ID': env('DJANGO_OPBEAT_ORGANIZATION_ID'), + 'APP_ID': env('DJANGO_OPBEAT_APP_ID'), + 'SECRET_TOKEN': env('DJANGO_OPBEAT_SECRET_TOKEN') +} +MIDDLEWARE_CLASSES += ( + 'opbeat.contrib.django.middleware.OpbeatAPMMiddleware', +) +{%- endif %} # set this to 60 seconds and then to 518400 when you can prove it works SECURE_HSTS_SECONDS = 60 SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool( diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index 4a0939a0b..b64f3dd72 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -37,3 +37,9 @@ raven # ----------------------------------------- newrelic {%- endif %} + +{% if cookiecutter.use_opbeat == "y" -%} +# Opbeat agent for performance monitoring +# ----------------------------------------- +opbeat +{%- endif %} From f4a75e0d1070e12b2d7de01745da77244e776b61 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 19:04:07 +0300 Subject: [PATCH 244/402] fixing the middleware order --- {{cookiecutter.repo_name}}/config/settings/production.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index c065f6fca..09d11ef37 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -65,9 +65,9 @@ OPBEAT = { 'APP_ID': env('DJANGO_OPBEAT_APP_ID'), 'SECRET_TOKEN': env('DJANGO_OPBEAT_SECRET_TOKEN') } -MIDDLEWARE_CLASSES += ( +MIDDLEWARE_CLASSES = ( 'opbeat.contrib.django.middleware.OpbeatAPMMiddleware', -) +) + MIDDLEWARE_CLASSES {%- endif %} # set this to 60 seconds and then to 518400 when you can prove it works SECURE_HSTS_SECONDS = 60 From 03edea302172c84e806acc0b2cbea10edabedec2 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Mon, 16 Nov 2015 19:20:15 +0300 Subject: [PATCH 245/402] E303 too many blank lines fix --- {{cookiecutter.repo_name}}/config/settings/production.py | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/config/settings/production.py b/{{cookiecutter.repo_name}}/config/settings/production.py index 09d11ef37..be16818ae 100644 --- a/{{cookiecutter.repo_name}}/config/settings/production.py +++ b/{{cookiecutter.repo_name}}/config/settings/production.py @@ -21,7 +21,6 @@ from django.utils import six import logging {% endif %} - from .common import * # noqa # SECRET CONFIGURATION From e4f922763fd5a26f96b0b522e2ae148095f1684a Mon Sep 17 00:00:00 2001 From: Tom Atkins Date: Mon, 16 Nov 2015 19:17:03 +0000 Subject: [PATCH 246/402] Add mailhog binary to gitignore --- {{cookiecutter.repo_name}}/.gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore index 796c7be37..73881c8c7 100644 --- a/{{cookiecutter.repo_name}}/.gitignore +++ b/{{cookiecutter.repo_name}}/.gitignore @@ -61,3 +61,6 @@ node_modules/ # Hitch directory tests/.hitch + +# MailHog binary +mailhog From e2c700da5cb50d63ff6c969db3fb901b1d014758 Mon Sep 17 00:00:00 2001 From: Burhan Khalid Date: Tue, 17 Nov 2015 10:27:58 +0300 Subject: [PATCH 247/402] updating env.example --- {{cookiecutter.repo_name}}/env.example | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index 3420db7cb..edc5454bf 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -18,3 +18,8 @@ DJANGO_SENTRY_DSN= {% if cookiecutter.use_newrelic == 'y' -%} NEW_RELIC_LICENSE_KEY {% endif %} +{% if cookiecutter.use_opbeat == 'y' -%} +DJANGO_OPBEAT_ORGANIZATION_ID +DJANGO_OPBEAT_APP_ID +DJANGO_OPBEAT_SECRET_TOKEN +{% endif %} From d69a6f020b1aadace27ac49152f03fb70e44bc12 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Tue, 17 Nov 2015 16:58:00 -0800 Subject: [PATCH 248/402] Update changelog for @burhan --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bfe913a94..2cd9349f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-17] +### Added +- initial configuration to support opbeat (@burhan) + ## [2015-11-12] ### Changed - Update version of django-allauth (@yunti) From f45b81b7a0c0a40ddcc4b66652cf45d2880d0ec0 Mon Sep 17 00:00:00 2001 From: Taylor Edmiston Date: Tue, 17 Nov 2015 22:54:29 -0500 Subject: [PATCH 249/402] Fix typo in readme --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f44db0931..407cf4114 100644 --- a/README.rst +++ b/README.rst @@ -118,7 +118,7 @@ It prompts you for questions. Answer them:: use_maildump [n]: n use_sentry [n]: y use_newrelic [n]: y - use_obpeat [n]: y + use_opbeat [n]: y windows [n]: n use_python2 [n]: y From 840f4a7d4c7143ae2f8d46be8cbb274fc8c7c3bc Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 17 Nov 2015 21:05:28 -0800 Subject: [PATCH 250/402] *.pyc is already covered by *.py[cod] No need to include it separately. --- {{cookiecutter.repo_name}}/.gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore index 796c7be37..0757b98b5 100644 --- a/{{cookiecutter.repo_name}}/.gitignore +++ b/{{cookiecutter.repo_name}}/.gitignore @@ -21,7 +21,6 @@ sftp-config.json # Basics *.py[cod] -*.pyc __pycache__ # Logs From 7eb0fc0e816545c9eae8d953e54d9ac738d2a1dc Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 17 Nov 2015 21:07:14 -0800 Subject: [PATCH 251/402] Add pyc fix to changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bfb9c09fc..70b4d8169 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-17] ### Added - initial configuration to support opbeat (@burhan) +### Removed +- Took *.pyc out of .gitignore, because it's already covered by *.py[cod] (@audreyr) ## [2015-11-16] ### Changed From 3316a3b02398ccf4f7430738af0b7b7c471525ae Mon Sep 17 00:00:00 2001 From: Tom Atkins Date: Wed, 18 Nov 2015 11:16:25 +0000 Subject: [PATCH 252/402] Fix merge conflict in README.rst --- README.rst | 6 +++--- cookiecutter.json | 2 +- docs/developing-locally.rst | 11 ++++++++-- docs/project-generation-options.rst | 10 ++++----- tests/test_cookiecutter_generation.py | 2 +- {{cookiecutter.repo_name}}/Gruntfile.js | 20 ++++++------------ {{cookiecutter.repo_name}}/README.rst | 21 ++++++++----------- .../config/settings/local.py | 2 +- .../requirements/local.txt | 12 ----------- 9 files changed, 35 insertions(+), 51 deletions(-) diff --git a/README.rst b/README.rst index f44db0931..aa15e89ea 100644 --- a/README.rst +++ b/README.rst @@ -42,7 +42,7 @@ Optional Integrations * Serve static files from Amazon S3 or Whitenoise_ * Configuration for Celery_ -* Integration with Maildump_ for local email testing +* Integration with MailHog_ for local email testing * Integration with Sentry_ for error logging * Integration with NewRelic_ for performance monitoring * Integration with Opbeat_ for performance monitoring @@ -59,7 +59,7 @@ Optional Integrations .. _Mailgun: https://mailgun.com/ .. _Whitenoise: https://whitenoise.readthedocs.org/ .. _Celery: http://www.celeryproject.org/ -.. _Maildump: https://github.com/ThiefMaster/maildump +.. _MailHog: https://github.com/mailhog/MailHog .. _Sentry: https://getsentry.com .. _NewRelic: https://newrelic.com .. _docker-compose: https://www.github.com/docker/compose @@ -115,7 +115,7 @@ It prompts you for questions. Answer them:: year [2015]: use_whitenoise [y]: n use_celery [n]: y - use_maildump [n]: n + use_mailhog [n]: n use_sentry [n]: y use_newrelic [n]: y use_obpeat [n]: y diff --git a/cookiecutter.json b/cookiecutter.json index 4367b8b1f..162d6b381 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -11,7 +11,7 @@ "year": "{{ cookiecutter.now[:4] }}", "use_whitenoise": "y", "use_celery": "n", - "use_maildump": "n", + "use_mailhog": "n", "use_sentry": "n", "use_newrelic": "n", "use_opbeat": "n", diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index ae737dc4f..349c9120b 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -31,9 +31,16 @@ django-allauth sends an email to verify users (and superusers) after signup and .. _configure your email backend: http://docs.djangoproject.com/en/1.8/topics/email/#smtp-backend -In development you can (optionally) use Maildump_ for email testing. Or alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` +In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog:: -.. _Maildump: https://github.com/ThiefMaster/maildump +1. `Download the latest release`_ for your operating system +2. Rename the executable to ``mailhog`` and copy it to the root of your project directory +3. Make sure it is executable (e.g. ``chmod +x mailhog``) + +.. _Mailhog: https://github.com/mailhog/MailHog/ +.. _Download the latest release: https://github.com/mailhog/MailHog/releases + +Alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` In production basic email configuration is setup to send emails with Mailgun_ diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 2ed91bbbb..d879b8ff5 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -34,10 +34,10 @@ use_celery [n] Whether to use Celery_. This gives you the ability to use distributed task queues in your project. -use_maildump [n] - Whether to use Maildump_. Maildump is a tool that simulates email receiving - for development purposes. It runs a super simple SMTP server which catches - any message sent to it. Then messages are displayed in a web interface. +use_mailhog [n] + Whether to use MailHog_. MailHog is a tool that simulates email receiving + for development purposes. It runs a simple SMTP server which catches + any message sent to it. Messages are displayed in a web interface which runs at ``http://localhost:8025/`` You need to download the MailHog executable for your operating system, see the 'Developing Locally' docs for instructions. use_sentry [n] Whether to use Sentry_ to log errors from your project. @@ -51,5 +51,5 @@ use_python2 [n] .. _WhiteNoise: https://github.com/evansd/whitenoise .. _Celery: https://github.com/celery/celery -.. _Maildump: https://github.com/ThiefMaster/maildump +.. _MailHog: https://github.com/mailhog/MailHog .. _Sentry: https://github.com/getsentry/sentry diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index 74f8947c6..0f982660f 100644 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -62,7 +62,7 @@ def test_default_configuration(cookies, context): check_paths(paths) -@pytest.fixture(params=['use_maildump', 'use_celery', 'windows']) +@pytest.fixture(params=['use_mailhog', 'use_celery', 'windows']) def feature_context(request, context): context.update({request.param: 'y'}) return context diff --git a/{{cookiecutter.repo_name}}/Gruntfile.js b/{{cookiecutter.repo_name}}/Gruntfile.js index b88b11725..1eaade285 100644 --- a/{{cookiecutter.repo_name}}/Gruntfile.js +++ b/{{cookiecutter.repo_name}}/Gruntfile.js @@ -22,7 +22,6 @@ module.exports = function (grunt) { images: this.app + '/static/images', js: this.app + '/static/js', manageScript: 'manage.py', - {% if cookiecutter.use_maildump=="y" -%}mailserverpid: 'mailserver.pid',{%- endif %} } }; @@ -79,7 +78,7 @@ module.exports = function (grunt) { }, } }, - + //see https://github.com/nDmitry/grunt-postcss postcss: { options: { @@ -113,16 +112,16 @@ module.exports = function (grunt) { runDjango: { cmd: 'python <%= paths.manageScript %> runserver' }, - {% if cookiecutter.use_maildump == "y" -%}runMailDump: { - cmd: 'maildump -p <%= paths.mailserverpid %>' - }, - stopMailDump: { - cmd: 'maildump -p <%= paths.mailserverpid %> --stop' + {% if cookiecutter.use_mailhog == "y" -%}runMailHog: { + cmd: './mailhog' },{%- endif %} } }); grunt.registerTask('serve', [ + {% if cookiecutter.use_mailhog == "y" -%} + 'bgShell:runMailHog', + {%- endif %} 'bgShell:runDjango', 'watch' ]); @@ -135,12 +134,5 @@ module.exports = function (grunt) { grunt.registerTask('default', [ 'build' ]); - {% if cookiecutter.use_maildump == "y" -%} - grunt.registerTask('start-email-server', [ - 'bgShell:runMailDump' - ]); - grunt.registerTask('stop-email-server', [ - 'bgShell:stopMailDump' - ]);{%- endif %} }; diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index ba7dc2165..cbbe32542 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -61,28 +61,25 @@ Please note: For Celerys import magic to work, it is important *where* the celer {% endif %} -{% if cookiecutter.use_maildump == "y" %} +{% if cookiecutter.use_mailhog == "y" %} Email Server ^^^^^^^^^^^^ -In development, it is often nice to be able to see emails that are being sent from your application. For this purpose, -a Grunt task exists to start an instance of `maildump`_ which is a local SMTP server with an online interface. +In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use `MailHog`_ when generating the project a local SMTP server with a web interface will be available. -.. _maildump: https://github.com/ThiefMaster/maildump +.. _mailhog: https://github.com/mailhog/MailHog -Make sure you have nodejs installed, and then type the following:: +To start the service, make sure you have nodejs installed, and then type the following:: - $ grunt start-email-server + $ npm install + $ grunt serve -This will start an email server. The project is setup to deliver to the email server by default. To view messages -that are sent by your application, open your browser to http://127.0.0.1:1080 +(After the first run you only need to type ``grunt serve``) This will start an email server that listens on ``127.0.0.1:1025`` in addition to starting your Django project and a watch task for live reload. -To stop the email server:: +To view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025`` - $ grunt stop-email-server - -The email server listens on 127.0.0.1:1025 +The email server will exit when you exit the Grunt task on the CLI with Ctrl+C. {% endif %} diff --git a/{{cookiecutter.repo_name}}/config/settings/local.py b/{{cookiecutter.repo_name}}/config/settings/local.py index cbe5d58db..256138832 100644 --- a/{{cookiecutter.repo_name}}/config/settings/local.py +++ b/{{cookiecutter.repo_name}}/config/settings/local.py @@ -25,7 +25,7 @@ SECRET_KEY = env("DJANGO_SECRET_KEY", default='CHANGEME!!!') # ------------------------------------------------------------------------------ EMAIL_HOST = 'localhost' EMAIL_PORT = 1025 -{%if cookiecutter.use_maildump == "n" -%} +{%if cookiecutter.use_mailhog == "n" -%} EMAIL_BACKEND = env('DJANGO_EMAIL_BACKEND', default='django.core.mail.backends.console.EmailBackend') {%- endif %} diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index a9b63d442..04639e4f3 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -13,15 +13,3 @@ django-debug-toolbar==1.4 # improved REPL ipdb==0.8.1 - -{% if cookiecutter.use_maildump == "y" -%} -# Required by maildump. -{% if cookiecutter.use_python2 == 'n' -%} -# Need to pin dependency to gevent beta to be Python 3-compatible. -gevent==1.1b6 -{% else -%} -gevent==1.0.2 -{% endif -%} -# Enables better email testing -maildump==0.5.1 -{%- endif %} From c653801d5ae72005b9307bf41277ded4e48ca016 Mon Sep 17 00:00:00 2001 From: Tom Atkins Date: Mon, 16 Nov 2015 19:17:03 +0000 Subject: [PATCH 253/402] Add mailhog binary to gitignore --- {{cookiecutter.repo_name}}/.gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore index 0757b98b5..4b288b5b7 100644 --- a/{{cookiecutter.repo_name}}/.gitignore +++ b/{{cookiecutter.repo_name}}/.gitignore @@ -60,3 +60,6 @@ node_modules/ # Hitch directory tests/.hitch + +# MailHog binary +mailhog From c5481135f2b389678e642ef9e0e6fe018d1161c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Wed, 18 Nov 2015 13:52:45 +0100 Subject: [PATCH 254/402] Use python 3.5 on Heroku --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 18104d92b..8d5e4598d 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ {% if cookiecutter.use_python2 == 'n' -%} -python-3.4.3 +python-3.5.0 {%- endif %} From 518862d328eada79d77713fda71ff8d403011778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Bogda=C5=82?= Date: Wed, 18 Nov 2015 15:07:08 +0100 Subject: [PATCH 255/402] Use python 3.5 on Travis --- {{cookiecutter.repo_name}}/.travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/.travis.yml b/{{cookiecutter.repo_name}}/.travis.yml index 9796896f6..85421fb96 100644 --- a/{{cookiecutter.repo_name}}/.travis.yml +++ b/{{cookiecutter.repo_name}}/.travis.yml @@ -9,7 +9,7 @@ before_install: language: python python: {% if cookiecutter.use_python2 == 'n' -%} - - "3.4" + - "3.5" {% else %} - "2.7" {%- endif %} From c5209bd7b5d2a533a7f239b817652c653c6d8119 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Wed, 18 Nov 2015 17:19:53 -0800 Subject: [PATCH 256/402] Updated contributors and changelog for @keybit's work --- CHANGELOG.md | 8 ++++++++ CONTRIBUTORS.rst | 1 + 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 70b4d8169..db7baf434 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,17 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-18] +### Added +- Mailhog as a replacement for Maildump + +### Removed +- Maildump because it didn't support Python 3 + ## [2015-11-17] ### Added - initial configuration to support opbeat (@burhan) + ### Removed - Took *.pyc out of .gitignore, because it's already covered by *.py[cod] (@audreyr) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 8505d2559..f6c570418 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -64,6 +64,7 @@ Code Contributors * Garry Polley / @garrypolley * Théo Segonds / show0k * Cristian Vargas / @cdvv7788 +* Tom Atkins / @keybits \* Possesses commit rights From d6de05e971e914b828243234996ec61b30c87811 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 20 Nov 2015 08:55:41 -0800 Subject: [PATCH 257/402] Updated changelog and contributors. Now including @tedmiston --- CHANGELOG.md | 9 +++++++-- CONTRIBUTORS.rst | 1 + 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db7baf434..ea55cbfd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,17 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-20] +### Changed +- Using python 3.5 on Heroku/Travis (@bogdal) +- Fixed typo in README (@tedmiston) + ## [2015-11-18] ### Added -- Mailhog as a replacement for Maildump +- Mailhog as a replacement for Maildump (@keybits ) ### Removed -- Maildump because it didn't support Python 3 +- Maildump because it didn't support Python 3 (@keybits) ## [2015-11-17] ### Added diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index f6c570418..f54244e0a 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -65,6 +65,7 @@ Code Contributors * Théo Segonds / show0k * Cristian Vargas / @cdvv7788 * Tom Atkins / @keybits +* Taylor Edmiston / @tedmiston \* Possesses commit rights From 733071f121cdbc314d2725b2e1a1d9b928c2040e Mon Sep 17 00:00:00 2001 From: Jan Van Bruggen Date: Sun, 22 Nov 2015 08:38:36 -0800 Subject: [PATCH 258/402] Move div class unquote outside the if tag --- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 1afc57c31..16ecd6247 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -76,7 +76,7 @@ {% if messages %} {% for message in messages %} -
{{ message }}
+
{{ message }}
{% endfor %} {% endif %} From 1d9e0960bc4e689658f12907b33f01dc350251e4 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Sun, 22 Nov 2015 13:56:55 -0300 Subject: [PATCH 259/402] add Jan Van Bruggen to CONTRIBUTORS. Update CHANGELOG --- CHANGELOG.md | 4 ++++ CONTRIBUTORS.rst | 1 + 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ea55cbfd3..8c2db0508 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-22] +### Changed +- Move div class unquote outside the django if tag (@jvanbrug) + ## [2015-11-20] ### Changed - Using python 3.5 on Heroku/Travis (@bogdal) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index f54244e0a..9cbc4ed3e 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -66,6 +66,7 @@ Code Contributors * Cristian Vargas / @cdvv7788 * Tom Atkins / @keybits * Taylor Edmiston / @tedmiston +* Jan Van Bruggen / @jvanbrug \* Possesses commit rights From dc47e19a03a2632ad85564d1770c071512813d54 Mon Sep 17 00:00:00 2001 From: Jon Miller Date: Sun, 22 Nov 2015 15:42:35 -0600 Subject: [PATCH 260/402] Change gevent from 1.0.2 to 1.1rc1 to support Py35. --- {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index b64f3dd72..b262cbf03 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -11,7 +11,7 @@ psycopg2==2.6.1 # WSGI Handler # ------------------------------------------------ -gevent==1.0.2 +gevent==1.1rc1 gunicorn==19.3.0 # Static and Media Storage From a5675f89e4692980f4961e3bd61c6bc834c98d44 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sun, 22 Nov 2015 23:24:25 +0100 Subject: [PATCH 261/402] Make sure that python 2 users can stay on stable --- {{cookiecutter.repo_name}}/requirements/production.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index b262cbf03..f28071e0a 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -11,7 +11,12 @@ psycopg2==2.6.1 # WSGI Handler # ------------------------------------------------ +{% if cookiecutter.use_python2 == 'y' -%} +gevent==1.0.2 +{% else %} +# there's no python 3 support in stable, have to use the latest release candidate for gevent gevent==1.1rc1 +{% endif %} gunicorn==19.3.0 # Static and Media Storage From 20ea440cc27290622b544c9c881a20f5856edf27 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sun, 22 Nov 2015 23:27:11 +0100 Subject: [PATCH 262/402] add gevent python3 fix to the changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c2db0508..6200b7fea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-22] ### Changed - Move div class unquote outside the django if tag (@jvanbrug) +- Changed gevent to `1.1rc1` for python 3 users (@jondelmil / @jayfk) ## [2015-11-20] ### Changed From 5aec6203c229eb15268c8c10963571e97b8474b3 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sun, 22 Nov 2015 23:28:27 +0100 Subject: [PATCH 263/402] add Jon Miller to contributors --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 9cbc4ed3e..0e1bf141a 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -67,6 +67,7 @@ Code Contributors * Tom Atkins / @keybits * Taylor Edmiston / @tedmiston * Jan Van Bruggen / @jvanbrug +* Jon Miller / @jondelmil \* Possesses commit rights From 609214576059454098d69e833e5c30bd4769d8f9 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Mon, 23 Nov 2015 21:15:11 -0300 Subject: [PATCH 264/402] update requirements --- CHANGELOG.md | 6 ++++++ README.rst | 2 +- requirements.txt | 6 +++--- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- {{cookiecutter.repo_name}}/requirements/local.txt | 6 +++--- {{cookiecutter.repo_name}}/requirements/test.txt | 4 ++-- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 6 +++--- .../{{cookiecutter.repo_name}}/templates/base.html | 2 +- 8 files changed, 20 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6200b7fea..111f20078 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-23] +### Changed +- Update AngularJS version to 1.4.8 (@luzfcb) +- Update version of cookiecutter, pytest, tox, whitenoise, django-test-plus, django_coverage_plugin, Werkzeug, hitchserve, tornado, unixpackage (@luzfcb) +- Update 'now' date in cookiecutter.json (@luzfcb) + ## [2015-11-22] ### Changed - Move div class unquote outside the django if tag (@jvanbrug) diff --git a/README.rst b/README.rst index 927246354..d6bfbfdea 100644 --- a/README.rst +++ b/README.rst @@ -111,7 +111,7 @@ It prompts you for questions. Answer them:: domain_name [example.com]: myreddit.com version [0.1.0]: 0.0.1 timezone [UTC]: - now [2015/01/13]: 2015/09/30 + now [2015/11/22]: 2015/11/22 year [2015]: use_whitenoise [y]: n use_celery [n]: y diff --git a/requirements.txt b/requirements.txt index aadbfa9ee..4c9e23877 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -cookiecutter==1.2.1 +cookiecutter==1.3.0 flake8==2.5.0 sh binaryornot==0.4.0 @@ -10,8 +10,8 @@ ipython==4.0.0 # Testing # ------------------------------------- -pytest==2.8.2 +pytest==2.8.3 git+git://github.com/mverteuil/pytest-ipdb.git pep8==1.6.2 pyflakes==1.0.0 -tox==2.1.1 +tox==2.2.1 diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 853abcfcf..1d015b50c 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -5,7 +5,7 @@ django==1.8.6 django-environ==0.4.0 django-secure==1.0.1 {% if cookiecutter.use_whitenoise == 'y' -%} -whitenoise==2.0.4 +whitenoise==2.0.6 {%- endif %} diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index 04639e4f3..d91e2e3da 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,11 +1,11 @@ # Local development dependencies go here -r base.txt coverage==4.0.2 -django_coverage_plugin==1.0 +django_coverage_plugin==1.1 Sphinx django-extensions==1.5.9 -Werkzeug==0.10.4 -django-test-plus==1.0.9 +Werkzeug==0.11.2 +django-test-plus==1.0.11 factory_boy==2.6.0 # django-debug-toolbar that works with Django 1.5+ diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index b12b4d231..c55494324 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -8,7 +8,7 @@ psycopg2==2.6.1 {%- endif %} coverage==4.0.2 -django_coverage_plugin==1.0 +django_coverage_plugin==1.1 flake8==2.5.0 -django-test-plus==1.0.9 +django-test-plus==1.0.11 factory_boy==2.6.0 diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index 36f791a26..d59a198ad 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -8,7 +8,7 @@ hitchpostgres==0.6.7 hitchpython==0.5.0 hitchredis==0.4.5 hitchselenium==0.4.8 -hitchserve==0.4.5 +hitchserve==0.4.6 hitchsmtp==0.2.1 hitchsystem==0.1.1 hitchtest==0.9.2 @@ -33,7 +33,7 @@ selenium==2.48.0 simplegeneric==0.8.1 six==1.10.0 tblib==1.1.0 -tornado==4.2.1 +tornado==4.3 traitlets==4.0.0 -unixpackage==0.3.7 +unixpackage==0.4.0 xeger==0.3 diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index 16ecd6247..caf7a1bdb 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -24,7 +24,7 @@ {% endblock %} {% block angular %} - + {% endblock %} From 0ef11d1818e893186cff1ad963c7922012674471 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Mon, 23 Nov 2015 23:11:52 -0300 Subject: [PATCH 265/402] sh package version pinned to 1.11 --- CHANGELOG.md | 1 + requirements.txt | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 111f20078..65f46356e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Update AngularJS version to 1.4.8 (@luzfcb) - Update version of cookiecutter, pytest, tox, whitenoise, django-test-plus, django_coverage_plugin, Werkzeug, hitchserve, tornado, unixpackage (@luzfcb) - Update 'now' date in cookiecutter.json (@luzfcb) +- `sh` package version pinned to `1.11` (@luzfcb) ## [2015-11-22] ### Changed diff --git a/requirements.txt b/requirements.txt index 4c9e23877..fc7dd5934 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ cookiecutter==1.3.0 flake8==2.5.0 -sh +sh==1.11 binaryornot==0.4.0 # Debugging From d33e673c3cccbd7dee016e72f1cb94ba8770d204 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Tue, 24 Nov 2015 20:14:01 -0300 Subject: [PATCH 266/402] update requirements --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- {{cookiecutter.repo_name}}/requirements/local.txt | 2 +- {{cookiecutter.repo_name}}/requirements/test.txt | 2 +- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 2 +- 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 65f46356e..0b0cc4d59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-24] +### Changed +- Update version of Django, coverage and click (@luzfcb) + ## [2015-11-23] ### Changed - Update AngularJS version to 1.4.8 (@luzfcb) diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 1d015b50c..50fefc55f 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -1,5 +1,5 @@ # Bleeding edge Django -django==1.8.6 +django==1.8.7 # Configuration django-environ==0.4.0 diff --git a/{{cookiecutter.repo_name}}/requirements/local.txt b/{{cookiecutter.repo_name}}/requirements/local.txt index d91e2e3da..d0e65d51d 100644 --- a/{{cookiecutter.repo_name}}/requirements/local.txt +++ b/{{cookiecutter.repo_name}}/requirements/local.txt @@ -1,6 +1,6 @@ # Local development dependencies go here -r base.txt -coverage==4.0.2 +coverage==4.0.3 django_coverage_plugin==1.1 Sphinx django-extensions==1.5.9 diff --git a/{{cookiecutter.repo_name}}/requirements/test.txt b/{{cookiecutter.repo_name}}/requirements/test.txt index c55494324..384ff9004 100644 --- a/{{cookiecutter.repo_name}}/requirements/test.txt +++ b/{{cookiecutter.repo_name}}/requirements/test.txt @@ -7,7 +7,7 @@ psycopg2==2.6.1 {%- endif %} -coverage==4.0.2 +coverage==4.0.3 django_coverage_plugin==1.1 flake8==2.5.0 django-test-plus==1.0.11 diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index d59a198ad..b2f0441fa 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -1,4 +1,4 @@ -click==5.1 +click==6.0 colorama==0.3.3 decorator==4.0.4 docopt==0.6.2 From c9f500116d0ffe4bf95ee7e9a036538dac74f87f Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Tue, 24 Nov 2015 22:00:16 -0300 Subject: [PATCH 267/402] fix celery configuration in local.py --- CHANGELOG.md | 1 + {{cookiecutter.repo_name}}/config/settings/local.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b0cc4d59..aba8a4bb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-24] ### Changed - Update version of Django, coverage and click (@luzfcb) +- Fixed configuration for Celery in local.py. (@luzfcb @hackebrot) ## [2015-11-23] ### Changed diff --git a/{{cookiecutter.repo_name}}/config/settings/local.py b/{{cookiecutter.repo_name}}/config/settings/local.py index 256138832..cee3e9cc6 100644 --- a/{{cookiecutter.repo_name}}/config/settings/local.py +++ b/{{cookiecutter.repo_name}}/config/settings/local.py @@ -60,7 +60,7 @@ INSTALLED_APPS += ('django_extensions', ) # TESTING # ------------------------------------------------------------------------------ TEST_RUNNER = 'django.test.runner.DiscoverRunner' -{% if cookiecutter.celery_support == "y" %} +{% if cookiecutter.use_celery == "y" %} ########## CELERY # In development, all tasks will be executed locally by blocking until the task returns CELERY_ALWAYS_EAGER = True From fa46eb7cc2133d068ff65c4c36db842045ea2f4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 25 Nov 2015 09:35:17 -0300 Subject: [PATCH 268/402] update psutil version to 3.3.0 --- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index b2f0441fa..f1db80fc8 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -21,7 +21,7 @@ path.py==8.1.2 patool==1.8 pexpect==4.0.1 pickleshare==0.5 -psutil==3.2.2 +psutil==3.3.0 ptyprocess==0.5 pykwalify==1.5.0 python-build==0.2.5 From 6f0c2af33aabaa699222ac5e2ccb4e9c1bff413b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 25 Nov 2015 09:36:10 -0300 Subject: [PATCH 269/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index aba8a4bb1..091e73d35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-25] +### Changed +- Update version of psutil (@luzfcb) + ## [2015-11-24] ### Changed - Update version of Django, coverage and click (@luzfcb) From 7b949ba6cc9a92ed4d3a4b93c56b253e7c2cb325 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Wed, 25 Nov 2015 08:20:19 -0800 Subject: [PATCH 270/402] Update gunicorn to 19.4.1. --- CHANGELOG.md | 1 + {{cookiecutter.repo_name}}/requirements/production.txt | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 091e73d35..12fb54e22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-25] ### Changed - Update version of psutil (@luzfcb) +- Update version of gunicorn (@audreyr) ## [2015-11-24] ### Changed diff --git a/{{cookiecutter.repo_name}}/requirements/production.txt b/{{cookiecutter.repo_name}}/requirements/production.txt index f28071e0a..fedfa4817 100644 --- a/{{cookiecutter.repo_name}}/requirements/production.txt +++ b/{{cookiecutter.repo_name}}/requirements/production.txt @@ -17,7 +17,7 @@ gevent==1.0.2 # there's no python 3 support in stable, have to use the latest release candidate for gevent gevent==1.1rc1 {% endif %} -gunicorn==19.3.0 +gunicorn==19.4.1 # Static and Media Storage # ------------------------------------------------ From 59a6c637acece68910014df696a8acfe0fc7235b Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Wed, 25 Nov 2015 08:33:06 -0800 Subject: [PATCH 271/402] Remove debugging tools from non-generated part of project, since those are personal prefs. --- requirements.txt | 7 ------- 1 file changed, 7 deletions(-) diff --git a/requirements.txt b/requirements.txt index fc7dd5934..a1f3fae82 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,15 +3,8 @@ flake8==2.5.0 sh==1.11 binaryornot==0.4.0 -# Debugging -# ------------------------------------- -ipdb==0.8.1 -ipython==4.0.0 - # Testing -# ------------------------------------- pytest==2.8.3 -git+git://github.com/mverteuil/pytest-ipdb.git pep8==1.6.2 pyflakes==1.0.0 tox==2.2.1 From fdf17c7e32214fca44d5d8870eaeda996b5a383d Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Wed, 25 Nov 2015 08:35:13 -0800 Subject: [PATCH 272/402] Update changelog about removing debugging tools. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12fb54e22..7760e655e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Update version of psutil (@luzfcb) - Update version of gunicorn (@audreyr) +- Remove debugging tools from non-generated part of cookiecutter-django, since those are personal prefs (@audreyr) ## [2015-11-24] ### Changed From 28311e7502576ff2cd5b10d7e4ade84360dc8a44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 25 Nov 2015 14:35:07 -0300 Subject: [PATCH 273/402] update version of ipython --- {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index f1db80fc8..8c2bff5d3 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -13,7 +13,7 @@ hitchsmtp==0.2.1 hitchsystem==0.1.1 hitchtest==0.9.2 humanize==0.5.1 -ipython==4.0.0 +ipython==4.0.1 ipython-genutils==0.1.0 Jinja2==2.8 MarkupSafe==0.23 From 63b1f07cd2e447da785b1bbc2fc9a65d50e17470 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 25 Nov 2015 14:35:56 -0300 Subject: [PATCH 274/402] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7760e655e..0dfa4bdb7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-11-25] ### Changed -- Update version of psutil (@luzfcb) +- Update version of psutil, ipython (@luzfcb) - Update version of gunicorn (@audreyr) - Remove debugging tools from non-generated part of cookiecutter-django, since those are personal prefs (@audreyr) From 252d005e774900945baca58666c922798b9e159a Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Wed, 25 Nov 2015 16:29:53 -0300 Subject: [PATCH 275/402] update version of django in setup.py --- CHANGELOG.md | 1 + setup.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0dfa4bdb7..011457607 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Update version of psutil, ipython (@luzfcb) - Update version of gunicorn (@audreyr) - Remove debugging tools from non-generated part of cookiecutter-django, since those are personal prefs (@audreyr) +- Update version of Django in setup.py (@luzfcb) ## [2015-11-24] ### Changed diff --git a/setup.py b/setup.py index 00438c8da..fb6c9a317 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ except ImportError: # Our version ALWAYS matches the version of Django we support # If Django has a new release, we branch, tag, then update this setting after the tag. -version = "1.8.6" +version = "1.8.7" if sys.argv[-1] == 'tag': os.system("git tag -a %s -m 'version %s'" % (version, version)) From ae42895c09f67dcc4f6ffc989f52d5e3794d6899 Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Sun, 29 Nov 2015 10:24:03 -0300 Subject: [PATCH 276/402] update requirements --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/tests/hitchreqs.txt | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 011457607..75bdc50eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-11-29] +### Changed +- Update version of click and python-build (@luzfcb) + ## [2015-11-25] ### Changed - Update version of psutil, ipython (@luzfcb) diff --git a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt index 8c2bff5d3..4b9cd6836 100644 --- a/{{cookiecutter.repo_name}}/tests/hitchreqs.txt +++ b/{{cookiecutter.repo_name}}/tests/hitchreqs.txt @@ -1,4 +1,4 @@ -click==6.0 +click==6.2 colorama==0.3.3 decorator==4.0.4 docopt==0.6.2 @@ -24,7 +24,7 @@ pickleshare==0.5 psutil==3.3.0 ptyprocess==0.5 pykwalify==1.5.0 -python-build==0.2.5 +python-build==0.2.6 python-dateutil==2.4.2 pyuv==1.2.0 PyYAML==3.11 From 917bf99ea3e773dd194d6344d5460ac4bc433f46 Mon Sep 17 00:00:00 2001 From: Thomas Korrison Date: Tue, 1 Dec 2015 14:09:50 +0000 Subject: [PATCH 277/402] Update developing-locally.rst --- docs/developing-locally.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 349c9120b..b3c533eff 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -9,7 +9,11 @@ The steps below will get you up and running with a local development environment * virtualenv * PostgreSQL -First make sure to create and activate a virtualenv_, then open a terminal at the project root and install the requirements for local development:: +First make sure to create and activate a virtualenv_, then open a terminal at the project root and install the os dependencies:: + + $ ./install_os_dependencies.sh install + +Then install the requirements for your local development:: $ pip install -r requirements/local.txt From a304e466a5e9252e78ba63379a303813699029b1 Mon Sep 17 00:00:00 2001 From: Thomas Korrison Date: Tue, 1 Dec 2015 14:25:55 +0000 Subject: [PATCH 278/402] Update developing-locally.rst --- docs/developing-locally.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index b3c533eff..44fb6b7fb 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -11,7 +11,7 @@ The steps below will get you up and running with a local development environment First make sure to create and activate a virtualenv_, then open a terminal at the project root and install the os dependencies:: - $ ./install_os_dependencies.sh install + $ sudo ./install_os_dependencies.sh install Then install the requirements for your local development:: From a24ff2c4a75be9ecf12356e335075783723be958 Mon Sep 17 00:00:00 2001 From: Thomas Korrison Date: Tue, 1 Dec 2015 14:28:21 +0000 Subject: [PATCH 279/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 75bdc50eb..66ddcb9fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-01] +### Changed +- Update documentation to include the installation os dependecies before development requirements (@failsafe86) + ## [2015-11-29] ### Changed - Update version of click and python-build (@luzfcb) From 564cacd87bb73b5a87d1a50e40396abdc9e50640 Mon Sep 17 00:00:00 2001 From: Thomas Korrison Date: Tue, 1 Dec 2015 14:29:56 +0000 Subject: [PATCH 280/402] Update CONTRIBUTORS.rst --- CONTRIBUTORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 0e1bf141a..51bac95bf 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -68,6 +68,7 @@ Code Contributors * Taylor Edmiston / @tedmiston * Jan Van Bruggen / @jvanbrug * Jon Miller / @jondelmil +* Thomas Korrison / @failsafe86 \* Possesses commit rights From 062d6d31a4d796ae5cfc96fc07624ef0373798b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Wed, 2 Dec 2015 08:36:15 -0300 Subject: [PATCH 281/402] pin requires.io django version to < 1.9 --- {{cookiecutter.repo_name}}/requirements/base.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index 50fefc55f..eac71dee2 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -1,5 +1,5 @@ # Bleeding edge Django -django==1.8.7 +django==1.8.7 # rq.filter: >=1.8,<1.9 # Configuration django-environ==0.4.0 From cc1da172f4ee46ab2ca8ea550fa92633976086d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20D=C3=ADaz?= Date: Sat, 5 Dec 2015 20:12:53 +0100 Subject: [PATCH 282/402] [IMP] django-allauth configuration: Allow enable or disable user registration using ACCOUNT_ALLOW_REGISTRATION setting. --- CONTRIBUTORS.rst | 1 + docs/settings.rst | 7 +++++++ .../config/settings/common.py | 3 +++ .../{{cookiecutter.repo_name}}/users/adapter.py | 14 ++++++++++++++ 4 files changed, 25 insertions(+) create mode 100644 {{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/adapter.py diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 51bac95bf..0646e6684 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -69,6 +69,7 @@ Code Contributors * Jan Van Bruggen / @jvanbrug * Jon Miller / @jondelmil * Thomas Korrison / @failsafe86 +* David Díaz / @DavidDiazPinto * \* Possesses commit rights diff --git a/docs/settings.rst b/docs/settings.rst index 629e60f43..aec7c5137 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -45,3 +45,10 @@ DJANGO_OPBEAT_APP_ID OPBEAT['APP_ID'] n/a DJANGO_OPBEAT_SECRET_TOKEN OPBEAT['SECRET_TOKEN'] n/a raises error DJANGO_OPBEAT_ORGANIZATION_ID OPBEAT['ORGANIZATION_ID'] n/a raises error ======================================= =========================== ============================================== ====================================================================== + +-------------- +Other Settings +-------------- + +ACCOUNT_ALLOW_REGISTRATION (=True) + Allow enable or disable user registration through `django-allauth` without disabling other characteristics like authentication and account management. \ No newline at end of file diff --git a/{{cookiecutter.repo_name}}/config/settings/common.py b/{{cookiecutter.repo_name}}/config/settings/common.py index a0ab6063e..0a5deebef 100644 --- a/{{cookiecutter.repo_name}}/config/settings/common.py +++ b/{{cookiecutter.repo_name}}/config/settings/common.py @@ -211,6 +211,9 @@ AUTHENTICATION_BACKENDS = ( ACCOUNT_AUTHENTICATION_METHOD = 'username' ACCOUNT_EMAIL_REQUIRED = True ACCOUNT_EMAIL_VERIFICATION = 'mandatory' +ACCOUNT_ADAPTER = '{{cookiecutter.repo_name}}.users.adapter.AccountAdapter' +SOCIALACCOUNT_ADAPTER = '{{cookiecutter.repo_name}}.users.adapter.SocialAccountAdapter' +ACCOUNT_ALLOW_REGISTRATION = True # Custom user app defaults # Select the correct user model diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/adapter.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/adapter.py new file mode 100644 index 000000000..1d4dda1c6 --- /dev/null +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/users/adapter.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8 -*- +from django.conf import settings +from allauth.account.adapter import DefaultAccountAdapter +from allauth.socialaccount.adapter import DefaultSocialAccountAdapter + + +class AccountAdapter(DefaultAccountAdapter): + def is_open_for_signup(self, request): + return getattr(settings, 'ACCOUNT_ALLOW_REGISTRATION', True) + + +class SocialAccountAdapter(DefaultSocialAccountAdapter): + def is_open_for_signup(self, request): + return getattr(settings, 'ACCOUNT_ALLOW_REGISTRATION', True) From 677927d78675a02f452b3add91610d9905425bc7 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 6 Dec 2015 16:07:42 -0800 Subject: [PATCH 283/402] Merge of @burhans reorg --- CHANGELOG.md | 6 +- CONTRIBUTORS.rst | 198 ++++++++++++++++++++++++++++++----------------- 2 files changed, 133 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66ddcb9fb..85b02a9ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,13 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-06] +### Changed +- Reorganization of contributors (@burhan) + ## [2015-12-01] ### Changed -- Update documentation to include the installation os dependecies before development requirements (@failsafe86) +- Update documentation to include the installation os dependencies before development requirements (@failsafe86) ## [2015-11-29] ### Changed diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 51bac95bf..3e56e3948 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -1,82 +1,140 @@ Code Contributors ================= -* Daniel Greenfeld * -* a7p -* Lukas Klein -* Ben Lopatin -* Bouke Haarsma -* Agam Dua -* Vitaly Babiy -* Jim Munro * -* Tom Offermann -* Lyla Fischer -* Taylor Baldwin -* Chris Curvey (@ccurvey) -* Fábio C. Barrionuevo da Luz (@luzfcb) * -* Saurabh Kumar (gh: theskumar / @_theskumar) * -* Ashley Camba -* Yaroslav Halchenko -* Pablo / @oubiga -* Tom Atkins / @knitatoms -* Julio Castillo / @juliocc -* Kevin A. Stone -* mozillazg / @mozillazg -* Henrique G. G. Pereira / @ikkebr -* Travis McNeill / gh: Tavistock / @tavistock_esq -* Matt Linares -* Russell Davies -* Sławek Ehlert / @slafs -* Alberto Sanchez / @alb3rto -* Eyad Al Sibai / @eyadsibai -* Chris Franklin -* Benjamin Abel -* Felipe Arruda / @arruda -* Matt Warren / @mfwarren -* Martin Blech -* Andy Rose -* Andrew Mikhnevich / @zcho -* Kevin Ndung'u / @kevgathuku -* Kaveh / @ka7eh -* Alex Tsai / @caffodian -* Garry Cairns / @garry-cairns -* Lin Xianyi / @iynaix -* Adam Dobrawy / @ad-m -* Daniele Tricoli / @eriol -* Harry Percival / @hjwp -* Cullen Rhodes / @c-rhodes -* Burhan Khalid / @burhan -* Audrey Roy Greenfeld / @audreyr (and creator/maintainer of cookiecutter) * -* Jannis Gebauer / @jayfk * -* stepmr / @stepmr -* Adam Bogdał / @bogdal -* Barclay Gauld / @yunti -* Ian Lee / @IanLee1521 -* Roman Afanaskin / @siauPatrick -* @kaidokert -* Raphael Pierzina / @hackebrot -* Alvaro [Andor] / @andor-pierdelacabeza -* Chris Franklin / @hairychris -* Anna Callahan / @jazztpt -* Mathijs Hoogland / @MathijsHoogland -* Chris Pappalardo / @ChrisPappalardo -* Amjith Ramanujam / @amjith -* Garry Polley / @garrypolley -* Théo Segonds / show0k -* Cristian Vargas / @cdvv7788 -* Tom Atkins / @keybits -* Taylor Edmiston / @tedmiston -* Jan Van Bruggen / @jvanbrug -* Jon Miller / @jondelmil -* Thomas Korrison / @failsafe86 +These contributors have commit flags for the repository, +and are able to accept and merge pull requests. -\* Possesses commit rights +=========================== ============= =========== +Name Github Twitter +=========================== ============= =========== +Daniel Greenfeld `@pydanny`_ @pydanny +Audrey Roy Greenfeld* `@audreyr`_ +Jim Munro +Fábio C. Barrionuevo da Luz @luzfcb +Saurabh Kumar `@theskumar`_ @_theskumar +Jannis Gebauer `@jayfk`_ +=========================== ============= =========== + +*Audrey is also the maintainer of cookiecutter.* + +.. _@pydanny: https://github.com/pydanny +.. _@luzfcb: https://github.com/luzfcb +.. _@theskumar: https://github.com/theskumar +.. _@audreyr: https://github.com/audreyr +.. _@jayfk: https://github.com/jayfk Special Thanks -============== +-------------- The following haven't provided code directly, but have provided guidance and advice. * Jannis Leidel (django-configurations) * Nate Aune * Barry Morrison + +Contributors +------------ +Listed in alphabetical order + +========================== ============================ ============== + Name Github Twitter +========================== ============================ ============== + a7p `@a7p`_ + Adam Bogdał `@bogdal`_ + Adam Dobrawy `@ad-m`_ + Agam Dua + Alberto Sanchez `@alb3rto`_ + Alex Tsai `@caffodian`_ + Alvaro [Andor] `@andor-pierdelacabeza`_ + Amjith Ramanujam `@amjith`_ + Andrew Mikhnevich `@zcho`_ + Andy Rose + Anna Callahan `@jazztpt`_ + Ashley Camba + Barclay Gauld `@yunti`_ + Ben Lopatin + Benjamin Abel + Bouke Haarsma + Burhan Khalid `@burhan`_ @burhan + Chris Curvey `@ccurvey`_ + Chris Franklin + Chris Franklin `@hairychris`_ + Chris Pappalardo `@ChrisPappalardo`_ + Cristian Vargas `@cdvv7788`_ + Cullen Rhodes `@c-rhodes`_ + Daniele Tricoli `@eriol`_ + Eyad Al Sibai `@eyadsibai`_ + Felipe Arruda `@arruda`_ + Garry Cairns `@garry-cairns`_ + Garry Polley `@garrypolley`_ + Harry Percival `@hjwp`_ + Henrique G. G. Pereira `@ikkebr`_ + Ian Lee `@IanLee1521`_ + Julio Castillo `@juliocc`_ + Kaido Kert `@kaidokert`_ + Kaveh `@ka7eh`_ + Kevin A. Stone + Kevin Ndung'u `@kevgathuku`_ + Lin Xianyi `@iynaix`_ + Lukas Klein + Lyla Fischer + Martin Blech + Mathijs Hoogland `@MathijsHoogland`_ + Matt Linares + Matt Warren `@mfwarren`_ + mozillazg `@mozillazg`_ + Pablo `@oubiga`_ + Raphael Pierzina `@hackebrot`_ + Roman Afanaskin `@siauPatrick`_ + Russell Davies + stepmr `@stepmr`_ + Sławek Ehlert `@slafs`_ + Taylor Baldwin + Théo Segonds `@show0k`_ + Tom Atkins `@knitatoms`_ + Tom Offermann + Travis McNeill `@Travistock`_ @tavistock_esq + Vitaly Babiy + Yaroslav Halchenko +========================== ============================ ============== + +.. _@a7p: https://github.com/a7p +.. _@bogdal: https://github.com/bogdal +.. _@ad-m: https://github.com/ad-m +.. _@alb3rto: https://github.com/alb3rto +.. _@caffodian: https://github.com/caffodian +.. _@andor-pierdelacabeza: https://github.com/andor-pierdelacabeza +.. _@amjith: https://github.com/amjith +.. _@zcho: https://github.com/zcho +.. _@jazztpt: https://github.com/jazztpt +.. _@yunti: https://github.com/yunti +.. _@burhan: https://github.com/burhan +.. _@ccurvey: https://github.com/ccurvey +.. _@hairychris: https://github.com/hairychris +.. _@ChrisPappalardo: https://github.com/ChrisPappalardo +.. _@cdvv7788: https://github.com/cdvv7788 +.. _@c-rhodes: https://github.com/c-rhodes +.. _@eriol: https://github.com/eriol +.. _@eyadsibai: https://github.com/eyadsibai +.. _@arruda: https://github.com/arruda +.. _@garry-cairns: https://github.com/garry-cairns +.. _@garrypolley: https://github.com/garrypolley +.. _@hjwp: https://github.com/hjwp +.. _@ikkebr: https://github.com/ikkebr +.. _@IanLee1521: https://github.com/IanLee1521 +.. _@juliocc: https://github.com/juliocc +.. _@kaidokert: https://github.com/kaidokert +.. _@ka7eh: https://github.com/ka7eh +.. _@kevgathuku: https://github.com/kevgathuku +.. _@iynaix: https://github.com/iynaix +.. _@MathijsHoogland: https://github.com/MathijsHoogland +.. _@mfwarren: https://github.com/mfwarren +.. _@mozillazg: https://github.com/mozillazg +.. _@oubiga: https://github.com/oubiga +.. _@hackebrot: https://github.com/hackebrot +.. _@siauPatrick: https://github.com/siauPatrick +.. _@stepmr: https://github.com/stepmr +.. _@slafs: https://github.com/slafs +.. _@show0k: https://github.com/show0k +.. _@knitatoms: https://github.com/knitatoms +.. _@Travistock: https://github.com/Tavistock From 21f5637a651729ef3f3170e8fa4909f9954d3313 Mon Sep 17 00:00:00 2001 From: Sydney Henry Date: Tue, 8 Dec 2015 22:10:46 -0700 Subject: [PATCH 284/402] SECRET_KEY gen to short when `heroku run python manage.py check --deploy` is ran this error occurs ?: (security.W009) Your SECRET_KEY has less than 50 characters or less than 5 unique characters. Please generate a long and random SECRET_KEY, otherwise many of Django's security-critical features will be vulnerable to attack. changing the num of ran to a larger number fixes this issue --- docs/deployment-on-heroku.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index d0d5abc9e..c681d508c 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -16,8 +16,8 @@ You can either push the 'deploy' button in your generated README.rst or run thes heroku addons:create heroku-redis:hobby-dev heroku addons:create mailgun - heroku config:set DJANGO_ADMIN_URL=`openssl rand -base64 32` - heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 32` + heroku config:set DJANGO_ADMIN_URL=`openssl rand -base64 64` + heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 64` heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' From 4291243a9c3c66f8bf04f7b1fd9547df9abc96f4 Mon Sep 17 00:00:00 2001 From: Sydney Henry Date: Tue, 8 Dec 2015 22:16:22 -0700 Subject: [PATCH 285/402] Keep admin url short --- docs/deployment-on-heroku.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index c681d508c..82bdbace4 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -16,7 +16,7 @@ You can either push the 'deploy' button in your generated README.rst or run thes heroku addons:create heroku-redis:hobby-dev heroku addons:create mailgun - heroku config:set DJANGO_ADMIN_URL=`openssl rand -base64 64` + heroku config:set DJANGO_ADMIN_URL=`openssl rand -base64 32` heroku config:set DJANGO_SECRET_KEY=`openssl rand -base64 64` heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production' heroku config:set DJANGO_ALLOWED_HOSTS='.herokuapp.com' From c2e79902bf3f2c7d00531a1de2a920be2050e4ac Mon Sep 17 00:00:00 2001 From: areski Date: Wed, 9 Dec 2015 13:33:17 +0100 Subject: [PATCH 286/402] Bump Django to v1.9 --- README.rst | 2 +- docs/developing-locally.rst | 2 +- setup.py | 2 +- {{cookiecutter.repo_name}}/requirements/base.txt | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index d6bfbfdea..d020aa71a 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ A Cookiecutter_ template for Django. Features --------- -* For Django 1.8 +* For Django 1.9 * Renders Django projects with 100% test coverage * Twitter Bootstrap_ v4.0.0 - alpha_ * End-to-end via Hitch_ diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 44fb6b7fb..3be7940d7 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -33,7 +33,7 @@ You can now run the usual Django ``migrate`` and ``runserver`` command:: django-allauth sends an email to verify users (and superusers) after signup and login (if they are still not verified). To send email you need to `configure your email backend`_ -.. _configure your email backend: http://docs.djangoproject.com/en/1.8/topics/email/#smtp-backend +.. _configure your email backend: http://docs.djangoproject.com/en/1.9/topics/email/#smtp-backend In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog:: diff --git a/setup.py b/setup.py index fb6c9a317..854370213 100644 --- a/setup.py +++ b/setup.py @@ -35,7 +35,7 @@ setup( classifiers=[ 'Development Status :: 4 - Beta', 'Environment :: Console', - 'Framework :: Django :: 1.8', + 'Framework :: Django :: 1.9', 'Intended Audience :: Developers', 'Natural Language :: English', 'License :: OSI Approved :: BSD License', diff --git a/{{cookiecutter.repo_name}}/requirements/base.txt b/{{cookiecutter.repo_name}}/requirements/base.txt index eac71dee2..6d3c39719 100644 --- a/{{cookiecutter.repo_name}}/requirements/base.txt +++ b/{{cookiecutter.repo_name}}/requirements/base.txt @@ -1,5 +1,5 @@ # Bleeding edge Django -django==1.8.7 # rq.filter: >=1.8,<1.9 +django==1.9.0 # Configuration django-environ==0.4.0 @@ -12,7 +12,7 @@ whitenoise==2.0.6 # Forms django-braces==1.8.1 django-crispy-forms==1.5.2 -django-floppyforms==1.5.2 +django-floppyforms==1.6.0 # Models django-model-utils==2.3.1 From fc37d656615211ba0ce044c8cb3050181600d1cb Mon Sep 17 00:00:00 2001 From: "Fabio C. Barrioneuvo da Luz" Date: Fri, 11 Dec 2015 08:53:43 -0300 Subject: [PATCH 287/402] fix issue #436 --- CHANGELOG.md | 4 ++++ {{cookiecutter.repo_name}}/tests/engine.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 85b02a9ba..4727b77fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-11] +### Changed +- Fix issue #436 - cookiecutter variable name was renamed from `celery_support` to `use_celery` in `tests/engine.py` (@luzfcb @otakucode) + ## [2015-12-06] ### Changed - Reorganization of contributors (@burhan) diff --git a/{{cookiecutter.repo_name}}/tests/engine.py b/{{cookiecutter.repo_name}}/tests/engine.py index b9b082da6..6b7b63b9a 100644 --- a/{{cookiecutter.repo_name}}/tests/engine.py +++ b/{{cookiecutter.repo_name}}/tests/engine.py @@ -62,7 +62,7 @@ class ExecutionEngine(hitchtest.ExecutionEngine): redis_package=redis_package, port=16379, ) -{% if cookiecutter.celery_support == "y" %} +{% if cookiecutter.use_celery == "y" %} self.services['Celery'] = hitchpython.CeleryService( python=python_package.python, app="{{cookiecutter.repo_name}}.taskapp", loglevel="INFO", From d21b021e7ac5562b637c10c33a69838a9b085a2b Mon Sep 17 00:00:00 2001 From: yunti Date: Fri, 11 Dec 2015 14:43:30 +0000 Subject: [PATCH 288/402] Update runtime.txt --- {{cookiecutter.repo_name}}/runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 8d5e4598d..40b97bf81 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,3 @@ {% if cookiecutter.use_python2 == 'n' -%} -python-3.5.0 +python-3.5.1 {%- endif %} From ae0a2b82badab32190026492b95d1c4a7dd60463 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Fri, 11 Dec 2015 07:35:19 -0800 Subject: [PATCH 289/402] Update CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4727b77fe..292bf15f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,8 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-12-11] ### Changed -- Fix issue #436 - cookiecutter variable name was renamed from `celery_support` to `use_celery` in `tests/engine.py` (@luzfcb @otakucode) +- Fixed issue #436 - cookiecutter variable name was renamed from `celery_support` to `use_celery` in `tests/engine.py` (@luzfcb @otakucode) +- Updated Heroku runtime.txt for python 3.5.1 (@yunti) ## [2015-12-06] ### Changed From a588d804f71ac19a8a1e83779e6cd7f9290bc578 Mon Sep 17 00:00:00 2001 From: stepmr Date: Fri, 11 Dec 2015 17:42:30 -0800 Subject: [PATCH 290/402] Update runtime.txt - Support python-2.7.10 runtime --- {{cookiecutter.repo_name}}/runtime.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/{{cookiecutter.repo_name}}/runtime.txt b/{{cookiecutter.repo_name}}/runtime.txt index 40b97bf81..84c90354c 100644 --- a/{{cookiecutter.repo_name}}/runtime.txt +++ b/{{cookiecutter.repo_name}}/runtime.txt @@ -1,3 +1,5 @@ {% if cookiecutter.use_python2 == 'n' -%} python-3.5.1 +{% else %} +python-2.7.10 {%- endif %} From 506eb22be0ab030b6b4ce6ffe28c41c757cee108 Mon Sep 17 00:00:00 2001 From: stepmr Date: Fri, 11 Dec 2015 17:56:54 -0800 Subject: [PATCH 291/402] Support opbeat logging with celery - support opbeat logging with celery - modify sentry imports to avoid conflicts --- .../taskapp/celery.py | 25 ++++++++++++++++--- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index 30fda6eae..fd324e316 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -27,10 +27,27 @@ class CeleryConfig(AppConfig): {% if cookiecutter.use_sentry == "y" -%} if hasattr(settings, 'RAVEN_CONFIG'): # Celery signal registration - from raven import Client - from raven.contrib.celery import register_signal - client = Client(dsn=settings.RAVEN_CONFIG['DSN']) - register_signal(client) + from raven import Client as RavenClient + from raven.contrib.celery import register_signal as raven_register_signal + + raven_client = RavenClient(dsn=settings.RAVEN_CONFIG['DSN']) + raven_register_signal(raven_client) + {%- endif %} + + {% if cookiecutter.use_opbeat == "y" -%} + if hasattr(settings, 'OPBEAT'): + from opbeat.contrib.django.models import client as opbeat_client + from opbeat.contrib.django.models import logger as opbeat_logger + from opbeat.contrib.django.models import register_handlers as opbeat_register_handlers + from opbeat.contrib.celery import register_signal as opbeat_register_signal + + try: + opbeat_register_signal(opbeat_client) + except Exception as e: + opbeat_logger.exception('Failed installing celery hook: %s' % e) + + if 'opbeat.contrib.django' in settings.INSTALLED_APPS: + opbeat_register_handlers() {%- endif %} From 681247e4b7ea57ff393330923f4164e227c14d38 Mon Sep 17 00:00:00 2001 From: stepmr Date: Fri, 11 Dec 2015 23:10:08 -0800 Subject: [PATCH 292/402] Add celery worker to Procfile --- {{cookiecutter.repo_name}}/Procfile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/{{cookiecutter.repo_name}}/Procfile b/{{cookiecutter.repo_name}}/Procfile index c00f42350..1214b0120 100644 --- a/{{cookiecutter.repo_name}}/Procfile +++ b/{{cookiecutter.repo_name}}/Procfile @@ -1 +1,4 @@ web: gunicorn config.wsgi:application +{% if cookiecutter.use_celery == "y" -%} +worker: {% if cookiecutter.use_newrelic == "y" %}newrelic-admin run-program {% endif %}celery worker --app=stairmaster.taskapp --loglevel=info +{%- endif %} From f7572a55c10596a44644df0a4d90031a09ef278e Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sat, 12 Dec 2015 14:25:16 -0800 Subject: [PATCH 293/402] Update changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 292bf15f7..4787636fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-12] +### Added +- Celery worker to Heroku procfile + ## [2015-12-11] ### Changed - Fixed issue #436 - cookiecutter variable name was renamed from `celery_support` to `use_celery` in `tests/engine.py` (@luzfcb @otakucode) From 4338227f16c9a460a4f1b3511005cc48b798d1fb Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 13 Dec 2015 09:39:05 -0800 Subject: [PATCH 294/402] Updated changelog --- CHANGELOG.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4787636fb..ec5639744 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,14 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-13] +### Changed +- Support opbeat logging with celery (@stepmr) +- Update runtime.txt with PY2 support (@stepmr) + ## [2015-12-12] ### Added -- Celery worker to Heroku procfile +- Celery worker to Heroku procfile (@stepmr) ## [2015-12-11] ### Changed From 7d9eba607b816332db9c6e964e36af4a66b3fc73 Mon Sep 17 00:00:00 2001 From: Daniel Roy Greenfeld Date: Sun, 13 Dec 2015 09:44:53 -0800 Subject: [PATCH 295/402] Added @areski to our contributors list --- CHANGELOG.md | 1 + CONTRIBUTORS.rst | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec5639744..8edb933ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [2015-12-13] ### Changed +- Bumped Django to 1.9 (@areski) - Support opbeat logging with celery (@stepmr) - Update runtime.txt with PY2 support (@stepmr) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 3e56e3948..1f42a123c 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -7,7 +7,7 @@ and are able to accept and merge pull requests. =========================== ============= =========== Name Github Twitter =========================== ============= =========== -Daniel Greenfeld `@pydanny`_ @pydanny +Daniel Roy Greenfeld `@pydanny`_ @pydanny Audrey Roy Greenfeld* `@audreyr`_ Jim Munro Fábio C. Barrionuevo da Luz @luzfcb @@ -50,6 +50,7 @@ Listed in alphabetical order Andrew Mikhnevich `@zcho`_ Andy Rose Anna Callahan `@jazztpt`_ + Areski Belaid `@areski`_ Ashley Camba Barclay Gauld `@yunti`_ Ben Lopatin @@ -98,6 +99,7 @@ Listed in alphabetical order Yaroslav Halchenko ========================== ============================ ============== +.. _@areski: https://github.com/areski .. _@a7p: https://github.com/a7p .. _@bogdal: https://github.com/bogdal .. _@ad-m: https://github.com/ad-m From def4fcbafaac7a234e1e8305c798eda99ba76ce8 Mon Sep 17 00:00:00 2001 From: stepmr Date: Tue, 15 Dec 2015 15:29:00 -0800 Subject: [PATCH 296/402] Fix celery worker app name in Procfile --- {{cookiecutter.repo_name}}/Procfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/Procfile b/{{cookiecutter.repo_name}}/Procfile index 1214b0120..612f46625 100644 --- a/{{cookiecutter.repo_name}}/Procfile +++ b/{{cookiecutter.repo_name}}/Procfile @@ -1,4 +1,4 @@ web: gunicorn config.wsgi:application {% if cookiecutter.use_celery == "y" -%} -worker: {% if cookiecutter.use_newrelic == "y" %}newrelic-admin run-program {% endif %}celery worker --app=stairmaster.taskapp --loglevel=info +worker: {% if cookiecutter.use_newrelic == "y" %}newrelic-admin run-program {% endif %}celery worker --app={{cookiecutter.repo_name}}.taskapp --loglevel=info {%- endif %} From 244c81be66d36d426e8730aa8d82f06a6a2e3c1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20C=2E=20Barrionuevo=20da=20Luz?= Date: Tue, 15 Dec 2015 20:54:17 -0300 Subject: [PATCH 297/402] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8edb933ba..2dd80111d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-15] +### Changed +- Fix celery worker app name in Procfile (@stepmr) + ## [2015-12-13] ### Changed - Bumped Django to 1.9 (@areski) From cdd3932ff5e3e8f57b5cbc865789396d26aa962a Mon Sep 17 00:00:00 2001 From: dsclementsen Date: Wed, 16 Dec 2015 17:53:28 +1100 Subject: [PATCH 298/402] DJANGO_SENTRY_DSN env variable if use_sentry Closes pydanny/cookiecutter-django#446 --- CONTRIBUTORS.rst | 1 + {{cookiecutter.repo_name}}/env.example | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 1f42a123c..812bb4f69 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -64,6 +64,7 @@ Listed in alphabetical order Cristian Vargas `@cdvv7788`_ Cullen Rhodes `@c-rhodes`_ Daniele Tricoli `@eriol`_ + Davur Clementsen `@dsclementsen`_ @davur Eyad Al Sibai `@eyadsibai`_ Felipe Arruda `@arruda`_ Garry Cairns `@garry-cairns`_ diff --git a/{{cookiecutter.repo_name}}/env.example b/{{cookiecutter.repo_name}}/env.example index edc5454bf..749deaed6 100644 --- a/{{cookiecutter.repo_name}}/env.example +++ b/{{cookiecutter.repo_name}}/env.example @@ -12,7 +12,7 @@ DJANGO_MAILGUN_API_KEY= DJANGO_MAILGUN_SERVER_NAME= DJANGO_SERVER_EMAIL= DJANGO_SECURE_SSL_REDIRECT=False -{% if cookiecutter.use_whitenoise == 'y' -%} +{% if cookiecutter.use_sentry == 'y' -%} DJANGO_SENTRY_DSN= {% endif %} {% if cookiecutter.use_newrelic == 'y' -%} From 77c6a12eaa9b5cc05cbc57f82e87a51047e484f4 Mon Sep 17 00:00:00 2001 From: Saurabh Kumar Date: Wed, 16 Dec 2015 14:12:47 +0530 Subject: [PATCH 299/402] fix(urls): update 4xx error pages preview, to accept exceptions closes #444 --- CHANGELOG.md | 3 +++ {{cookiecutter.repo_name}}/config/urls.py | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2dd80111d..73318e768 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-16] +- Update preview 4xx error pages to accept `exception` argument (@theskumar) + ## [2015-12-15] ### Changed - Fix celery worker app name in Procfile (@stepmr) diff --git a/{{cookiecutter.repo_name}}/config/urls.py b/{{cookiecutter.repo_name}}/config/urls.py index 8afe9c069..b63a9731e 100644 --- a/{{cookiecutter.repo_name}}/config/urls.py +++ b/{{cookiecutter.repo_name}}/config/urls.py @@ -28,8 +28,8 @@ if settings.DEBUG: # This allows the error pages to be debugged during development, just visit # these url in browser to see how these error pages look like. urlpatterns += [ - url(r'^400/$', default_views.bad_request), - url(r'^403/$', default_views.permission_denied), - url(r'^404/$', default_views.page_not_found), + url(r'^400/$', default_views.bad_request, kwargs={'exception': Exception("Bad Request!")}), + url(r'^403/$', default_views.permission_denied, kwargs={'exception': Exception("Permissin Denied")}), + url(r'^404/$', default_views.page_not_found, kwargs={'exception': Exception("Page not Found")}), url(r'^500/$', default_views.server_error), ] From 91f223d7bd88a600b3f435a392fbf88a1b4380f9 Mon Sep 17 00:00:00 2001 From: Jay Date: Mon, 21 Dec 2015 11:28:27 +0100 Subject: [PATCH 300/402] added raven logging for celery --- CHANGELOG.md | 4 ++++ .../{{cookiecutter.repo_name}}/taskapp/celery.py | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73318e768..4cf9060ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All enhancements and patches to cookiecutter-django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2015-12-21] +### Changed +- Added sentry logger to celery config (@jayfk) + ## [2015-12-16] - Update preview 4xx error pages to accept `exception` argument (@theskumar) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py index fd324e316..7a089dbd7 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/taskapp/celery.py @@ -29,11 +29,13 @@ class CeleryConfig(AppConfig): # Celery signal registration from raven import Client as RavenClient from raven.contrib.celery import register_signal as raven_register_signal - + from raven.contrib.celery import register_logger_signal as raven_register_logger_signal + raven_client = RavenClient(dsn=settings.RAVEN_CONFIG['DSN']) + raven_register_logger_signal(raven_client) raven_register_signal(raven_client) {%- endif %} - + {% if cookiecutter.use_opbeat == "y" -%} if hasattr(settings, 'OPBEAT'): from opbeat.contrib.django.models import client as opbeat_client From db4e3deeab3529144f8ad999fbd303f80f1dcc96 Mon Sep 17 00:00:00 2001 From: Jan Van Bruggen Date: Tue, 29 Dec 2015 12:09:41 -0800 Subject: [PATCH 301/402] Replace pull-right (broken) with pull-xs-right twbs/bootstrap#18340 removed `.pull-left` and `.pull-right` since they're redundant with `.pull-xs-left` and `.pull-xs-right`. This solves the styling bug explained in pydanny/cookiecutter-django#452. --- .../{{cookiecutter.repo_name}}/static/css/project.css | 4 ++-- .../{{cookiecutter.repo_name}}/static/sass/project.scss | 2 +- .../{{cookiecutter.repo_name}}/templates/base.html | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css index 08505aeef..5f23c427a 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/css/project.css @@ -24,7 +24,7 @@ margin-left: 0; } - .nav.navbar-nav.pull-right { + .nav.navbar-nav.pull-xs-right { float: none !important; } } @@ -35,4 +35,4 @@ */ [hidden][style="display: block;"] { display: block !important; -} \ No newline at end of file +} diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss index 37c69e454..e737d593f 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/static/sass/project.scss @@ -37,7 +37,7 @@ $red: #b94a48; margin-left: 0; } - .nav.navbar-nav.pull-right { + .nav.navbar-nav.pull-xs-right { float: none !important; } } diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html index caf7a1bdb..9f2d6f5b0 100644 --- a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/templates/base.html @@ -35,7 +35,7 @@