mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-11-14 05:36:58 +03:00
Convert top level RST files to Markdown (#3489)
This commit is contained in:
Bruno Alla
GitHub
parent
8f481be3cb
commit
103dd82ea2
42
CONTRIBUTING.md
Normal file
42
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# How to Contribute
|
||||||
|
|
||||||
|
Always happy to get issues identified and pull requests!
|
||||||
|
|
||||||
|
## Getting your pull request merged in
|
||||||
|
|
||||||
|
1. Keep it small. The smaller the pull request, the more likely we are to accept.
|
||||||
|
2. Pull requests that fix a current issue get priority for review.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
Please install [tox](https://tox.readthedocs.io/en/latest/), which is a generic virtualenv management and test command line tool.
|
||||||
|
|
||||||
|
[tox](https://tox.readthedocs.io/en/latest/) is available for download from [PyPI](https://pypi.python.org/pypi) via [pip](https://pypi.python.org/pypi/pip/):
|
||||||
|
|
||||||
|
$ pip install tox
|
||||||
|
|
||||||
|
It will automatically create a fresh virtual environment and install our test dependencies,
|
||||||
|
such as [pytest-cookies](https://pypi.python.org/pypi/pytest-cookies/) and [flake8](https://pypi.python.org/pypi/flake8/).
|
||||||
|
|
||||||
|
### Run the Tests
|
||||||
|
|
||||||
|
Tox uses pytest under the hood, hence it supports the same syntax for selecting tests.
|
||||||
|
|
||||||
|
For further information please consult the [pytest usage docs](https://pytest.org/latest/usage.html#specifying-tests-selecting-tests).
|
||||||
|
|
||||||
|
To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.:
|
||||||
|
|
||||||
|
$ tox
|
||||||
|
|
||||||
|
It is possible to test with a specific version of python. To do this, the command
|
||||||
|
is:
|
||||||
|
|
||||||
|
$ tox -e py39
|
||||||
|
|
||||||
|
This will run pytest with the python3.9 interpreter, for example.
|
||||||
|
|
||||||
|
To run a particular test with tox for against your current Python version:
|
||||||
|
|
||||||
|
$ tox -e py -- -k test_default_configuration
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
How to Contribute
|
|
||||||
=================
|
|
||||||
|
|
||||||
Always happy to get issues identified and pull requests!
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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 test with a specific version of python. To do this, the command
|
|
||||||
is::
|
|
||||||
|
|
||||||
$ tox -e py39
|
|
||||||
|
|
||||||
This will run py.test with the python3.9 interpreter, 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.io/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
|
|
||||||
225
README.md
Normal file
225
README.md
Normal file
|
|
@ -0,0 +1,225 @@
|
||||||
|
# Cookiecutter Django
|
||||||
|
|
||||||
|
[](https://github.com/cookiecutter/cookiecutter-django/actions?query=workflow%3ACI)
|
||||||
|
[](https://cookiecutter-django.readthedocs.io/en/latest/?badge=latest)
|
||||||
|
[](https://pyup.io/repos/github/cookiecutter/cookiecutter-django/)
|
||||||
|
[](https://discord.gg/9BrxzPKuEW)
|
||||||
|
[](https://www.codetriage.com/cookiecutter/cookiecutter-django)
|
||||||
|
[](https://github.com/ambv/black)
|
||||||
|
|
||||||
|
Powered by [Cookiecutter](https://github.com/cookiecutter/cookiecutter), Cookiecutter Django is a framework for jumpstarting
|
||||||
|
production-ready Django projects quickly.
|
||||||
|
|
||||||
|
- Documentation: <https://cookiecutter-django.readthedocs.io/en/latest/>
|
||||||
|
- See [Troubleshooting](https://cookiecutter-django.readthedocs.io/en/latest/troubleshooting.html) for common errors and obstacles
|
||||||
|
- If you have problems with Cookiecutter Django, please open [issues](https://github.com/cookiecutter/cookiecutter-django/issues/new) don't send
|
||||||
|
emails to the maintainers.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- For Django 3.2
|
||||||
|
- Works with Python 3.9
|
||||||
|
- Renders Django projects with 100% starting test coverage
|
||||||
|
- Twitter [Bootstrap](https://github.com/twbs/bootstrap) v5
|
||||||
|
- [12-Factor](http://12factor.net/) based settings via [django-environ](https://github.com/joke2k/django-environ)
|
||||||
|
- Secure by default. We believe in SSL.
|
||||||
|
- Optimized development and production settings
|
||||||
|
- Registration via [django-allauth](https://github.com/pennersr/django-allauth)
|
||||||
|
- Comes with custom user model ready to go
|
||||||
|
- Optional basic ASGI setup for Websockets
|
||||||
|
- Optional custom static build using Gulp and livereload
|
||||||
|
- Send emails via [Anymail](https://github.com/anymail/django-anymail) (using [Mailgun](http://www.mailgun.com/) by default or Amazon SES if AWS is selected cloud provider, but switchable)
|
||||||
|
- Media storage using Amazon S3 or Google Cloud Storage
|
||||||
|
- Docker support using [docker-compose](https://github.com/docker/compose) for development and production (using [Traefik](https://traefik.io/) with [LetsEncrypt](https://letsencrypt.org/) support)
|
||||||
|
- [Procfile](https://devcenter.heroku.com/articles/procfile) for deploying to Heroku
|
||||||
|
- Instructions for deploying to [PythonAnywhere](https://www.pythonanywhere.com/)
|
||||||
|
- Run tests with unittest or pytest
|
||||||
|
- Customizable PostgreSQL version
|
||||||
|
- Default integration with [pre-commit](https://github.com/pre-commit/pre-commit) for identifying simple issues before submission to code review
|
||||||
|
|
||||||
|
## Optional Integrations
|
||||||
|
|
||||||
|
*These features can be enabled during initial project setup.*
|
||||||
|
|
||||||
|
- Serve static files from Amazon S3, Google Cloud Storage or [Whitenoise](https://whitenoise.readthedocs.io/)
|
||||||
|
- Configuration for [Celery](http://www.celeryproject.org/) and [Flower](https://github.com/mher/flower) (the latter in Docker setup only)
|
||||||
|
- Integration with [MailHog](https://github.com/mailhog/MailHog) for local email testing
|
||||||
|
- Integration with [Sentry](https://sentry.io/welcome/) for error logging
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
- Only maintained 3rd party libraries are used.
|
||||||
|
- Uses PostgreSQL everywhere (10.19 - 14.1)
|
||||||
|
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
|
||||||
|
|
||||||
|
## Support this Project!
|
||||||
|
|
||||||
|
This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:
|
||||||
|
|
||||||
|
- Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB.
|
||||||
|
- Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience.
|
||||||
|
|
||||||
|
Projects that provide financial support to the maintainers:
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
|
[{#Two Scoops of Django 3.x .align-center}](https://www.feldroy.com/products//two-scoops-of-django-3-x)
|
||||||
|
|
||||||
|
Two Scoops of Django 3.x is the best ice cream-themed Django reference in the universe!
|
||||||
|
|
||||||
|
### PyUp
|
||||||
|
|
||||||
|
[{#pyup .align-center}](https://pyup.io/)
|
||||||
|
|
||||||
|
PyUp brings you automated security and dependency updates used by Google and other organizations. Free for open source projects!
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
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](https://github.com/cookiecutter/cookiecutter) to do all the work.
|
||||||
|
|
||||||
|
First, get Cookiecutter. Trust me, it's awesome:
|
||||||
|
|
||||||
|
$ pip install "cookiecutter>=1.7.0"
|
||||||
|
|
||||||
|
Now run it against this repo:
|
||||||
|
|
||||||
|
$ cookiecutter https://github.com/cookiecutter/cookiecutter-django
|
||||||
|
|
||||||
|
You'll be prompted for some values. Provide them, then a Django project will be created for you.
|
||||||
|
|
||||||
|
**Warning**: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.
|
||||||
|
|
||||||
|
Answer the prompts with your own desired [options](http://cookiecutter-django.readthedocs.io/en/latest/project-generation-options.html). For example:
|
||||||
|
|
||||||
|
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.
|
||||||
|
project_name [Project Name]: Reddit Clone
|
||||||
|
project_slug [reddit_clone]: reddit
|
||||||
|
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
|
||||||
|
email [you@example.com]: pydanny@gmail.com
|
||||||
|
description [Behold My Awesome Project!]: A reddit clone.
|
||||||
|
domain_name [example.com]: myreddit.com
|
||||||
|
version [0.1.0]: 0.0.1
|
||||||
|
timezone [UTC]: America/Los_Angeles
|
||||||
|
use_whitenoise [n]: n
|
||||||
|
use_celery [n]: y
|
||||||
|
use_mailhog [n]: n
|
||||||
|
use_sentry [n]: y
|
||||||
|
use_pycharm [n]: y
|
||||||
|
windows [n]: n
|
||||||
|
use_docker [n]: n
|
||||||
|
use_heroku [n]: y
|
||||||
|
use_compressor [n]: y
|
||||||
|
Select postgresql_version:
|
||||||
|
1 - 14.1
|
||||||
|
2 - 13.5
|
||||||
|
3 - 12.9
|
||||||
|
4 - 11.14
|
||||||
|
5 - 10.19
|
||||||
|
Choose from 1, 2, 3, 4, 5 [1]: 1
|
||||||
|
Select js_task_runner:
|
||||||
|
1 - None
|
||||||
|
2 - Gulp
|
||||||
|
Choose from 1, 2 [1]: 1
|
||||||
|
Select cloud_provider:
|
||||||
|
1 - AWS
|
||||||
|
2 - GCP
|
||||||
|
3 - None
|
||||||
|
Choose from 1, 2, 3 [1]: 1
|
||||||
|
custom_bootstrap_compilation [n]: n
|
||||||
|
Select open_source_license:
|
||||||
|
1 - MIT
|
||||||
|
2 - BSD
|
||||||
|
3 - GPLv3
|
||||||
|
4 - Apache Software License 2.0
|
||||||
|
5 - Not open source
|
||||||
|
Choose from 1, 2, 3, 4, 5 [1]: 1
|
||||||
|
keep_local_envs_in_vcs [y]: y
|
||||||
|
debug[n]: n
|
||||||
|
|
||||||
|
Enter the project and take a look around:
|
||||||
|
|
||||||
|
$ cd reddit/
|
||||||
|
$ ls
|
||||||
|
|
||||||
|
Create a git repo and push it there:
|
||||||
|
|
||||||
|
$ git init
|
||||||
|
$ git add .
|
||||||
|
$ git commit -m "first awesome commit"
|
||||||
|
$ 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?
|
||||||
|
|
||||||
|
For local development, see the following:
|
||||||
|
|
||||||
|
- [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)
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
- Have questions? **Before you ask questions anywhere else**, please post your question on [Stack Overflow](http://stackoverflow.com/questions/tagged/cookiecutter-django) under the *cookiecutter-django* tag. We check there periodically for questions.
|
||||||
|
- If you think you found a bug or want to request a feature, please open an [issue](https://github.com/cookiecutter/cookiecutter-django/issues).
|
||||||
|
- For anything else, you can chat with us on [Discord](https://discord.gg/9BrxzPKuEW).
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
## For PyUp Users
|
||||||
|
|
||||||
|
If you are using [PyUp](https://pyup.io) to keep your dependencies updated and secure, use the code *cookiecutter* during checkout to get 15% off every month.
|
||||||
|
|
||||||
|
## "Your Stuff"
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Releases
|
||||||
|
|
||||||
|
Need a stable release? You can find them at <https://github.com/cookiecutter/cookiecutter-django/releases>
|
||||||
|
|
||||||
|
## Not Exactly What You Want?
|
||||||
|
|
||||||
|
This is what I want. *It might not be what you want.* Don't worry, you have options:
|
||||||
|
|
||||||
|
### 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 to rename your fork.
|
||||||
|
|
||||||
|
If you do rename your fork, I encourage you to submit it to the following places:
|
||||||
|
|
||||||
|
- [cookiecutter](https://github.com/cookiecutter/cookiecutter) so it gets listed in the README as a template.
|
||||||
|
- The cookiecutter [grid](https://www.djangopackages.com/grids/g/cookiecutters/) on Django Packages.
|
||||||
|
|
||||||
|
### Submit a Pull Request
|
||||||
|
|
||||||
|
We accept pull requests if they're small, atomic, and make our own project development
|
||||||
|
experience better.
|
||||||
|
|
||||||
|
## Articles
|
||||||
|
|
||||||
|
- [Using cookiecutter-django with Google Cloud Storage](https://ahhda.github.io/cloud/gce/django/2019/03/12/using-django-cookiecutter-cloud-storage.html) - Mar. 12, 2019
|
||||||
|
- [cookiecutter-django with Nginx, Route 53 and ELB](https://msaizar.com/blog/cookiecutter-django-nginx-route-53-and-elb/) - Feb. 12, 2018
|
||||||
|
- [cookiecutter-django and Amazon RDS](https://msaizar.com/blog/cookiecutter-django-and-amazon-rds/) - Feb. 7, 2018
|
||||||
|
- [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/) - May 19, 2017
|
||||||
|
- [Exploring with Cookiecutter](http://www.snowboardingcoder.com/django/2016/12/03/exploring-with-cookiecutter/) - Dec. 3, 2016
|
||||||
|
- [Introduction to Cookiecutter-Django](http://krzysztofzuraw.com/blog/2016/django-cookiecutter.html) - Feb. 19, 2016
|
||||||
|
- [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) - May. 11, 2016
|
||||||
|
- [Development and Deployment of Cookiecutter-Django on Fedora](https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-on-fedora/) - Jan. 18, 2016
|
||||||
|
- [Development and Deployment of Cookiecutter-Django via Docker](https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-via-docker/) - Dec. 29, 2015
|
||||||
|
- [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/) - Sept. 12, 2015
|
||||||
|
|
||||||
|
Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.
|
||||||
|
|
||||||
|
## 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](https://www.pypa.io/en/latest/code-of-conduct/).
|
||||||
321
README.rst
321
README.rst
|
|
@ -1,321 +0,0 @@
|
||||||
Cookiecutter Django
|
|
||||||
===================
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/github/workflow/status/cookiecutter/cookiecutter-django/CI/master
|
|
||||||
:target: https://github.com/cookiecutter/cookiecutter-django/actions?query=workflow%3ACI
|
|
||||||
:alt: Build Status
|
|
||||||
|
|
||||||
.. image:: https://readthedocs.org/projects/cookiecutter-django/badge/?version=latest
|
|
||||||
:target: https://cookiecutter-django.readthedocs.io/en/latest/?badge=latest
|
|
||||||
:alt: Documentation Status
|
|
||||||
|
|
||||||
.. image:: https://pyup.io/repos/github/cookiecutter/cookiecutter-django/shield.svg
|
|
||||||
:target: https://pyup.io/repos/github/cookiecutter/cookiecutter-django/
|
|
||||||
:alt: Updates
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/Discord-cookiecutter-5865F2?style=flat&logo=discord&logoColor=white
|
|
||||||
:target: https://discord.gg/9BrxzPKuEW
|
|
||||||
:alt: Join our Discord
|
|
||||||
|
|
||||||
.. image:: https://www.codetriage.com/cookiecutter/cookiecutter-django/badges/users.svg
|
|
||||||
:target: https://www.codetriage.com/cookiecutter/cookiecutter-django
|
|
||||||
:alt: Code Helpers Badge
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
||||||
:target: https://github.com/ambv/black
|
|
||||||
:alt: Code style: black
|
|
||||||
|
|
||||||
Powered by Cookiecutter_, Cookiecutter Django is a framework for jumpstarting
|
|
||||||
production-ready Django projects quickly.
|
|
||||||
|
|
||||||
* Documentation: https://cookiecutter-django.readthedocs.io/en/latest/
|
|
||||||
* See Troubleshooting_ for common errors and obstacles
|
|
||||||
* If you have problems with Cookiecutter Django, please open issues_ don't send
|
|
||||||
emails to the maintainers.
|
|
||||||
|
|
||||||
.. _Troubleshooting: https://cookiecutter-django.readthedocs.io/en/latest/troubleshooting.html
|
|
||||||
|
|
||||||
.. _528: https://github.com/cookiecutter/cookiecutter-django/issues/528#issuecomment-212650373
|
|
||||||
.. _issues: https://github.com/cookiecutter/cookiecutter-django/issues/new
|
|
||||||
|
|
||||||
Features
|
|
||||||
---------
|
|
||||||
|
|
||||||
* For Django 3.2
|
|
||||||
* Works with Python 3.9
|
|
||||||
* Renders Django projects with 100% starting test coverage
|
|
||||||
* Twitter Bootstrap_ v5
|
|
||||||
* 12-Factor_ based settings via django-environ_
|
|
||||||
* Secure by default. We believe in SSL.
|
|
||||||
* Optimized development and production settings
|
|
||||||
* Registration via django-allauth_
|
|
||||||
* Comes with custom user model ready to go
|
|
||||||
* Optional basic ASGI setup for Websockets
|
|
||||||
* Optional custom static build using Gulp and livereload
|
|
||||||
* Send emails via Anymail_ (using Mailgun_ by default or Amazon SES if AWS is selected cloud provider, but switchable)
|
|
||||||
* Media storage using Amazon S3 or Google Cloud Storage
|
|
||||||
* Docker support using docker-compose_ for development and production (using Traefik_ with LetsEncrypt_ support)
|
|
||||||
* Procfile_ for deploying to Heroku
|
|
||||||
* Instructions for deploying to PythonAnywhere_
|
|
||||||
* Run tests with unittest or pytest
|
|
||||||
* Customizable PostgreSQL version
|
|
||||||
* Default integration with pre-commit_ for identifying simple issues before submission to code review
|
|
||||||
|
|
||||||
Optional Integrations
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
*These features can be enabled during initial project setup.*
|
|
||||||
|
|
||||||
* Serve static files from Amazon S3, Google Cloud Storage or Whitenoise_
|
|
||||||
* Configuration for Celery_ and Flower_ (the latter in Docker setup only)
|
|
||||||
* Integration with MailHog_ for local email testing
|
|
||||||
* Integration with Sentry_ for error logging
|
|
||||||
|
|
||||||
.. _Bootstrap: https://github.com/twbs/bootstrap
|
|
||||||
.. _django-environ: https://github.com/joke2k/django-environ
|
|
||||||
.. _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/
|
|
||||||
.. _Flower: https://github.com/mher/flower
|
|
||||||
.. _Anymail: https://github.com/anymail/django-anymail
|
|
||||||
.. _MailHog: https://github.com/mailhog/MailHog
|
|
||||||
.. _Sentry: https://sentry.io/welcome/
|
|
||||||
.. _docker-compose: https://github.com/docker/compose
|
|
||||||
.. _PythonAnywhere: https://www.pythonanywhere.com/
|
|
||||||
.. _Traefik: https://traefik.io/
|
|
||||||
.. _LetsEncrypt: https://letsencrypt.org/
|
|
||||||
.. _pre-commit: https://github.com/pre-commit/pre-commit
|
|
||||||
|
|
||||||
Constraints
|
|
||||||
-----------
|
|
||||||
|
|
||||||
* Only maintained 3rd party libraries are used.
|
|
||||||
* Uses PostgreSQL everywhere (10.19 - 14.1)
|
|
||||||
* Environment variables for configuration (This won't work with Apache/mod_wsgi).
|
|
||||||
|
|
||||||
Support this Project!
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:
|
|
||||||
|
|
||||||
* Daniel Roy Greenfeld, Project Lead (`GitHub <https://github.com/pydanny>`_, `Patreon <https://www.patreon.com/danielroygreenfeld>`_): expertise in Django and AWS ELB.
|
|
||||||
|
|
||||||
* Nikita Shupeyko, Core Developer (`GitHub <https://github.com/webyneter>`_): expertise in Python/Django, hands-on DevOps and frontend experience.
|
|
||||||
|
|
||||||
Projects that provide financial support to the maintainers:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. image:: https://cdn.shopify.com/s/files/1/0304/6901/products/Two-Scoops-of-Django-3-Alpha-Cover_540x_26507b15-e489-470b-8a97-02773dd498d1_1080x.jpg
|
|
||||||
:name: Two Scoops of Django 3.x
|
|
||||||
:align: center
|
|
||||||
:alt: Two Scoops of Django
|
|
||||||
:target: https://www.feldroy.com/products//two-scoops-of-django-3-x
|
|
||||||
|
|
||||||
Two Scoops of Django 3.x is the best ice cream-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
|
|
||||||
------
|
|
||||||
|
|
||||||
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::
|
|
||||||
|
|
||||||
$ pip install "cookiecutter>=1.7.0"
|
|
||||||
|
|
||||||
Now run it against this repo::
|
|
||||||
|
|
||||||
$ cookiecutter https://github.com/cookiecutter/cookiecutter-django
|
|
||||||
|
|
||||||
You'll be prompted for some values. Provide them, then a Django project will be created for you.
|
|
||||||
|
|
||||||
**Warning**: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.
|
|
||||||
|
|
||||||
Answer the prompts with your own desired options_. For example::
|
|
||||||
|
|
||||||
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.
|
|
||||||
project_name [Project Name]: Reddit Clone
|
|
||||||
project_slug [reddit_clone]: reddit
|
|
||||||
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
|
|
||||||
email [you@example.com]: pydanny@gmail.com
|
|
||||||
description [Behold My Awesome Project!]: A reddit clone.
|
|
||||||
domain_name [example.com]: myreddit.com
|
|
||||||
version [0.1.0]: 0.0.1
|
|
||||||
timezone [UTC]: America/Los_Angeles
|
|
||||||
use_whitenoise [n]: n
|
|
||||||
use_celery [n]: y
|
|
||||||
use_mailhog [n]: n
|
|
||||||
use_sentry [n]: y
|
|
||||||
use_pycharm [n]: y
|
|
||||||
windows [n]: n
|
|
||||||
use_docker [n]: n
|
|
||||||
use_heroku [n]: y
|
|
||||||
use_compressor [n]: y
|
|
||||||
Select postgresql_version:
|
|
||||||
1 - 14.1
|
|
||||||
2 - 13.5
|
|
||||||
3 - 12.9
|
|
||||||
4 - 11.14
|
|
||||||
5 - 10.19
|
|
||||||
Choose from 1, 2, 3, 4, 5 [1]: 1
|
|
||||||
Select js_task_runner:
|
|
||||||
1 - None
|
|
||||||
2 - Gulp
|
|
||||||
Choose from 1, 2 [1]: 1
|
|
||||||
Select cloud_provider:
|
|
||||||
1 - AWS
|
|
||||||
2 - GCP
|
|
||||||
3 - None
|
|
||||||
Choose from 1, 2, 3 [1]: 1
|
|
||||||
custom_bootstrap_compilation [n]: n
|
|
||||||
Select open_source_license:
|
|
||||||
1 - MIT
|
|
||||||
2 - BSD
|
|
||||||
3 - GPLv3
|
|
||||||
4 - Apache Software License 2.0
|
|
||||||
5 - Not open source
|
|
||||||
Choose from 1, 2, 3, 4, 5 [1]: 1
|
|
||||||
keep_local_envs_in_vcs [y]: y
|
|
||||||
debug[n]: n
|
|
||||||
|
|
||||||
Enter the project and take a look around::
|
|
||||||
|
|
||||||
$ cd reddit/
|
|
||||||
$ ls
|
|
||||||
|
|
||||||
Create a git repo and push it there::
|
|
||||||
|
|
||||||
$ git init
|
|
||||||
$ git add .
|
|
||||||
$ git commit -m "first awesome commit"
|
|
||||||
$ 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?
|
|
||||||
|
|
||||||
For local development, see the following:
|
|
||||||
|
|
||||||
* `Developing locally`_
|
|
||||||
* `Developing locally using docker`_
|
|
||||||
|
|
||||||
.. _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
|
|
||||||
|
|
||||||
Community
|
|
||||||
-----------
|
|
||||||
|
|
||||||
* 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.
|
|
||||||
* 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 `Discord`_.
|
|
||||||
|
|
||||||
.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/cookiecutter-django
|
|
||||||
.. _`issue`: https://github.com/cookiecutter/cookiecutter-django/issues
|
|
||||||
.. _`Discord`: https://discord.gg/9BrxzPKuEW
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
For PyUp Users
|
|
||||||
--------------
|
|
||||||
|
|
||||||
If you are using `PyUp <https://pyup.io>`_ to keep your dependencies updated and secure, use the code *cookiecutter* during checkout to get 15% off every month.
|
|
||||||
|
|
||||||
"Your Stuff"
|
|
||||||
-------------
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Releases
|
|
||||||
--------
|
|
||||||
|
|
||||||
Need a stable release? You can find them at https://github.com/cookiecutter/cookiecutter-django/releases
|
|
||||||
|
|
||||||
|
|
||||||
Not Exactly What You Want?
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
This is what I want. *It might not be what you want.* Don't worry, you have options:
|
|
||||||
|
|
||||||
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.
|
|
||||||
* The cookiecutter grid_ on Django Packages.
|
|
||||||
|
|
||||||
.. _cookiecutter: https://github.com/cookiecutter/cookiecutter
|
|
||||||
.. _grid: https://www.djangopackages.com/grids/g/cookiecutters/
|
|
||||||
|
|
||||||
Submit a Pull Request
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
We accept pull requests if they're small, atomic, and make our own project development
|
|
||||||
experience better.
|
|
||||||
|
|
||||||
Articles
|
|
||||||
---------
|
|
||||||
|
|
||||||
* `Using cookiecutter-django with Google Cloud Storage`_ - Mar. 12, 2019
|
|
||||||
* `cookiecutter-django with Nginx, Route 53 and ELB`_ - Feb. 12, 2018
|
|
||||||
* `cookiecutter-django and Amazon RDS`_ - Feb. 7, 2018
|
|
||||||
* `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
|
|
||||||
|
|
||||||
Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.
|
|
||||||
|
|
||||||
.. _`Using cookiecutter-django with Google Cloud Storage`: https://ahhda.github.io/cloud/gce/django/2019/03/12/using-django-cookiecutter-cloud-storage.html
|
|
||||||
.. _`cookiecutter-django with Nginx, Route 53 and ELB`: https://msaizar.com/blog/cookiecutter-django-nginx-route-53-and-elb/
|
|
||||||
.. _`cookiecutter-django and Amazon RDS`: https://msaizar.com/blog/cookiecutter-django-and-amazon-rds/
|
|
||||||
.. _`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/
|
|
||||||
.. _`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
|
|
||||||
|
|
||||||
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`_.
|
|
||||||
|
|
||||||
|
|
||||||
.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/
|
|
||||||
143
{{cookiecutter.project_slug}}/README.md
Normal file
143
{{cookiecutter.project_slug}}/README.md
Normal file
|
|
@ -0,0 +1,143 @@
|
||||||
|
# {{cookiecutter.project_name}}
|
||||||
|
|
||||||
|
{{ cookiecutter.description }}
|
||||||
|
|
||||||
|
[](https://github.com/cookiecutter/cookiecutter-django/)
|
||||||
|
[](https://github.com/ambv/black)
|
||||||
|
|
||||||
|
{%- if cookiecutter.open_source_license != "Not open source" %}
|
||||||
|
|
||||||
|
License: {{cookiecutter.open_source_license}}
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
## Settings
|
||||||
|
|
||||||
|
Moved to [settings](http://cookiecutter-django.readthedocs.io/en/latest/settings.html).
|
||||||
|
|
||||||
|
## Basic Commands
|
||||||
|
|
||||||
|
### Setting Up Your Users
|
||||||
|
|
||||||
|
- To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
|
||||||
|
|
||||||
|
- To create an **superuser account**, use this command:
|
||||||
|
|
||||||
|
$ python manage.py createsuperuser
|
||||||
|
|
||||||
|
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
|
||||||
|
|
||||||
|
### Type checks
|
||||||
|
|
||||||
|
Running type checks with mypy:
|
||||||
|
|
||||||
|
$ mypy {{cookiecutter.project_slug}}
|
||||||
|
|
||||||
|
### Test coverage
|
||||||
|
|
||||||
|
To run the tests, check your test coverage, and generate an HTML coverage report:
|
||||||
|
|
||||||
|
$ coverage run -m pytest
|
||||||
|
$ coverage html
|
||||||
|
$ open htmlcov/index.html
|
||||||
|
|
||||||
|
#### Running tests with pytest
|
||||||
|
|
||||||
|
$ pytest
|
||||||
|
|
||||||
|
### Live reloading and Sass CSS compilation
|
||||||
|
|
||||||
|
Moved to [Live reloading and SASS compilation](http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html).
|
||||||
|
|
||||||
|
{%- if cookiecutter.use_celery == "y" %}
|
||||||
|
|
||||||
|
### Celery
|
||||||
|
|
||||||
|
This app comes with Celery.
|
||||||
|
|
||||||
|
To run a celery worker:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
cd {{cookiecutter.project_slug}}
|
||||||
|
celery -A config.celery_app worker -l info
|
||||||
|
```
|
||||||
|
|
||||||
|
Please note: For Celery's import magic to work, it is important *where* the celery commands are run. If you are in the same folder with *manage.py*, you should be right.
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
{%- if cookiecutter.use_mailhog == "y" %}
|
||||||
|
|
||||||
|
### Email Server
|
||||||
|
|
||||||
|
{%- if cookiecutter.use_docker == "y" %}
|
||||||
|
|
||||||
|
In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server [MailHog](https://github.com/mailhog/MailHog) with a web interface is available as docker container.
|
||||||
|
|
||||||
|
Container mailhog will start automatically when you will run all docker containers.
|
||||||
|
Please check [cookiecutter-django Docker documentation](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html) for more details how to start all containers.
|
||||||
|
|
||||||
|
With MailHog running, to view messages that are sent by your application, open your browser and go to `http://127.0.0.1:8025`
|
||||||
|
{%- else %}
|
||||||
|
|
||||||
|
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](https://github.com/mailhog/MailHog) when generating the project a local SMTP server with a web interface will be available.
|
||||||
|
|
||||||
|
1. [Download the latest MailHog release](https://github.com/mailhog/MailHog/releases) for your OS.
|
||||||
|
|
||||||
|
2. Rename the build to `MailHog`.
|
||||||
|
|
||||||
|
3. Copy the file to the project root.
|
||||||
|
|
||||||
|
4. Make it executable:
|
||||||
|
|
||||||
|
$ chmod +x MailHog
|
||||||
|
|
||||||
|
5. Spin up another terminal window and start it there:
|
||||||
|
|
||||||
|
./MailHog
|
||||||
|
|
||||||
|
6. Check out <http://127.0.0.1:8025/> to see how it goes.
|
||||||
|
|
||||||
|
Now you have your own mail server running locally, ready to receive whatever you send it.
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
{%- if cookiecutter.use_sentry == "y" %}
|
||||||
|
|
||||||
|
### Sentry
|
||||||
|
|
||||||
|
Sentry is an error logging aggregator service. You can sign up for a free account at <https://sentry.io/signup/?code=cookiecutter> or download and host it yourself.
|
||||||
|
The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.
|
||||||
|
|
||||||
|
You must set the DSN url in production.
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
The following details how to deploy this application.
|
||||||
|
{%- if cookiecutter.use_heroku.lower() == "y" %}
|
||||||
|
|
||||||
|
### Heroku
|
||||||
|
|
||||||
|
See detailed [cookiecutter-django Heroku documentation](http://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html).
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
{%- if cookiecutter.use_docker.lower() == "y" %}
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
See detailed [cookiecutter-django Docker documentation](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html).
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
{%- if cookiecutter.custom_bootstrap_compilation == "y" %}
|
||||||
|
### Custom Bootstrap Compilation
|
||||||
|
|
||||||
|
The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
|
||||||
|
Bootstrap v4 is installed using npm and customised by tweaking your variables in `static/sass/custom_bootstrap_vars`.
|
||||||
|
|
||||||
|
You can find a list of available variables [in the bootstrap source](https://github.com/twbs/bootstrap/blob/v4-dev/scss/_variables.scss), or get explanations on them in the [Bootstrap docs](https://getbootstrap.com/docs/4.1/getting-started/theming/).
|
||||||
|
|
||||||
|
{%- if cookiecutter.js_task_runner == "Gulp" %}
|
||||||
|
Bootstrap's javascript as well as its dependencies is concatenated into a single file: `static/js/vendors.js`.
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- endif %}
|
||||||
|
|
@ -1,175 +0,0 @@
|
||||||
{{cookiecutter.project_name}}
|
|
||||||
{{ '=' * cookiecutter.project_name|length }}
|
|
||||||
|
|
||||||
{{cookiecutter.description}}
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter
|
|
||||||
:target: https://github.com/cookiecutter/cookiecutter-django/
|
|
||||||
:alt: Built with Cookiecutter Django
|
|
||||||
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
||||||
:target: https://github.com/ambv/black
|
|
||||||
:alt: Black code style
|
|
||||||
{%- if cookiecutter.open_source_license != "Not open source" %}
|
|
||||||
|
|
||||||
:License: {{cookiecutter.open_source_license}}
|
|
||||||
{%- endif %}
|
|
||||||
|
|
||||||
Settings
|
|
||||||
--------
|
|
||||||
|
|
||||||
Moved to settings_.
|
|
||||||
|
|
||||||
.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html
|
|
||||||
|
|
||||||
Basic Commands
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Setting Up Your Users
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
|
|
||||||
|
|
||||||
* To create an **superuser account**, use this command::
|
|
||||||
|
|
||||||
$ python manage.py createsuperuser
|
|
||||||
|
|
||||||
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
|
|
||||||
|
|
||||||
Type checks
|
|
||||||
^^^^^^^^^^^
|
|
||||||
|
|
||||||
Running type checks with mypy:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ mypy {{cookiecutter.project_slug}}
|
|
||||||
|
|
||||||
Test coverage
|
|
||||||
^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
To run the tests, check your test coverage, and generate an HTML coverage report::
|
|
||||||
|
|
||||||
$ coverage run -m pytest
|
|
||||||
$ coverage html
|
|
||||||
$ open htmlcov/index.html
|
|
||||||
|
|
||||||
Running tests with py.test
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ pytest
|
|
||||||
|
|
||||||
Live reloading and Sass CSS compilation
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
Moved to `Live reloading and SASS compilation`_.
|
|
||||||
|
|
||||||
.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html
|
|
||||||
|
|
||||||
{%- if cookiecutter.use_celery == "y" %}
|
|
||||||
|
|
||||||
Celery
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
This app comes with Celery.
|
|
||||||
|
|
||||||
To run a celery worker:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
cd {{cookiecutter.project_slug}}
|
|
||||||
celery -A config.celery_app worker -l info
|
|
||||||
|
|
||||||
Please note: For Celery's import magic to work, it is important *where* the celery commands are run. If you are in the same folder with *manage.py*, you should be right.
|
|
||||||
|
|
||||||
{%- endif %}
|
|
||||||
{%- if cookiecutter.use_mailhog == "y" %}
|
|
||||||
|
|
||||||
Email Server
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
{%- if cookiecutter.use_docker == 'y' %}
|
|
||||||
|
|
||||||
In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server `MailHog`_ with a web interface is available as docker container.
|
|
||||||
|
|
||||||
Container mailhog will start automatically when you will run all docker containers.
|
|
||||||
Please check `cookiecutter-django Docker documentation`_ for more details how to start all containers.
|
|
||||||
|
|
||||||
With MailHog running, to view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025``
|
|
||||||
{%- else %}
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
#. `Download the latest MailHog release`_ for your OS.
|
|
||||||
|
|
||||||
#. Rename the build to ``MailHog``.
|
|
||||||
|
|
||||||
#. Copy the file to the project root.
|
|
||||||
|
|
||||||
#. Make it executable: ::
|
|
||||||
|
|
||||||
$ chmod +x MailHog
|
|
||||||
|
|
||||||
#. Spin up another terminal window and start it there: ::
|
|
||||||
|
|
||||||
./MailHog
|
|
||||||
|
|
||||||
#. Check out `<http://127.0.0.1:8025/>`_ to see how it goes.
|
|
||||||
|
|
||||||
Now you have your own mail server running locally, ready to receive whatever you send it.
|
|
||||||
|
|
||||||
.. _`Download the latest MailHog release`: https://github.com/mailhog/MailHog/releases
|
|
||||||
{%- endif %}
|
|
||||||
|
|
||||||
.. _mailhog: https://github.com/mailhog/MailHog
|
|
||||||
{%- endif %}
|
|
||||||
{%- if cookiecutter.use_sentry == "y" %}
|
|
||||||
|
|
||||||
Sentry
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself.
|
|
||||||
The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.
|
|
||||||
|
|
||||||
You must set the DSN url in production.
|
|
||||||
{%- endif %}
|
|
||||||
|
|
||||||
Deployment
|
|
||||||
----------
|
|
||||||
|
|
||||||
The following details how to deploy this application.
|
|
||||||
{%- if cookiecutter.use_heroku.lower() == "y" %}
|
|
||||||
|
|
||||||
Heroku
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
See detailed `cookiecutter-django Heroku documentation`_.
|
|
||||||
|
|
||||||
.. _`cookiecutter-django Heroku documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html
|
|
||||||
{%- endif %}
|
|
||||||
{%- if cookiecutter.use_docker.lower() == "y" %}
|
|
||||||
|
|
||||||
Docker
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
See detailed `cookiecutter-django Docker documentation`_.
|
|
||||||
|
|
||||||
.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html
|
|
||||||
{%- endif %}
|
|
||||||
{%- if cookiecutter.custom_bootstrap_compilation == "y" %}
|
|
||||||
Custom Bootstrap Compilation
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
|
|
||||||
Bootstrap v4 is installed using npm and customised by tweaking your variables in ``static/sass/custom_bootstrap_vars``.
|
|
||||||
|
|
||||||
You can find a list of available variables `in the bootstrap source`_, or get explanations on them in the `Bootstrap docs`_.
|
|
||||||
|
|
||||||
{%- if cookiecutter.js_task_runner == 'Gulp' %}
|
|
||||||
Bootstrap's javascript as well as its dependencies is concatenated into a single file: ``static/js/vendors.js``.
|
|
||||||
{%- endif %}
|
|
||||||
|
|
||||||
.. _in the bootstrap source: https://github.com/twbs/bootstrap/blob/v4-dev/scss/_variables.scss
|
|
||||||
.. _Bootstrap docs: https://getbootstrap.com/docs/4.1/getting-started/theming/
|
|
||||||
|
|
||||||
{%- endif %}
|
|
||||||
Loading…
Reference in New Issue
Block a user