cookiecutter-django/README.rst

264 lines
10 KiB
ReStructuredText
Raw Normal View History

Cookiecutter Django
2013-08-15 22:32:13 +04:00
=======================
2016-06-09 18:23:02 +03:00
.. image:: https://pyup.io/repos/github/pydanny/cookiecutter-django/shield.svg
:target: https://pyup.io/repos/github/pydanny/cookiecutter-django/
:alt: Updates
2014-10-30 16:16:19 +03:00
.. image:: https://travis-ci.org/pydanny/cookiecutter-django.svg?branch=master
2014-12-03 18:35:34 +03:00
:target: https://travis-ci.org/pydanny/cookiecutter-django?branch=master
2014-10-30 16:16:19 +03:00
:alt: Build Status
2015-08-09 18:03:08 +03:00
2015-08-09 03:23:56 +03:00
.. 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
2015-08-09 18:03:08 +03:00
2016-04-17 22:00:56 +03:00
Powered by Cookiecutter_, Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.
2013-08-15 22:32:13 +04:00
* Documentation: https://cookiecutter-django.readthedocs.io/en/latest/
2016-06-07 03:21:39 +03:00
* See Troubleshooting_ for common errors and obstacles
2013-08-15 22:32:13 +04:00
.. _cookiecutter: https://github.com/audreyr/cookiecutter
.. _Troubleshooting: https://cookiecutter-django.readthedocs.io/en/latest/troubleshooting.html
.. _528: https://github.com/pydanny/cookiecutter-django/issues/528#issuecomment-212650373
2013-08-16 15:03:11 +04:00
Features
---------
2015-12-09 15:33:17 +03:00
* For Django 1.9
2016-02-24 23:22:22 +03:00
* Renders Django projects with 100% starting test coverage
2016-08-20 00:18:20 +03:00
* Twitter Bootstrap_ v4.0.0 - `alpha 3`_
2015-04-26 12:45:58 +03:00
* 12-Factor_ based settings via django-environ_
* Optimized development and production settings
* Registration via django-allauth_
2016-06-27 23:28:14 +03:00
* Comes with custom user model ready to go
* Grunt build for compass and livereload
* Send emails via Anymail_ (using Mailgun_ by default, but switchable)
2015-04-26 12:45:58 +03:00
* Media storage using Amazon S3
2015-11-16 14:20:19 +03:00
* Docker support using docker-compose_ for development and production
2015-08-30 22:12:21 +03:00
* Procfile_ for deploying to Heroku
* Instructions for deploying to PythonAnywhere_
2016-04-16 23:36:12 +03:00
* Works with Python 2.7.x or 3.5.x
* Run tests with unittest or py.test
2016-08-10 18:31:48 +03:00
* Customizable PostgreSQL version
2016-02-24 23:22:22 +03:00
2015-11-16 14:20:19 +03:00
Optional Integrations
---------------------
*These features can be enabled during initial project setup.*
* Serve static files from Amazon S3 or Whitenoise_
* Configuration for Celery_
2015-11-18 14:16:25 +03:00
* Integration with MailHog_ for local email testing
2015-11-16 14:20:19 +03:00
* Integration with Sentry_ for error logging
* Integration with Opbeat_ for performance monitoring
2015-11-16 14:20:19 +03:00
2016-08-20 00:18:20 +03:00
.. _`alpha 3`: http://blog.getbootstrap.com/2016/07/27/bootstrap-4-alpha-3/
.. _Bootstrap: https://github.com/twbs/bootstrap
.. _django-environ: https://github.com/joke2k/django-environ
2015-04-26 12:45:58 +03:00
.. _12-Factor: http://12factor.net/
.. _django-allauth: https://github.com/pennersr/django-allauth
.. _django-avatar: https://github.com/grantmcconnaughey/django-avatar
.. _Procfile: https://devcenter.heroku.com/articles/procfile
.. _Mailgun: http://www.mailgun.com/
.. _Whitenoise: https://whitenoise.readthedocs.io/
.. _Celery: http://www.celeryproject.org/
.. _Anymail: https://github.com/anymail/django-anymail
2015-11-18 14:16:25 +03:00
.. _MailHog: https://github.com/mailhog/MailHog
.. _Sentry: https://getsentry.com/welcome/
.. _docker-compose: https://github.com/docker/compose
.. _Opbeat: https://opbeat.com/
.. _PythonAnywhere: https://www.pythonanywhere.com/
2013-08-16 15:35:18 +04:00
Constraints
-----------
* Only maintained 3rd party libraries are used.
2016-08-10 18:31:48 +03:00
* Uses PostgreSQL everywhere (9.2+)
* Environment variables for configuration (This won't work with Apache/mod_wsgi).
2013-08-16 15:03:11 +04:00
2013-08-20 13:16:39 +04:00
2013-08-18 16:44:28 +04:00
Usage
------
2013-08-16 15:03:11 +04:00
2013-08-18 16:46:20 +04:00
Let's pretend you want to create a Django project called "redditclone". Rather than using `startproject`
and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter_ to do all the work.
First, get Cookiecutter. Trust me, it's awesome::
2013-08-16 15:03:11 +04:00
$ pip install cookiecutter
2013-08-18 16:44:28 +04:00
Now run it against this repo::
$ cookiecutter https://github.com/pydanny/cookiecutter-django
2013-08-18 16:44:28 +04:00
You'll be prompted for some values. Provide them, then a Django project will be created for you.
2013-08-18 16:44:28 +04:00
**Warning**: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.
Answer the prompts with your own desired options_. For example::
2013-08-18 16:44:28 +04:00
2013-08-23 11:55:52 +04:00
Cloning into 'cookiecutter-django'...
remote: Counting objects: 550, done.
remote: Compressing objects: 100% (310/310), done.
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.
2015-08-31 06:06:11 +03:00
project_name [project_name]: Reddit Clone
2016-06-28 05:09:51 +03:00
project_slug [reddit_clone]: reddit
author_name [Your Name]: Daniel Roy Greenfeld
2015-08-31 06:06:11 +03:00
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]: America/Los_Angeles
2015-08-31 06:06:11 +03:00
use_whitenoise [y]: n
use_celery [n]: y
2015-11-18 14:16:25 +03:00
use_mailhog [n]: n
2016-06-05 20:47:07 +03:00
use_sentry_for_error_reporting [y]: y
2015-11-18 06:54:29 +03:00
use_opbeat [n]: y
use_pycharm [n]: y
2015-09-30 21:12:38 +03:00
windows [n]: n
use_python3 [y]: y
2016-06-28 05:09:51 +03:00
use_docker [y]: n
use_heroku [n]: y
use_compressor [n]: y
2016-08-10 18:31:48 +03:00
Select postgresql_version:
1 - 9.2
2 - 9.3
3 - 9.4
4 - 9.5
Choose from 1, 2, 3, 4 [1]: 1
2016-06-28 05:09:51 +03:00
Select js_task_runner:
1 - Gulp
2 - Grunt
3 - Webpack
4 - None
Choose from 1, 2, 3, 4 [1]: 1
use_lets_encrypt [n]: n
2016-03-06 07:30:27 +03:00
Select open_source_license:
1 - MIT
2 - BSD
2016-06-24 17:59:55 +03:00
3 - GPLv3
4 - Apache Software License 2.0
5 - Not open source
Choose from 1, 2, 3, 4, 5 [1]: 1
2013-08-18 16:44:28 +04:00
Enter the project and take a look around::
2015-08-31 06:16:39 +03:00
$ cd reddit/
2013-08-18 16:44:28 +04:00
$ ls
Create a git repo and push it there::
2013-08-18 16:44:28 +04:00
$ git init
$ git add .
2013-09-19 14:02:46 +04:00
$ git commit -m "first awesome commit"
2013-08-18 16:44:28 +04:00
$ git remote add origin git@github.com:pydanny/redditclone.git
$ git push -u origin master
Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?
2013-08-18 16:44:28 +04:00
2016-06-27 23:28:14 +03:00
For local development, see the following:
2015-09-18 20:20:48 +03:00
* `Developing locally`_
* `Developing locally using docker`_
* `Developing locally using webpack`_
.. _options: http://cookiecutter-django.readthedocs.io/en/latest/project-generation-options.html
.. _`Developing locally`: http://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html
.. _`Developing locally using docker`: http://cookiecutter-django.readthedocs.io/en/latest/developing-locally-docker.html
.. _`Developing locally using webpack`: http://cookiecutter-django.readthedocs.io/en/latest/developing-locally-webpack.html
2015-09-18 20:20:48 +03:00
2016-04-26 01:11:19 +03:00
Community
-----------
2016-06-27 23:28:14 +03:00
* Have questions? **Before you ask questions anywhere else**, please post your question on `Stack Overflow`_ under the *cookiecutter-django* tag. We check there periodically for questions.
2016-04-26 01:11:19 +03:00
* If you think you found a bug or want to request a feature, please open an issue_.
* For anything else, you can chat with us on `Gitter`_.
.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/cookiecutter-django
.. _`issue`: https://github.com/pydanny/cookiecutter-django/issues
2016-04-26 01:11:19 +03:00
.. _`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
--------------------------------------------
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.
2013-08-16 20:23:22 +04:00
"Your Stuff"
-------------
2013-08-17 14:38:23 +04:00
Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
2013-08-18 22:50:39 +04:00
2013-09-17 16:21:44 +04:00
Releases
--------
2016-06-27 23:28:14 +03:00
Need a stable release? You can find them at https://github.com/pydanny/cookiecutter-django/releases
2013-09-17 16:21:44 +04:00
2013-08-18 22:50:39 +04:00
Not Exactly What You Want?
---------------------------
2013-08-18 22:53:55 +04:00
This is what I want. *It might not be what you want.* Don't worry, you have options:
2013-08-18 22:50:39 +04:00
Fork This
~~~~~~~~~~
If you have differences in your preferred setup, I encourage you to fork this to create your own version.
Once you have your fork working, let me know and I'll add it to a '*Similar Cookiecutter Templates*' list here.
It's up to you whether or not to rename your fork.
If you do rename your fork, I encourage you to submit it to the following places:
* cookiecutter_ so it gets listed in the README as a template.
2013-08-18 22:50:39 +04:00
* The cookiecutter grid_ on Django Packages.
.. _cookiecutter: https://github.com/audreyr/cookiecutter
.. _grid: https://www.djangopackages.com/grids/g/cookiecutters/
2013-08-18 22:50:39 +04:00
2016-06-27 23:28:14 +03:00
Submit a Pull Request
~~~~~~~~~~~~~~~~~~~~~~
2013-08-18 22:50:39 +04:00
2016-06-27 23:29:19 +03:00
We accept pull requests if they're small, atomic, and make our own project development
experience better.
2016-04-16 23:36:12 +03:00
Articles
---------
* `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
2016-04-17 19:56:28 +03:00
* `Introduction to Cookiecutter-Django`_ - Feb. 19, 2016
* `Django and GitLab - Running Continuous Integration and tests with your FREE account`_ - May. 11, 2016
2016-04-16 23:36:12 +03:00
2016-06-27 23:28:14 +03:00
Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.
2016-04-16 23:36:12 +03:00
.. _`Development and Deployment of Cookiecutter-Django via Docker`: https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-via-docker/
2016-04-16 23:36:12 +03:00
.. _`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/
2016-04-17 19:56:28 +03:00
.. _`Introduction to Cookiecutter-Django`: http://krzysztofzuraw.com/blog/2016/django-cookiecutter.html
.. _`Django and GitLab - Running Continuous Integration and tests with your FREE account`: http://dezoito.github.io/2016/05/11/django-gitlab-continuous-integration-phantomjs.html
2016-04-16 23:36:12 +03:00
2016-06-16 19:37:11 +03:00
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`_.
2016-04-16 23:36:12 +03:00
Support This Project
---------------------------
This project is maintained by volunteers. Support their efforts by spreading the word about:
.. image:: https://s3.amazonaws.com/tsacademy/images/tsa-logo-250x60-transparent-01.png
:name: Two Scoops Academy
:align: center
:alt: Two Scoops Academy
:target: https://twoscoops.academy/
2016-06-16 19:37:11 +03:00
.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/