diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 11324a50a..4eb5b41c6 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -56,6 +56,7 @@ Listed in alphabetical order. Areski Belaid `@areski`_ Ashley Camba Barclay Gauld `@yunti`_ + Ben Warren `@bwarren2` Ben Lopatin Benjamin Abel Bo Lopker `@blopker`_ @@ -86,6 +87,7 @@ Listed in alphabetical order. Felipe Arruda `@arruda`_ Garry Cairns `@garry-cairns`_ Garry Polley `@garrypolley`_ + Hamish Durkin `@durkode`_ Harry Percival `@hjwp`_ Henrique G. G. Pereira `@ikkebr`_ Ian Lee `@IanLee1521`_ @@ -177,6 +179,7 @@ Listed in alphabetical order. .. _@dhepper: https://github.com/dhepper .. _@dot2dotseurat: https://github.com/dot2dotseurat .. _@dsclementsen: https://github.com/dsclementsen +.. _@durkode: https://github.com/durkode .. _@epileptic-fish: https://gihub.com/epileptic-fish .. _@eraldo: https://github.com/eraldo .. _@eriol: https://github.com/eriol diff --git a/README.rst b/README.rst index 68d6088dc..c08b4a662 100644 --- a/README.rst +++ b/README.rst @@ -29,7 +29,7 @@ Features --------- * For Django 1.10 -* Works with Python 3.4.x or 3.5.x. Python 3.6 is experimenta +* Works with Python 3.4.x or 3.5.x. Python 3.6 is experimental * Renders Django projects with 100% starting test coverage * Twitter Bootstrap_ v4.0.0 - alpha 6 (`maintained Foundation fork`_ also available) * 12-Factor_ based settings via django-environ_ @@ -85,6 +85,36 @@ Constraints * Uses PostgreSQL everywhere (9.2+) * Environment variables for configuration (This won't work with Apache/mod_wsgi except on AWS ELB). +Support this Project! +---------------------- + +This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django: + +* https://www.patreon.com/danielroygreenfeld: Project lead. Expertise in AWS ELB and Django. + +Projects that provide financial support to the maintainers: + +Two Scoops of Django 1.11 +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: https://cdn.shopify.com/s/files/1/0304/6901/products/tsd-111-alpha_medium.jpg?v=1499531513 + :name: Two Scoops of Django 1.11 Cover + :align: center + :alt: Two Scoops of Django + :target: http://twoscoopspress.org/products/two-scoops-of-django-1-11 + +Two Scoops of Django is the best dairy-themed Django reference in the universe + +pyup +~~~~~~~~~~~~~~~~~~ + +.. image:: https://pyup.io/static/images/logo.png + :name: pyup + :align: center + :alt: pyup + :target: https://pyup.io/ + +Pyup brings you automated security and dependency updates used by Google and other organizations. Free for open source projects! Usage ------ @@ -258,31 +288,5 @@ Code of Conduct Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_. -Support This Project ---------------------------- - -This project is maintained by volunteers. Support their efforts by spreading the word about: - -Two Scoops Press -~~~~~~~~~~~~~~~~~~ - -.. image:: https://cdn.shopify.com/s/files/1/0304/6901/t/2/assets/logo.png?11985289740589874793 - :name: Two Scoops Press - :align: center - :alt: Two Scoops Press - :target: https://twoscoopspress.com - -Two Scoops Press brings you the best dairy-themed Django references in the universe - -pyup -~~~~~~~~~~~~~~~~~~ - -.. image:: https://pyup.io/static/images/logo.png - :name: pyup - :align: center - :alt: pyup - :target: https://pyup.io/ - -Pyup brings you automated security and dependency updates used by Google and other organizations. Free for open source projects! .. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/ diff --git a/cookiecutter.json b/cookiecutter.json index 4450e6933..5b443493c 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -21,5 +21,6 @@ "postgresql_version": ["9.6", "9.5", "9.4", "9.3", "9.2"], "js_task_runner": ["Gulp", "Grunt", "None"], "use_lets_encrypt": "n", + "custom_bootstrap_compilation": "n", "open_source_license": ["MIT", "BSD", "GPLv3", "Apache Software License 2.0", "Not open source"] } diff --git a/docs/deployment-with-docker.rst b/docs/deployment-with-docker.rst index 5025cdd37..1c6a724f6 100644 --- a/docs/deployment-with-docker.rst +++ b/docs/deployment-with-docker.rst @@ -12,7 +12,7 @@ Prerequisites Understand the Compose Setup -------------------------------- -Before you start, check out the `docker-compose.yml` file in the root of this project. This is where each component +Before you start, check out the `production.yml` file in the root of this project. This is where each component of this application gets its configuration from. Notice how it provides configuration for these services: * `postgres` service that runs the database @@ -37,6 +37,15 @@ root directory of this project as a starting point. Add your own variables to th 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. +It is **highly recommended** that before you build your production application, you set your POSTGRES_USER value here. This will create a non-default user for the postgres image. If you do not set this user before building the application, the default user 'postgres' will be created, and this user will not be able to create or restore backups. + +To obtain logs and information about crashes in a production setup, make sure that you have access to an external Sentry instance (e.g. by creating an account with `sentry.io`_), and set the `DJANGO_SENTRY_DSN` variable. This should be enough to report crashes to Sentry. + +You will probably also need to setup the Mail backend, for example by adding a `Mailgun`_ API key and a `Mailgun`_ sender domain, otherwise, the account creation view will crash and result in a 500 error when the backend attempts to send an email to the account owner. + +.. _sentry.io: https://sentry.io/welcome +.. _Mailgun: https://mailgun.com + HTTPS is on by default ---------------------- @@ -54,7 +63,7 @@ Optional: nginx-proxy Setup --------------------------- 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. +`production.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=example.com` to your env file. Here, replace example.com with the value you entered for `domain_name`. @@ -78,19 +87,19 @@ Replace dhparam.pem.example with a generated dhparams.pem file before running an $ openssl dhparam -out /path/to/project/compose/nginx/dhparams.pem 2048 -If you would like to add additional subdomains to your certificate, you must add additional parameters to the certbot command in the `docker-compose.yml` file: +If you would like to add additional subdomains to your certificate, you must add additional parameters to the certbot command in the `production.yml` file: Replace: :: - command: bash -c "sleep 6 && certbot certonly -n --standalone -d {{ cookiecutter.domain_name }} --text --agree-tos --email mjsisley@relawgo.com --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --standalone-supported-challenges http-01" + command: bash -c "sleep 6 && certbot certonly -n --standalone -d {{ cookiecutter.domain_name }} --test --agree-tos --email {{ cookiecutter.email }} --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --preferred-challenges http-01" With: :: - command: bash -c "sleep 6 && certbot certonly -n --standalone -d {{ cookiecutter.domain_name }} -d www.{{ cookiecutter.domain_name }} -d etc.{{ cookiecutter.domain_name }} --text --agree-tos --email {{ cookiecutter.email }} --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --standalone-supported-challenges http-01" + command: bash -c "sleep 6 && certbot certonly -n --standalone -d {{ cookiecutter.domain_name }} -d www.{{ cookiecutter.domain_name }} -d etc.{{ cookiecutter.domain_name }} --test --agree-tos --email {{ cookiecutter.email }} --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --preferred-challenges http-01" Please be cognizant of Certbot/Letsencrypt certificate requests limits when getting this set up. The provide a test server that does not count against the limit while you are getting set up. @@ -101,8 +110,8 @@ If you would like to set up autorenewal of your certificates, the following comm #!/bin/bash cd - docker-compose run --rm --name certbot certbot bash -c "sleep 6 && certbot certonly --standalone -d {{ cookiecutter.domain_name }} --text --agree-tos --email {{ cookiecutter.email }} --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --standalone-supported-challenges http-01" - docker exec pearl_nginx_1 nginx -s reload + docker-compose -f production.yml run --rm --name certbot certbot bash -c "sleep 6 && certbot certonly --standalone -d {{ cookiecutter.domain_name }} --test --agree-tos --email {{ cookiecutter.email }} --server https://acme-v01.api.letsencrypt.org/directory --rsa-key-size 4096 --verbose --keep-until-expiring --preferred-challenges http-01" + docker exec {{ cookiecutter.project_name }}_nginx_1 nginx -s reload And then set a cronjob by running `crontab -e` and placing in it (period can be adjusted as desired):: @@ -116,40 +125,40 @@ directory. You'll need to build the stack first. To do that, run:: - docker-compose build + docker-compose -f production.yml build Once this is ready, you can run it with:: - docker-compose up + docker-compose -f production.yml up To run a migration, open up a second terminal and run:: - docker-compose run django python manage.py migrate + docker-compose -f production.yml run django python manage.py migrate To create a superuser, run:: - docker-compose run django python manage.py createsuperuser + docker-compose -f production.yml run django python manage.py createsuperuser If you need a shell, run:: - docker-compose run django python manage.py shell + docker-compose -f production.yml run django python manage.py shell To get an output of all running containers. To check your logs, run:: - docker-compose logs + docker-compose -f production.yml logs If you want to scale your application, run:: - docker-compose scale django=4 - docker-compose scale celeryworker=2 + docker-compose -f production.yml scale django=4 + docker-compose -f production.yml scale celeryworker=2 .. warning:: Don't run the scale command on postgres, celerybeat, certbot, or nginx. If you have errors, you can always check your stack with `docker-compose`. Switch to your projects root directory and run:: - docker-compose ps + docker-compose -f production.yml ps Supervisor Example @@ -157,12 +166,12 @@ Supervisor Example Once you are ready with your initial setup, you want 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. +it needs to do is to run `docker-compose -f production.yml up` in your projects root directory. If you are using `supervisor`, you can use this file as a starting point:: [program:{{cookiecutter.project_slug}}] - command=docker-compose up + command=docker-compose -f production.yml up directory=/path/to/{{cookiecutter.project_slug}} redirect_stderr=true autostart=true diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 19c24f8e5..f9ce74d17 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -16,12 +16,13 @@ If you don't already have it installed, follow the instructions for your OS: - On Mac OS X, you'll need `Docker for Mac`_ - On Windows, you'll need `Docker for Windows`_ - On Linux, you'll need `docker-engine`_ + .. _`Docker for Mac`: https://docs.docker.com/engine/installation/mac/ .. _`Docker for Windows`: https://docs.docker.com/engine/installation/windows/ .. _`docker-engine`: https://docs.docker.com/engine/installation/ Attention Windows users -------------- +----------------------- Currently PostgreSQL (``psycopg2`` python package) is not installed inside Docker containers for Windows users, while it is required by the generated Django project. To fix this, add ``psycopg2`` to the list of requirements inside ``requirements/base.txt``:: @@ -36,9 +37,9 @@ Build the Stack This can take a while, especially the first time you run this particular command on your development system:: - $ docker-compose -f dev.yml build + $ docker-compose -f local.yml build -If you want to build the production environment you don't have to pass an argument -f, it will automatically use docker-compose.yml. +If you want to build the production environment you don't have to pass an argument -f, it will automatically use production.yml. Boot the System --------------- @@ -50,38 +51,38 @@ runs will occur quickly. Open a terminal at the project root and run the following for local development:: - $ docker-compose -f dev.yml up + $ docker-compose -f local.yml up -You can also set the environment variable ``COMPOSE_FILE`` pointing to ``dev.yml`` like this:: +You can also set the environment variable ``COMPOSE_FILE`` pointing to ``local.yml`` like this:: - $ export COMPOSE_FILE=dev.yml + $ export COMPOSE_FILE=local.yml And then run:: - $ docker-compose up + $ docker-compose -f production.yml 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. +using the ``docker-compose -f production.yml run`` command. To migrate your app and to create a superuser, run:: - $ docker-compose -f dev.yml run django python manage.py migrate - $ docker-compose -f dev.yml run django python manage.py createsuperuser + $ docker-compose -f local.yml run django python manage.py migrate + $ docker-compose -f local.yml run django python manage.py createsuperuser Here we specify the ``django`` container as the location to run our management commands. Add your Docker development server IP ------------------------------------- +------------------------------------- When ``DEBUG`` is set to `True`, the host is validated against ``['localhost', '127.0.0.1', '[::1]']``. This is adequate when running a ``virtualenv``. For Docker, in the ``config.settings.local``, add your host development server IP to ``INTERNAL_IPS`` or ``ALLOWED_HOSTS`` if the variable exists. Production Mode ~~~~~~~~~~~~~~~ -Instead of using `dev.yml`, you would use `docker-compose.yml`. +Instead of using `local.yml`, you would use `production.yml`. Other Useful Tips ----------------- @@ -103,7 +104,7 @@ If you want to run the stack in detached mode (in the background), use the ``-d` :: - $ docker-compose -f dev.yml up -d + $ docker-compose -f local.yml up -d Debugging ~~~~~~~~~~~~~ @@ -121,13 +122,13 @@ Then you may need to run the following for it to work as desired: :: - $ docker-compose run -f dev.yml --service-ports django + $ docker-compose -f local.yml run --service-ports django django-debug-toolbar """""""""""""""""""" -In order for django-debug-toolbar to work with docker you need to add your docker-machine ip address (the output of `Get the IP ADDRESS`_) to INTERNAL_IPS in local.py +In order for django-debug-toolbar to work with docker you need to add your docker-machine ip address to ``INTERNAL_IPS`` in ``local.py`` .. May be a better place to put this, as it is not Docker specific. diff --git a/docs/docker-postgres-backups.rst b/docs/docker-postgres-backups.rst index 6f2a3cc5b..d3c7ca1d4 100644 --- a/docs/docker-postgres-backups.rst +++ b/docs/docker-postgres-backups.rst @@ -2,26 +2,26 @@ Database Backups with Docker ============================ -The database has to be running to create/restore a backup. These examples show local examples. If you want to use it on a remote server, remove ``-f dev.yml`` from each example. +The database has to be running to create/restore a backup. These examples show local examples. If you want to use it on a remote server, remove ``-f local.yml`` from each example. Running Backups ================ -Run the app with `docker-compose -f dev.yml up`. +Run the app with `docker-compose -f local.yml up`. To create a backup, run:: - docker-compose -f dev.yml run postgres backup + docker-compose -f local.yml run postgres backup To list backups, run:: - docker-compose -f dev.yml run postgres list-backups + docker-compose -f local.yml run postgres list-backups To restore a backup, run:: - docker-compose -f dev.yml run postgres restore filename.sql + docker-compose -f local.yml run postgres restore filename.sql Where is the ID of the Postgres container. To get it, run:: diff --git a/docs/index.rst b/docs/index.rst index bfa88f18c..3b0a268ca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,5 +33,4 @@ Indices and tables * :ref:`genindex` * :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. +.. 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 c2f76f352..4750e1617 100644 --- a/docs/linters.rst +++ b/docs/linters.rst @@ -14,7 +14,7 @@ To run 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 +* Exclude ``.tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules`` pylint ------ @@ -40,4 +40,4 @@ This is included in flake8's checks, but you can also run it separately to see a 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 +* Exclude ``.tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules`` diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index ba54a5a44..1dc112793 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -130,7 +130,7 @@ def remove_docker_files(): """ Removes files needed for docker if it isn't going to be used """ - for filename in ["dev.yml", "docker-compose.yml", ".dockerignore"]: + for filename in ["local.yml", "production.yml", ".dockerignore"]: os.remove(os.path.join( PROJECT_DIRECTORY, filename )) @@ -201,6 +201,16 @@ def remove_elasticbeanstalk(): PROJECT_DIRECTORY, filename )) +def remove_open_source_files(): + """ + Removes files conventional to opensource projects only. + """ + for filename in ["CONTRIBUTORS.txt"]: + os.remove(os.path.join( + PROJECT_DIRECTORY, filename + )) + + # IN PROGRESS # def copy_doc_files(project_directory): # cookiecutters_dir = DEFAULT_CONFIG['cookiecutters_dir'] @@ -283,3 +293,7 @@ if '{{ cookiecutter.open_source_license}}' != 'GPLv3': # 12. Remove Elastic Beanstalk files if '{{ cookiecutter.use_elasticbeanstalk_experimental }}'.lower() != 'y': remove_elasticbeanstalk() + +# 13. Remove files conventional to opensource projects only. +if '{{ cookiecutter.open_source_license }}' == 'Not open source': + remove_open_source_files() diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py index cd31774e0..c7a68450b 100644 --- a/hooks/pre_gen_project.py +++ b/hooks/pre_gen_project.py @@ -9,3 +9,23 @@ docker = '{{ cookiecutter.use_docker }}'.lower() if elasticbeanstalk == 'y' and (heroku == 'y' or docker == 'y'): raise Exception("Cookiecutter Django's EXPERIMENTAL Elastic Beanstalk support is incompatible with Heroku and Docker setups.") + +if docker == 'n': + import sys + + python_major_version = sys.version_info[0] + + if python_major_version == 2: + sys.stdout.write("WARNING: Cookiecutter Django does not support Python 2! Stability is guaranteed with Python 3.4+ only. Are you sure you want to proceed? (y/n)") + + yes_options = set(['y']) + no_options = set(['n', '']) + choice = raw_input().lower() + if choice in no_options: + sys.exit(1) + elif choice in yes_options: + pass + else: + sys.stdout.write("Please respond with %s or %s" + % (', '.join([o for o in yes_options if not o == '']) + , ', '.join([o for o in no_options if not o == '']))) diff --git a/requirements.txt b/requirements.txt index ebc618046..2f0e67524 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,10 @@ cookiecutter==1.5.1 flake8==3.3.0 # pyup: != 2.6.0 -sh==1.12.13 +sh==1.12.14 binaryornot==0.4.3 # Testing -pytest==3.0.7 +pytest==3.1.3 pep8==1.7.0 pyflakes==1.5.0 tox==2.7.0 diff --git a/tests/test_docker.sh b/tests/test_docker.sh index 3c047f0a3..137694d7a 100755 --- a/tests/test_docker.sh +++ b/tests/test_docker.sh @@ -15,7 +15,7 @@ cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y js_task_runner cd project_name # run the project's tests -docker-compose -f dev.yml run django python manage.py test +docker-compose -f local.yml run django python manage.py test # return non-zero status code if there are migrations that have not been created -docker-compose -f dev.yml run django python manage.py makemigrations --dry-run --check || { echo "ERROR: there were changes in the models, but migration listed above have not been created and are not saved in version control"; exit 1; } +docker-compose -f local.yml run django python manage.py makemigrations --dry-run --check || { echo "ERROR: there were changes in the models, but migration listed above have not been created and are not saved in version control"; exit 1; } diff --git a/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml b/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml index 18829b2f2..98fff92e8 100644 --- a/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml +++ b/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml @@ -6,7 +6,7 @@ -