diff --git a/.gitignore b/.gitignore index 1f80de173..9e4496f1c 100644 --- a/.gitignore +++ b/.gitignore @@ -226,3 +226,5 @@ pip-selfcheck.json # to 'run' anything within it since any particular cookiecutter # is declarative by nature. .idea/ + +.pytest_cache/ diff --git a/.travis.yml b/.travis.yml index 8ca40c77a..8be8bc440 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,22 +7,12 @@ services: language: python -python: 3.5 +python: 3.6 env: - - TOX_ENV=py34 - - TOX_ENV=py35 + - TOX_ENV=py36 before_install: - - sudo sh -c 'echo "deb https://apt.dockerproject.org/repo ubuntu-precise main" > /etc/apt/sources.list.d/docker.list' - - sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D - - sudo apt-get update - - sudo apt-key update - - sudo apt-get --force-yes -qqy -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install docker-engine=1.11.1-0~precise - - sudo rm /usr/local/bin/docker-compose - - curl -L https://github.com/docker/compose/releases/download/1.7.0/docker-compose-`uname -s`-`uname -m` > docker-compose - - chmod +x docker-compose - - sudo mv docker-compose /usr/local/bin - docker-compose -v - docker -v diff --git a/CHANGELOG.md b/CHANGELOG.md index 70a142fc5..304732b9f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,23 @@ All enhancements and patches to Cookiecutter Django will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -## [2015-10-08] +## [2018-02-16] +### Changed +- Upgraded to Django 2.0 (@epicwhale) + +## [2018-01-15] +### Changed +- Removed Elastic Beanstalk support (@pydanny) + +## [2017-12-28] +### Changed +- Upgraded to Django 1.11 (@pydanny) + +## [2017-10-08] ### Changed - Elastic Beanstalk: Added --noinput to migrate command (@MightySCollins ) -## [2015-10-07] +## [2017-10-07] ### Added - Finished first pass at Elastic Beanstalk docs (@pydanny & @audreyr) ### Deleted diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index efff1fad9..cfe16740d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -36,13 +36,12 @@ To run all tests using various versions of python in virtualenvs defined in tox. $ tox -It is possible to tests with some versions of python, to do this the command +It is possible to test with a specific version of python. To do this, the command is:: - $ tox -e py34,py35 + $ tox -e py36 -Will run py.test with the python3.4, and python3.5 interpreters, for -example. +This will run py.test with the python3.6 interpreter, for example. To run a particular test with tox for against your current Python version:: diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index 08bca9078..96c05d042 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -7,17 +7,18 @@ Core Developers These contributors have commit flags for the repository, and are able to accept and merge pull requests. -=========================== ============= =========== -Name Github Twitter -=========================== ============= =========== -Daniel Roy Greenfeld `@pydanny`_ @pydanny -Audrey Roy Greenfeld* `@audreyr`_ @audreyr -Fábio C. Barrionuevo da Luz `@luzfcb`_ @luzfcb -Saurabh Kumar `@theskumar`_ @_theskumar +=========================== ================ =========== +Name Github Twitter +=========================== ================ =========== +Daniel Roy Greenfeld `@pydanny`_ @pydanny +Audrey Roy Greenfeld* `@audreyr`_ @audreyr +Fábio C. Barrionuevo da Luz `@luzfcb`_ @luzfcb +Saurabh Kumar `@theskumar`_ @_theskumar Jannis Gebauer `@jayfk`_ -Burhan Khalid `@burhan`_ @burhan -Shupeyko Nikita `@webyneter`_ @webyneter -=========================== ============= =========== +Burhan Khalid `@burhan`_ @burhan +Shupeyko Nikita `@webyneter`_ @webyneter +Bruno Alla               `@browniebroke`_ @_BrunoAlla +=========================== ================ =========== *Audrey is also the creator of Cookiecutter. Audrey and Daniel are on the Cookiecutter core team.* @@ -28,6 +29,7 @@ Daniel are on the Cookiecutter core team.* .. _@audreyr: https://github.com/audreyr .. _@jayfk: https://github.com/jayfk .. _@webyneter: https://github.com/webyneter +.. _@browniebroke: https://github.com/browniebroke Other Contributors ------------------ @@ -42,6 +44,7 @@ Listed in alphabetical order. Aaron Eikenberry `@aeikenberry`_ Adam Bogdał `@bogdal`_ Adam Dobrawy `@ad-m`_ + Adam Steele `@adammsteele` Agam Dua Alberto Sanchez `@alb3rto`_ Alex Tsai `@caffodian`_ @@ -64,7 +67,6 @@ Listed in alphabetical order. Bo Lopker `@blopker`_ Bouke Haarsma Brent Payne `@brentpayne`_ @brentpayne - Bruno Alla               `@browniebroke`_ @_BrunoAlla Burhan Khalid            `@burhan`_                   @burhan Catherine Devlin `@catherinedevlin`_ Cédric Gaspoz `@cgaspoz`_ @@ -127,6 +129,7 @@ Listed in alphabetical order. Pablo `@oubiga`_ Parbhat Puri `@parbhat`_ Peter Bittner `@bittner`_ + Pierre Chiquet `@pchiquet`_ Raphael Pierzina `@hackebrot`_ Raony Guimarães Corrêa `@raonyguimaraes`_ Reggie Riser `@reggieriser`_ @@ -157,6 +160,7 @@ Listed in alphabetical order. .. _@a7p: https://github.com/a7p .. _@ad-m: https://github.com/ad-m +.. _@adammsteele: https://github.com/adammsteele .. _@aeikenberry: https://github.com/aeikenberry .. _@alb3rto: https://github.com/alb3rto .. _@ameistad: https://github.com/ameistad @@ -170,7 +174,6 @@ Listed in alphabetical order. .. _@bloodpet: https://github.com/bloodpet .. _@blopker: https://github.com/blopker .. _@bogdal: https://github.com/bogdal -.. _@browniebroke: https://github.com/browniebroke .. _@burhan: https://github.com/burhan .. _@c-rhodes: https://github.com/c-rhodes .. _@caffodian: https://github.com/caffodian @@ -227,7 +230,6 @@ Listed in alphabetical order. .. _@rm--: https://github.com/rm-- .. _@romanosipenko: https://github.com/romanosipenko .. _@shireenrao: https://github.com/shireenrao -.. _@webyneter: https://github.com/webyneter .. _@show0k: https://github.com/show0k .. _@sfdye: https://github.com/sfdye .. _@shultz: https://github.com/shultz @@ -239,7 +241,7 @@ Listed in alphabetical order. .. _@timfreund: https://github.com/timfreund .. _@Travistock: https://github.com/Tavistock .. _@trungdong: https://github.com/trungdong -.. _@viviangb: httpsL//github.com/viviangb +.. _@viviangb: https://github.com/viviangb .. _@xpostudio4: https://github.com/xpostudio4 .. _@yunti: https://github.com/yunti .. _@zcho: https://github.com/zcho @@ -249,6 +251,12 @@ Listed in alphabetical order. .. _@jangeador: https://github.com/jangeador .. _@townie: https://github.com/townie .. _@MightySCollins: https://github.com/MightySCollins +.. _@dadokkio: https://github.com/dadokkio +.. _@bwarren2: https://github.com/bwarren2 +.. _@bertdemiranda: https://github.com/bertdemiranda +.. _@brentpayne: https://github.com/brentpayne +.. _@afrowave: https://github.com/afrowave +.. _@pchiquet: https://github.com/pchiquet Special Thanks ~~~~~~~~~~~~~~ diff --git a/LICENSE b/LICENSE index 9a5d2fc08..da2bbe30b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2016, Daniel Greenfeld +Copyright (c) 2013-2018, Daniel Greenfeld All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/README.rst b/README.rst index 589f1c92e..c5f9d06b3 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,10 @@ Cookiecutter Django .. image:: https://badges.gitter.im/Join Chat.svg :target: https://gitter.im/pydanny/cookiecutter-django?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +.. image:: https://www.codetriage.com/pydanny/cookiecutter-django/badges/users.svg + :target: https://www.codetriage.com/pydanny/cookiecutter-django + :alt: Code Helpers Badge + Powered by Cookiecutter_, Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly. @@ -34,10 +38,10 @@ production-ready Django projects quickly. Features --------- -* For Django 1.10 -* Works with Python 3.4.x or 3.5.x. Python 3.6 is experimental +* For Django 2.0 +* Works with Python 3.6 * Renders Django projects with 100% starting test coverage -* Twitter Bootstrap_ v4.0.0 - beta 1 (`maintained Foundation fork`_ also available) +* Twitter Bootstrap_ v4.0.0 (`maintained Foundation fork`_ also available) * 12-Factor_ based settings via django-environ_ * Secure by default. We believe in SSL. * Optimized development and production settings @@ -51,7 +55,6 @@ Features * Instructions for deploying to PythonAnywhere_ * Run tests with unittest or py.test * Customizable PostgreSQL version -* Experimental support for Amazon Elastic Beanstalk .. _`maintained Foundation fork`: https://github.com/Parbhat/cookiecutter-django-foundation @@ -108,7 +111,7 @@ Two Scoops of Django 1.11 :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 + :target: http://twoscoopspress.com/products/two-scoops-of-django-1-11 Two Scoops of Django is the best dessert-themed Django reference in the universe @@ -168,16 +171,20 @@ Answer the prompts with your own desired options_. For example:: use_heroku [n]: y use_compressor [n]: y Select postgresql_version: - 1 - 9.5 - 2 - 9.4 - 3 - 9.3 - 4 - 9.2 + 1 - 10.3 + 2 - 10.2 + 3 - 10.1 + 4 - 9.6 + 5 - 9.5 + 6 - 9.4 + 7 - 9.3 Choose from 1, 2, 3, 4 [1]: 1 Select js_task_runner: 1 - Gulp 2 - Grunt 3 - None Choose from 1, 2, 3, 4 [1]: 1 + custom_bootstrap_compilation [n]: n Select open_source_license: 1 - MIT 2 - BSD @@ -185,7 +192,6 @@ Answer the prompts with your own desired options_. For example:: 4 - Apache Software License 2.0 5 - Not open source Choose from 1, 2, 3, 4, 5 [1]: 1 - use_elasticbeanstalk_experimental: n Enter the project and take a look around:: @@ -222,7 +228,7 @@ Community .. _`issue`: https://github.com/pydanny/cookiecutter-django/issues .. _`Gitter`: https://gitter.im/pydanny/cookiecutter-django?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -For Readers of Two Scoops of Django 1.8 +For Readers of Two Scoops of Django -------------------------------------------- You may notice that some elements of this project do not exactly match what we describe in chapter 3. 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. @@ -274,14 +280,21 @@ experience better. Articles --------- +* `Deploying Cookiecutter-Django with Docker-Compose`_ - Oct. 19, 2017 +* `Using Cookiecutter to Jumpstart a Django Project on Windows with PyCharm`_ - May 19, 2017 +* `Exploring with Cookiecutter`_ - Dec. 3, 2016 +* `Introduction to Cookiecutter-Django`_ - Feb. 19, 2016 +* `Django and GitLab - Running Continuous Integration and tests with your FREE account`_ - May. 11, 2016 * `Development and Deployment of Cookiecutter-Django on Fedora`_ - Jan. 18, 2016 * `Development and Deployment of Cookiecutter-Django via Docker`_ - Dec. 29, 2015 * `How to create a Django Application using Cookiecutter and Django 1.8`_ - Sept. 12, 2015 -* `Introduction to Cookiecutter-Django`_ - Feb. 19, 2016 -* `Django and GitLab - Running Continuous Integration and tests with your FREE account`_ - May. 11, 2016 Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link. +.. _`Deploying Cookiecutter-Django with Docker-Compose`: http://adamantine.me/2017/10/19/deploying-cookiecutter-django-with-docker-compose/ +.. _`Exploring with Cookiecutter`: http://www.snowboardingcoder.com/django/2016/12/03/exploring-with-cookiecutter/ +.. _`Using Cookiecutter to Jumpstart a Django Project on Windows with PyCharm`: https://joshuahunter.com/posts/using-cookiecutter-to-jumpstart-a-django-project-on-windows-with-pycharm/ + .. _`Development and Deployment of Cookiecutter-Django via Docker`: https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-via-docker/ .. _`Development and Deployment of Cookiecutter-Django on Fedora`: https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-on-fedora/ .. _`How to create a Django Application using Cookiecutter and Django 1.8`: https://www.swapps.io/blog/how-to-create-a-django-application-using-cookiecutter-and-django-1-8/ diff --git a/cookiecutter.json b/cookiecutter.json index 8addeeada..27834a517 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -1,25 +1,43 @@ { - "project_name": "Project Name", - "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_') }}", - "author_name": "Daniel Roy Greenfeld", - "email": "you@example.com", - "description": "A short description of the project.", - "domain_name": "example.com", - "version": "0.1.0", - "timezone": "UTC", - "use_whitenoise": "y", - "use_celery": "n", - "use_mailhog": "n", - "use_sentry_for_error_reporting": "y", - "use_opbeat": "n", - "use_pycharm": "n", - "windows": "n", - "use_docker": "n", - "use_heroku": "n", - "use_elasticbeanstalk_experimental": "n", - "use_compressor": "n", - "postgresql_version": ["9.6", "9.5", "9.4", "9.3", "9.2"], - "js_task_runner": ["Gulp", "Grunt", "None"], - "custom_bootstrap_compilation": "n", - "open_source_license": ["MIT", "BSD", "GPLv3", "Apache Software License 2.0", "Not open source"] + "project_name": "My Awesome Project", + "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_') }}", + "description": "Behold My Awesome Project!", + "author_name": "Daniel Roy Greenfeld", + "email": "{{ cookiecutter.author_name.lower()|replace(' ', '-') }}@example.com", + "domain_name": "example.com", + "version": "0.1.0", + "open_source_license": [ + "MIT", + "BSD", + "GPLv3", + "Apache Software License 2.0", + "Not open source" + ], + "timezone": "UTC", + "windows": "n", + "use_pycharm": "n", + "use_docker": "n", + "postgresql_version": [ + "10.3", + "10.2", + "10.1", + "9.6", + "9.5", + "9.4", + "9.3" + ], + "js_task_runner": [ + "None", + "Gulp", + "Grunt" + ], + "custom_bootstrap_compilation": "n", + "use_compressor": "n", + "use_celery": "n", + "use_mailhog": "n", + "use_sentry_for_error_reporting": "y", + "use_opbeat": "n", + "use_whitenoise": "y", + "use_heroku": "n", + "use_travisci": "n" } diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index b84edfa46..e770219b8 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -16,7 +16,9 @@ Run these commands to deploy the project to Heroku: heroku addons:create heroku-redis:hobby-dev heroku addons:create mailgun - heroku config:set DJANGO_ADMIN_URL="$(openssl rand -base64 32)" + heroku config:set WEB_CONCURRENCY=4 + # Generating a 32 character-long random string without any of the visually similiar characters "IOl01": + heroku config:set DJANGO_ADMIN_URL="^$(openssl rand -base64 4096 | tr -dc 'A-HJ-NP-Za-km-z2-9' | head -c 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' @@ -25,12 +27,10 @@ Run these commands to deploy the project to Heroku: 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 MAILGUN_SENDER_DOMAIN=YOUR_MAILGUN_SENDER_DOMAIN + # This is to be set only if you're using Sentry: + heroku config:set DJANGO_SENTRY_DSN=YOUR_SENTRY_DSN heroku config:set PYTHONHASHSEED=random - heroku config:set DJANGO_ADMIN_URL=\^somelocation/ git push heroku master heroku run python manage.py migrate diff --git a/docs/deployment-on-pythonanywhere.rst b/docs/deployment-on-pythonanywhere.rst index 07b46bc05..995da7b03 100644 --- a/docs/deployment-on-pythonanywhere.rst +++ b/docs/deployment-on-pythonanywhere.rst @@ -35,7 +35,7 @@ Make sure your project is fully commited and pushed up to Bitbucket or Github or git clone # you can also use hg cd my-project-name - mkvirtualenv --python=/usr/bin/python3.5 my-project-name + mkvirtualenv --python=/usr/bin/python3.6 my-project-name pip install -r requirements/production.txt # may take a few minutes @@ -63,13 +63,13 @@ Add these exports .. code-block:: bash + export WEB_CONCURRENCY=4 export DJANGO_SETTINGS_MODULE='config.settings.production' export DJANGO_SECRET_KEY='' export DJANGO_ALLOWED_HOSTS='' export DJANGO_ADMIN_URL='' - export DJANGO_MAILGUN_API_KEY='' - export DJANGO_MAILGUN_SERVER_NAME='' - export MAILGUN_SENDER_DOMAIN='' + export MAILGUN_API_KEY='' + export MAILGUN_DOMAIN='' export DJANGO_AWS_ACCESS_KEY_ID= export DJANGO_AWS_SECRET_ACCESS_KEY= export DJANGO_AWS_STORAGE_BUCKET_NAME= @@ -138,9 +138,8 @@ Click through to the **WSGI configuration file** link (near the top) and edit th os.environ['DJANGO_SECRET_KEY'] = '' os.environ['DJANGO_ALLOWED_HOSTS'] = '' os.environ['DJANGO_ADMIN_URL'] = '' - os.environ['DJANGO_MAILGUN_API_KEY'] = '' - os.environ['DJANGO_MAILGUN_SERVER_NAME'] = '' - os.environ['MAILGUN_SENDER_DOMAIN'] = '' + os.environ['MAILGUN_API_KEY'] = '' + os.environ['MAILGUN_DOMAIN'] = '' os.environ['DJANGO_AWS_ACCESS_KEY_ID'] = '' os.environ['DJANGO_AWS_SECRET_ACCESS_KEY'] = '' os.environ['DJANGO_AWS_STORAGE_BUCKET_NAME'] = '' diff --git a/docs/deployment-with-docker.rst b/docs/deployment-with-docker.rst index fb383c3c5..25ff7cb9f 100644 --- a/docs/deployment-with-docker.rst +++ b/docs/deployment-with-docker.rst @@ -42,6 +42,13 @@ You will probably also need to setup the Mail backend, for example by adding a ` .. _sentry.io: https://sentry.io/welcome .. _Mailgun: https://mailgun.com +Optional: Use AWS IAM Role for EC2 instance +------------------------------------ +If you are deploying to AWS, you can use the IAM role to substitute AWS credentials, after which it's safe to remove the `AWS_ACCESS_KEY_ID` AND `AWS_SECRET_ACCESS_KEY` from the `.env`. To do it, create an `IAM role`_ and `attach`_ it to the existing EC2 instance or create a new EC2 instance with that role. The role should assume a minimum permission of `AmazonS3FullAccess`. + +.. _IAM role: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html +.. _attach: https://aws.amazon.com/blogs/security/easily-replace-or-attach-an-iam-role-to-an-existing-ec2-instance-by-using-the-ec2-console/ + HTTPS is on by default ---------------------- diff --git a/docs/deployment-with-elastic-beanstalk.rst b/docs/deployment-with-elastic-beanstalk.rst deleted file mode 100644 index e8aae8853..000000000 --- a/docs/deployment-with-elastic-beanstalk.rst +++ /dev/null @@ -1,72 +0,0 @@ -Deployment with Elastic Beanstalk -========================================== - -.. index:: Elastic Beanstalk - -Warning: Experimental ---------------------- - -This is experimental. For the time being there will be bugs and issues. If you've never used Elastic Beanstalk before, please hold off before trying this option. - -On the other hand, we need help cleaning this up. If you do have knowledge of Elastic Beanstalk, we would appreciate the help. :) - -Prerequisites -------------- - -* awsebcli - -Instructions -------------- - -If you haven't done so, create a directory of environments:: - - eb init -p python3.4 MY_PROJECT_SLUG - -Replace `MY_PROJECT_SLUG` with the value you entered for `project_slug`. - -Once that is done, create the environment (server) where the app will run:: - - eb create MY_PROJECT_SLUG - # Note: This will eventually fail on a postgres error, because postgres doesn't exist yet - -Now make sure you are in the right environment:: - - eb list - -If you are not in the right environment, then put yourself in the correct one:: - - eb use MY_PROJECT_SLUG - -Set the environment variables. Notes: You will be prompted if the `.env` file is missing. The script will ignore any PostgreSQL values, as RDS uses it's own system:: - - # Set the environment variables - python ebsetenv.py - -Speaking of PostgreSQL, go to the Elasting Beanstalk configuration panel for RDS. Create new RDS database, with these attributes: - -* PostgreSQL -* Version 9.4.9 -* Size db.t2.micro (You can upgrade later) - -(Get some coffee, this is going to take a while) - -Once you have a database specified, deploy again so your instance can pick up the new PostgreSQL values:: - - eb deploy - -Take a look:: - - eb open - -FAQ ------ - -Why Not Use Docker on Elastic Beanstalk? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because I didn't want to add an abstraction (Docker) on top of an abstraction (Elastic Beanstalk) on top of an abstraction (Cookiecutter Django). - -Why Can't I Use Both Docker/Heroku with Elastic Beanstalk? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because the environment variables that our Docker and Heroku setups use for PostgreSQL access is different then how Amazon RDS handles this access. At this time we're just trying to get things to work reliably with Elastic Beanstalk, and full integration will come later. diff --git a/docs/index.rst b/docs/index.rst index 3b0a268ca..41a1138f4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,7 +25,6 @@ Contents: faq troubleshooting my-favorite-cookie - deployment-with-elastic-beanstalk Indices and tables ================== diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 5a0cffe65..3f7928c50 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -1,69 +1,61 @@ Project Generation Options ========================== -project_name [project_name]: - Your human-readable project name, including any capitalization or spaces. +project_name [My Awesome Project]: + Your project's human-readable name, capitals and spaces allowed. -project_slug [project_name]: - The slug of your project, without dashes or spaces. Used to name your repo +project_slug [my_awesome_project]: + Your project's slug without dashes or spaces. Used to name your repo and in other places where a Python-importable version of your project name is needed. -author_name [Your Name]: - You! This goes into places like the LICENSE file. +description [Behold My Awesome Project!] + Describes your project and gets used in places like `README.rst` and such. -email [Your email]: - Your email address. +author_name [Daniel Roy Greenfeld]: + This is you! The value goes into places like `LICENSE` and such. -description [A short description of the project.] - Used in the generated README.rst and other places. +email [daniel-roy-greenfeld@example.com]: + The email address you want to identify yourself in the project. domain_name [example.com] - Whatever domain name you plan to use for your project when it goes live. + The domain name you plan to use for your project once it goes live. + Note that it can be safely changed later on whenever you need to. version [0.1.0] - The starting version number for your project. + The version of the project at its inception. + +open_source_license [1] + A software license for the project. The choices are: + + 1. MIT_ + 2. BSD_ + 3. GPLv3_ + 4. `Apache Software License 2.0`_ + 5. Not open source timezone [UTC] - Used in the base settings file for the `TIME_ZONE` value. - -use_whitenoise [y] - Whether to use WhiteNoise_ for static file serving. - -use_celery [n] - Whether to use Celery_. This gives you the ability to use distributed task - queues in your project. - -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_for_error_reporting [n] - Whether to use Sentry_ to log errors from your project. - -use_opbeat [n] - Whether to use Opbeat_ for preformance monitoring and code optimization. - -use_pycharm [n] - Adds support for developing in PyCharm_ with a preconfigured .idea directory. + The value to be used for the `TIME_ZONE` setting of the project. windows [n] - Whether you'll be developing on Windows. + Indicates whether the project should be configured for development on Windows. + +use_pycharm [n] + Indicates whether the project should be configured for development with PyCharm_. use_docker [y] - Whether to use Docker_, separating the app and database into separate - containers. + Indicates whether the project should be configured to use Docker_ and `Docker Compose`_. -use_heroku [n] - Add configuration to deploy the application to a Heroku_ instance. +postgresql_version [1] + Select a PostgreSQL_ version to use. The choices are: -use_compressor [n] - Use `Django Compressor`_ to minify and combine rendered JavaScript and CSS - into cachable static resources. + 1. 10.3 + 2. 10.2 + 3. 10.1 + 4. 9.6 + 5. 9.5 + 6. 9.4 + 7. 9.3 js_task_runner [1] Select a JavaScript task runner. The choices are: @@ -73,34 +65,63 @@ js_task_runner [1] 3. None custom_bootstrap_compilation [n] - If you use Grunt, scaffold out recompiling Bootstrap as as task. (Useful for letting you change Bootstrap variables in real time.) Consult project README for more details. + Indicates whether the project should support Bootstrap recompilation + via the selected JavaScript task runner's task. This can be useful + for real-time Bootstrap variable alteration. -open_source_license [1] - Select a software license for the project. The choices are: +use_compressor [n] + Indicates whether the project should be configured to use `Django Compressor`_. - 1. MIT_ - 2. BSD_ - 3. GPLv3_ - 4. `Apache Software License 2.0`_ - 5. Not open source +use_celery [n] + Indicates whether the project should be configured to use Celery_. + +use_mailhog [n] + Indicates whether the project should be configured to use MailHog_. + +use_sentry_for_error_reporting [n] + Indicates whether the project should be configured to use Sentry_. + +use_opbeat [n] + Indicates whether the project should be configured to use Opbeat_. + +use_whitenoise [y] + Indicates whether the project should be configured to use WhiteNoise_. + +use_heroku [n] + Indicates whether the project should be configured so as to be deployable + to Heroku_. + +use_travisci [n] + Indicates whether the project should be configured to use `Travis CI`_. -**NOTE:** *If you choose to use Docker, selecting a JavaScript task runner is -not supported out of the box.* -.. _WhiteNoise: https://github.com/evansd/whitenoise -.. _Celery: https://github.com/celery/celery -.. _MailHog: https://github.com/mailhog/MailHog -.. _Sentry: https://github.com/getsentry/sentry -.. _Opbeat: https://github.com/opbeat/opbeat_python -.. _PyCharm: https://www.jetbrains.com/pycharm/ -.. _Docker: https://github.com/docker/docker -.. _Heroku: https://github.com/heroku/heroku-buildpack-python -.. _Django Compressor: https://github.com/django-compressor/django-compressor -.. _Gulp: https://github.com/gulpjs/gulp -.. _Grunt: https://github.com/gruntjs/grunt -.. _Webpack: https://github.com/webpack/webpack -.. _Let's Encrypt: https://github.com/certbot/certbot .. _MIT: https://opensource.org/licenses/MIT .. _BSD: https://opensource.org/licenses/BSD-3-Clause .. _GPLv3: https://www.gnu.org/licenses/gpl.html .. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +.. _PyCharm: https://www.jetbrains.com/pycharm/ + +.. _Docker: https://github.com/docker/docker +.. _Docker Compose: https://docs.docker.com/compose/ + +.. _PostgreSQL: https://www.postgresql.org/docs/ + +.. _Gulp: https://github.com/gulpjs/gulp +.. _Grunt: https://github.com/gruntjs/grunt + +.. _Django Compressor: https://github.com/django-compressor/django-compressor + +.. _Celery: https://github.com/celery/celery + +.. _MailHog: https://github.com/mailhog/MailHog + +.. _Sentry: https://github.com/getsentry/sentry + +.. _Opbeat: https://github.com/opbeat/opbeat_python + +.. _WhiteNoise: https://github.com/evansd/whitenoise + +.. _Heroku: https://github.com/heroku/heroku-buildpack-python + +.. _Travis CI: https://travis-ci.org/ diff --git a/docs/settings.rst b/docs/settings.rst index 20bf9e5e1..828b5de4b 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -47,9 +47,8 @@ DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a 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 -MAILGUN_SENDER_DOMAIN MAILGUN_SENDER_DOMAIN n/a raises error +MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error +MAILGUN_DOMAIN MAILGUN_SENDER_DOMAIN n/a raises error NEW_RELIC_APP_NAME NEW_RELIC_APP_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 diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index 2ff52b029..69c89056f 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -1,10 +1,22 @@ +""" +NOTE: + the below code is to be maintained Python 2.x-compatible + as the whole Cookiecutter Django project initialization + can potentially be run in Python 2.x environment + (at least so we presume in `pre_gen_project.py`). + +TODO: ? restrict Cookiecutter Django project initialization to Python 3.x environments only +""" + import os import random import shutil import string +import sys try: - # Inspired by https://github.com/django/django/blob/master/django/utils/crypto.py + # Inspired by + # https://github.com/django/django/blob/master/django/utils/crypto.py random = random.SystemRandom() using_sysrandom = True except NotImplementedError: @@ -13,28 +25,23 @@ except NotImplementedError: PROJECT_DIR_PATH = os.path.realpath(os.path.curdir) -def remove_file(file_path: str) -> None: - if os.path.exists(file_path): - os.remove(file_path) - - -def remove_open_source_project_only_files() -> None: - filenames = [ - 'CONTRIBUTORS.txt' +def remove_open_source_project_only_files(): + file_names = [ + 'CONTRIBUTORS.txt', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_gplv3_files() -> None: - filenames = [ - 'COPYING' +def remove_gplv3_files(): + file_names = [ + 'COPYING', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_pycharm_files() -> None: +def remove_pycharm_files(): idea_dir_path = os.path.join(PROJECT_DIR_PATH, '.idea') if os.path.exists(idea_dir_path): shutil.rmtree(idea_dir_path) @@ -44,102 +51,79 @@ def remove_pycharm_files() -> None: shutil.rmtree(docs_dir_path) -def remove_docker_files() -> None: +def remove_docker_files(): shutil.rmtree(os.path.join(PROJECT_DIR_PATH, 'compose')) - filenames = [ + file_names = [ 'local.yml', 'production.yml', - '.dockerignore' + '.dockerignore', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_heroku_files() -> None: - filenames = [ +def remove_heroku_files(): + file_names = [ 'Procfile', - 'runtime.txt' + 'runtime.txt', + 'requirements.txt', ] - for filename in filenames: - remove_file(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_elasticbeanstalk_files() -> None: - ebextensions_dir_path = os.path.join(PROJECT_DIR_PATH, '.ebextensions') - if os.path.exists(ebextensions_dir_path): - shutil.rmtree(ebextensions_dir_path) +def remove_dotenv_file(): + os.remove(os.path.join(PROJECT_DIR_PATH, '.env')) - filenames = [ - 'ebsetenv.py' + +def remove_grunt_files(): + file_names = [ + 'Gruntfile.js', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def try_remove_paas_files() -> None: - none_paas_files_left = True - - if '{{ cookiecutter.use_heroku }}'.lower() != 'y': - remove_heroku_files() - none_paas_files_left &= True - else: - none_paas_files_left &= False - - if '{{ cookiecutter.use_elasticbeanstalk_experimental }}'.lower() != 'y': - remove_elasticbeanstalk_files() - none_paas_files_left &= True - else: - none_paas_files_left &= False - - if none_paas_files_left: - remove_file(os.path.join(PROJECT_DIR_PATH, 'requirements.txt')) - - -def remove_grunt_files() -> None: - filenames = [ - 'Gruntfile.js' +def remove_gulp_files(): + file_names = [ + 'gulpfile.js', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_gulp_files() -> None: - filenames = [ - 'gulpfile.js' +def remove_packagejson_file(): + file_names = [ + 'package.json', ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) + for file_name in file_names: + os.remove(os.path.join(PROJECT_DIR_PATH, file_name)) -def remove_packagejson_file() -> None: - filenames = [ - 'package.json' - ] - for filename in filenames: - os.remove(os.path.join(PROJECT_DIR_PATH, filename)) +def remove_celery_app(): + shutil.rmtree(os.path.join(PROJECT_DIR_PATH, '{{ cookiecutter.project_slug }}', 'taskapp')) -def remove_celery_app() -> None: - task_app_path = os.path.join(PROJECT_DIR_PATH, '{{ cookiecutter.project_slug }}', 'taskapp') - shutil.rmtree(task_app_path) +def remove_dottravisyml_file(): + os.remove(os.path.join(PROJECT_DIR_PATH, '.travis.yml')) -def append_to_gitignore(path) -> None: +def append_to_project_gitignore(path): gitignore_file_path = os.path.join(PROJECT_DIR_PATH, '.gitignore') with open(gitignore_file_path, 'a') as gitignore_file: gitignore_file.write(path) gitignore_file.write(os.linesep) -def generate_random_string(length: int, - using_digits: bool = False, - using_ascii_letters: bool = False, - using_punctuation: bool = False) -> str: +def generate_random_string(length, + using_digits=False, + using_ascii_letters=False, + using_punctuation=False): """ - Returns a securely generated random string. - For instance, opting out for 50 symbol-long, [a-z][A-Z][0-9] string - would yield log_2((26+26+50)^50) ~= 334 bit strength. + Example: + opting out for 50 symbol-long, [a-z][A-Z][0-9] string + would yield log_2((26+26+50)^50) ~= 334 bit strength. """ if not using_sysrandom: return None @@ -154,61 +138,114 @@ def generate_random_string(length: int, .replace('"', '') \ .replace("'", '') \ .replace('\\', '') - return ''.join([random.choice(symbols) for i in range(length)]) + return ''.join([random.choice(symbols) for _ in range(length)]) -def replace_flag_with_random_string(file_path: str, - flag: str, - *args, - **kwargs) -> None: - random_string = generate_random_string(*args, **kwargs) - if random_string is None: - print("We couldn't find a secure pseudo-random number generator on your system. " - "Please, {} manually.".format(flag)) - random_string = flag +def set_flag(file_path, + flag, + value=None, + *args, + **kwargs): + if value is None: + random_string = generate_random_string(*args, **kwargs) + if random_string is None: + import sys + sys.stdout.write( + "We couldn't find a secure pseudo-random number generator on your system. " + "Please, make sure to manually {} later.".format(flag) + ) + random_string = flag + value = random_string - with open(file_path, 'r+') as file: - file_contents = file.read().replace(flag, random_string) - file.seek(0) - file.write(file_contents) - file.truncate() + with open(file_path, 'r+') as f: + file_contents = f.read().replace(flag, value) + f.seek(0) + f.write(file_contents) + f.truncate() + + return value -def set_django_secret_key(file_path: str) -> None: - replace_flag_with_random_string(file_path, '!!!SET DJANGO_SECRET_KEY!!!', - length=50, - using_digits=True, - using_ascii_letters=True, - using_punctuation=True) +def set_django_secret_key(file_path): + django_secret_key = set_flag( + file_path, + '!!!SET DJANGO_SECRET_KEY!!!', + length=50, + using_digits=True, + using_ascii_letters=True + ) + return django_secret_key -def set_postgres_user(file_path: str) -> None: - replace_flag_with_random_string(file_path, '!!!SET POSTGRES_USER!!!', - length=8, - using_ascii_letters=True) +def set_postgres_user(file_path, + value=None): + postgres_user = set_flag( + file_path, + '!!!SET POSTGRES_USER!!!', + value=value, + length=8, + using_ascii_letters=True + ) + return postgres_user -def set_postgres_password(file_path: str) -> None: - replace_flag_with_random_string(file_path, '!!!SET POSTGRES_PASSWORD!!!', - length=30, - using_digits=True, - using_ascii_letters=True) +def set_postgres_password(file_path): + postgres_password = set_flag( + file_path, + '!!!SET POSTGRES_PASSWORD!!!', + length=42, + using_digits=True, + using_ascii_letters=True + ) + return postgres_password + + +def initialize_dotenv(postgres_user): + # Initializing `env.example` first. + envexample_file_path = os.path.join(PROJECT_DIR_PATH, 'env.example') + set_django_secret_key(envexample_file_path) + set_postgres_user(envexample_file_path, value=postgres_user) + set_postgres_password(envexample_file_path) + # Renaming `env.example` to `.env`. + dotenv_file_path = os.path.join(PROJECT_DIR_PATH, '.env') + shutil.move(envexample_file_path, dotenv_file_path) + + +def initialize_localyml(postgres_user): + set_postgres_user(os.path.join(PROJECT_DIR_PATH, 'local.yml'), value=postgres_user) + + +def initialize_local_settings(): + set_django_secret_key(os.path.join(PROJECT_DIR_PATH, 'config', 'settings', 'local.py')) + + +def initialize_test_settings(): + set_django_secret_key(os.path.join(PROJECT_DIR_PATH, 'config', 'settings', 'test.py')) def main(): + postgres_user = generate_random_string(length=16, using_ascii_letters=True) + initialize_dotenv(postgres_user) + initialize_localyml(postgres_user) + initialize_local_settings() + initialize_test_settings() + if '{{ cookiecutter.open_source_license }}' == 'Not open source': remove_open_source_project_only_files() - if '{{ cookiecutter.open_source_license}}' != 'GPLv3': remove_gplv3_files() - if '{{ cookiecutter.use_pycharm }}'.lower() != 'y': + if '{{ cookiecutter.use_pycharm }}'.lower() == 'n': remove_pycharm_files() - if '{{ cookiecutter.use_docker }}'.lower() != 'y': + if '{{ cookiecutter.use_docker }}'.lower() == 'n': remove_docker_files() - try_remove_paas_files() + if '{{ cookiecutter.use_heroku }}'.lower() == 'n': + remove_heroku_files() + + if '{{ cookiecutter.use_docker }}'.lower() == 'n' and '{{ cookiecutter.use_heroku }}'.lower() == 'n': + remove_dotenv_file() if '{{ cookiecutter.js_task_runner}}'.lower() == 'gulp': remove_grunt_files() @@ -221,31 +258,23 @@ def main(): if '{{ cookiecutter.js_task_runner }}'.lower() in ['grunt', 'gulp'] \ and '{{ cookiecutter.use_docker }}'.lower() == 'y': - print( - "You selected to use docker and a JS task runner. " - "This is NOT supported out of the box for now. " - "You can continue to use the project like you normally would, " - "but you would need to add a JS task runner service " - "to your Docker Compose configuration manually." + TERMINATOR = "\x1b[0m" + INFO = "\x1b[1;33m [INFO]: " + sys.stdout.write( + INFO + + "Docker and {} JS task runner ".format('{{ cookiecutter.js_task_runner }}'.lower().capitalize()) + + "working together not supported yet. " + "You can continue using the generated project like you normally would, " + "however you would need to add a JS task runner service " + "to your Docker Compose configuration manually." + + TERMINATOR ) if '{{ cookiecutter.use_celery }}'.lower() == 'n': remove_celery_app() - append_to_gitignore('.envs/') - append_to_gitignore('.env') - - set_django_secret_key(os.path.join(PROJECT_DIR_PATH, 'config', 'settings', 'local.py')) - set_django_secret_key(os.path.join(PROJECT_DIR_PATH, 'config', 'settings', 'test.py')) - set_django_secret_key(os.path.join(PROJECT_DIR_PATH, '.envs', '.production', '.django')) - - envs_local_postgres = os.path.join(PROJECT_DIR_PATH, '.envs', '.local', '.postgres') - set_postgres_user(envs_local_postgres) - set_postgres_password(envs_local_postgres) - - envs_production_postgres = os.path.join(PROJECT_DIR_PATH, '.envs', '.production', '.postgres') - set_postgres_user(envs_production_postgres) - set_postgres_password(envs_production_postgres) + if '{{ cookiecutter.use_travisci }}'.lower() == 'n': + remove_dottravisyml_file() if __name__ == '__main__': diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py index c7a68450b..c48ce0ad8 100644 --- a/hooks/pre_gen_project.py +++ b/hooks/pre_gen_project.py @@ -1,31 +1,62 @@ +""" +NOTE: + the below code is to be maintained Python 2.x-compatible + as the whole Cookiecutter Django project initialization + can potentially be run in Python 2.x environment. + +TODO: ? restrict Cookiecutter Django project initialization to Python 3.x environments only +""" + project_slug = '{{ cookiecutter.project_slug }}' - if hasattr(project_slug, 'isidentifier'): - assert project_slug.isidentifier(), 'Project slug should be valid Python identifier!' + assert project_slug.isidentifier(), "'{}' project slug is not a valid Python identifier.".format(project_slug) -elasticbeanstalk = '{{ cookiecutter.use_elasticbeanstalk_experimental }}'.lower() -heroku = '{{ cookiecutter.use_heroku }}'.lower() -docker = '{{ cookiecutter.use_docker }}'.lower() +assert "\\" not in "{{ cookiecutter.author_name }}", "Don't include backslashes in author name." -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 +using_docker = '{{ cookiecutter.use_docker }}'.lower() +if using_docker == 'n': + TERMINATOR = "\x1b[0m" + WARNING = "\x1b[1;33m [WARNING]: " + INFO = "\x1b[1;33m [INFO]: " + HINT = "\x1b[3;33m" + SUCCESS = "\x1b[1;32m [SUCCESS]: " - python_major_version = sys.version_info[0] + import sys - 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)") + 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.6+ only, " + "are you sure you want to proceed (y/n)? " + + TERMINATOR + ) + yes_options, no_options = frozenset(['y']), frozenset(['n']) + while True: + choice = raw_input().lower() + if choice in yes_options: + break + elif choice in no_options: + sys.stdout.write( + INFO + + "Generation process stopped as requested." + + TERMINATOR + ) + sys.exit(1) + else: + sys.stdout.write( + HINT + + "Please respond with {} or {}: ".format( + ', '.join(["'{}'".format(o) for o in yes_options if not o == '']), + ', '.join(["'{}'".format(o) for o in no_options if not o == '']) + ) + + TERMINATOR + ) - 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 == '']))) + sys.stdout.write( + SUCCESS + + "Project initialized, keep up the good work!" + + TERMINATOR + ) diff --git a/requirements.txt b/requirements.txt index 6d3fa8cda..d549c678a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,11 +1,17 @@ cookiecutter==1.6.0 -flake8==3.5.0 # pyup: != 2.6.0 sh==1.12.14 binaryornot==0.4.4 -# Testing -pytest==3.2.5 + +# Code quality +# ------------------------------------------------------------------------------ +flake8==3.5.0 pycodestyle==2.3.1 pyflakes==1.6.0 + + +# Testing +# ------------------------------------------------------------------------------ tox==2.9.1 +pytest==3.4.2 pytest-cookies==0.3.0 diff --git a/requirements_to_watch.txt b/requirements_to_watch.txt deleted file mode 100644 index 4440448d4..000000000 --- a/requirements_to_watch.txt +++ /dev/null @@ -1,4 +0,0 @@ -# These requirements prevented an upgrade to Django 1.10. -django-coverage-plugin==1.5.0 -django-autoslug==1.9.3 - diff --git a/setup.py b/setup.py index 6dc6635ea..a7efb0a64 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,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.10.7' +version = '2.0.2' if sys.argv[-1] == 'tag': os.system('git tag -a %s -m "version %s"' % (version, version)) @@ -34,16 +34,14 @@ setup( classifiers=[ 'Development Status :: 4 - Beta', 'Environment :: Console', - 'Framework :: Django :: 1.10', + 'Framework :: Django :: 2.0', 'Intended Audience :: Developers', 'Natural Language :: English', 'License :: OSI Approved :: BSD License', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: Implementation :: CPython', - 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Software Development', ], keywords=( diff --git a/tests/test_docker.sh b/tests/test_docker.sh index 137694d7a..384fdff2d 100755 --- a/tests/test_docker.sh +++ b/tests/test_docker.sh @@ -12,10 +12,13 @@ cd .cache/docker # create the project using the default settings in cookiecutter.json cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y js_task_runner=None -cd project_name +cd my_awesome_project # run the project's tests 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 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; } + +# Test support for translations +docker-compose -f local.yml run django python manage.py makemessages diff --git a/tox.ini b/tox.ini index 311d80f45..2399e24d5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,12 +1,11 @@ [tox] skipsdist = true -envlist = py34,py35 +envlist = py36 [testenv] -passenv = LC_ALL, LANG, HOME deps = binaryornot flake8==2.5.5 pytest-cookies sh -commands = py.test {posargs:tests} +commands = pytest {posargs:./tests} diff --git a/{{cookiecutter.project_slug}}/.ebextensions/10_packages.config b/{{cookiecutter.project_slug}}/.ebextensions/10_packages.config deleted file mode 100644 index c0774efae..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/10_packages.config +++ /dev/null @@ -1,5 +0,0 @@ -packages: - yum: - git: [] - postgresql94-devel: [] - libjpeg-turbo-devel: [] diff --git a/{{cookiecutter.project_slug}}/.ebextensions/20_elasticcache.config b/{{cookiecutter.project_slug}}/.ebextensions/20_elasticcache.config deleted file mode 100644 index 26c059e30..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/20_elasticcache.config +++ /dev/null @@ -1,46 +0,0 @@ -#This sample requires you to create a separate configuration file that defines the custom -# option settings for CacheCluster properties. - -Resources: - MyCacheSecurityGroup: - Type: "AWS::EC2::SecurityGroup" - Properties: - GroupDescription: "Lock cache down to webserver access only" - SecurityGroupIngress : - - IpProtocol : "tcp" - FromPort : - Fn::GetOptionSetting: - OptionName : "CachePort" - DefaultValue: "6379" - ToPort : - Fn::GetOptionSetting: - OptionName : "CachePort" - DefaultValue: "6379" - SourceSecurityGroupName: - Ref: "AWSEBSecurityGroup" - MyElastiCache: - Type: "AWS::ElastiCache::CacheCluster" - Properties: - CacheNodeType: - Fn::GetOptionSetting: - OptionName : "CacheNodeType" - DefaultValue : "cache.t2.micro" - NumCacheNodes: - Fn::GetOptionSetting: - OptionName : "NumCacheNodes" - DefaultValue : "1" - Engine: - Fn::GetOptionSetting: - OptionName : "Engine" - DefaultValue : "redis" - VpcSecurityGroupIds: - - - Fn::GetAtt: - - MyCacheSecurityGroup - - GroupId - -Outputs: - ElastiCache: - Description : "ID of ElastiCache Cache Cluster with Redis Engine" - Value : - Ref : "MyElastiCache" diff --git a/{{cookiecutter.project_slug}}/.ebextensions/30_options.config b/{{cookiecutter.project_slug}}/.ebextensions/30_options.config deleted file mode 100644 index fefec489d..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/30_options.config +++ /dev/null @@ -1,6 +0,0 @@ -option_settings: - "aws:elasticbeanstalk:customoption": - CacheNodeType : cache.t2.micro - NumCacheNodes : 1 - Engine : redis - CachePort : 6379 diff --git a/{{cookiecutter.project_slug}}/.ebextensions/40_python.config b/{{cookiecutter.project_slug}}/.ebextensions/40_python.config deleted file mode 100644 index 111bf1ca8..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/40_python.config +++ /dev/null @@ -1,17 +0,0 @@ -container_commands: - 01_migrate: - command: "source /opt/python/run/venv/bin/activate && python manage.py migrate --noinput" - leader_only: True - 02_collectstatic: - command: "source /opt/python/run/venv/bin/activate && python manage.py collectstatic --noinput" -option_settings: - "aws:elasticbeanstalk:application:environment": - DJANGO_SETTINGS_MODULE: "config.settings.production" - REDIS_ENDPOINT_ADDRESS: '`{ "Fn::GetAtt" : [ "MyElastiCache", "RedisEndpoint.Address"]}`' - REDIS_PORT: '`{ "Fn::GetAtt" : [ "MyElastiCache", "RedisEndpoint.Port"]}`' - "aws:elasticbeanstalk:container:python": - WSGIPath: "config/wsgi.py" - NumProcesses: 3 - NumThreads: 20 - "aws:elasticbeanstalk:container:python:staticfiles": - "/static/": "www/static/" diff --git a/{{cookiecutter.project_slug}}/.ebextensions/50_apache.config b/{{cookiecutter.project_slug}}/.ebextensions/50_apache.config deleted file mode 100644 index 672cb625b..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/50_apache.config +++ /dev/null @@ -1,3 +0,0 @@ -container_commands: - 01_setup_apache: - command: "cp .ebextensions/enable_mod_deflate.conf /etc/httpd/conf.d/enable_mod_deflate.conf" diff --git a/{{cookiecutter.project_slug}}/.ebextensions/enable_mod_deflate.conf b/{{cookiecutter.project_slug}}/.ebextensions/enable_mod_deflate.conf deleted file mode 100644 index 7a77cc234..000000000 --- a/{{cookiecutter.project_slug}}/.ebextensions/enable_mod_deflate.conf +++ /dev/null @@ -1,25 +0,0 @@ -# mod_deflate configuration - - # Restrict compression to these MIME types - AddOutputFilterByType DEFLATE text/plain - AddOutputFilterByType DEFLATE text/html - AddOutputFilterByType DEFLATE application/xhtml+xml - AddOutputFilterByType DEFLATE text/xml - AddOutputFilterByType DEFLATE application/xml - AddOutputFilterByType DEFLATE application/xml+rss - AddOutputFilterByType DEFLATE application/x-javascript - AddOutputFilterByType DEFLATE text/javascript - AddOutputFilterByType DEFLATE text/css - # Level of compression (Highest 9 - Lowest 1) - DeflateCompressionLevel 9 - # Netscape 4.x has some problems. - BrowserMatch ^Mozilla/4 gzip-only-text/html - # Netscape 4.06-4.08 have some more problems - BrowserMatch ^Mozilla/4\.0[678] no-gzip - # MSIE masquerades as Netscape, but it is fine - BrowserMatch \bMSI[E] !no-gzip !gzip-only-text/html - - # Make sure proxies don't deliver the wrong content - Header append Vary User-Agent env=!dont-vary - - diff --git a/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml b/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml index 95f45bfb7..cc2fe0bb0 100644 --- a/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml +++ b/{{cookiecutter.project_slug}}/.idea/runConfigurations/Docker__migrate.xml @@ -6,7 +6,7 @@ -