+
+*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
+the Cookiecutter core team.*
+
+## Other Contributors
+
+Listed in alphabetical order.
+
+
+
+### Special Thanks
+
+The following haven't provided code directly, but have provided
+guidance and advice.
+
+- Jannis Leidel
+- Nate Aune
+- Barry Morrison
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 9f4c97f31..53a486671 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1,7 +1,7 @@
# These are supported funding model platforms
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: danielroygreenfeld
+github: [pydanny, browniebroke]
+patreon: feldroy
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
@@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
-custom: ['https://www.patreon.com/browniebroke']
+custom: ["https://www.patreon.com/browniebroke"]
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index b232b6e34..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1 +0,0 @@
-## [Make sure to follow one of the issue templates we've got](https://github.com/pydanny/cookiecutter-django/issues/new/choose), otherwise the issue might be closed immeditely
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
index 2a48c0c32..e984493d8 100644
--- a/.github/ISSUE_TEMPLATE/bug.md
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -1,21 +1,58 @@
---
name: Bug Report
about: Report a bug
+labels: bug
---
## What happened?
-
-
-
## What should've happened instead?
+## Additional details
+
+
+
+* Host system configuration:
+ * Version of cookiecutter CLI (get it with `cookiecutter --version`):
+ * OS name and version:
+
+ On Linux, run
+ ```bash
+ lsb_release -a 2> /dev/null || cat /etc/redhat-release 2> /dev/null || cat /etc/*-release 2> /dev/null || cat /etc/issue 2> /dev/null
+ ```
+
+ On MacOs, run
+ ```bash
+ sw_vers
+ ```
+
+ On Windows, via CMD, run
+ ```
+ systeminfo | findstr /B /C:"OS Name" /C:"OS Version"
+ ```
+ ```bash
+ # Insert here the OS name and version
-## Steps to reproduce
+ ```
-[//]: # (Any or all of the following:)
-[//]: # (* Host system configuration: OS, Docker & friends' versions etc.)
-[//]: # (* Replay file https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html)
-[//]: # (* Logs)
+ * Python version, run `python3 -V`:
+ * Docker version (if using Docker), run `docker --version`:
+ * docker-compose version (if using Docker), run `docker-compose --version`:
+ * ...
+* Options selected and/or [replay file](https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html):
+ On Linux and MacOS: `cat ${HOME}/.cookiecutter_replay/cookiecutter-django.json`
+ (Please, take care to remove sensitive information)
+ ```json
+ # Insert here the replay file content
+ ```
+
+Logs:
+
+
+
+*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
+the Cookiecutter core team.*
+
+## Other Contributors
+
+Listed in alphabetical order.
+
+
+
+### Special Thanks
+
+The following haven't provided code directly, but have provided
+guidance and advice.
+
+- Jannis Leidel
+- Nate Aune
+- Barry Morrison
\ No newline at end of file
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
deleted file mode 100644
index 5fb35fc29..000000000
--- a/CONTRIBUTORS.rst
+++ /dev/null
@@ -1,386 +0,0 @@
-Contributors
-============
-
-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
-Jannis Gebauer `@jayfk`_
-Burhan Khalid `@burhan`_ @burhan
-Nikita Shupeyko `@webyneter`_ @webyneter
-Bruno Alla `@browniebroke`_ @_BrunoAlla
-Wan Liuyang `@sfdye`_ @sfdye
-=========================== ================= ===========
-
-*Audrey is also the creator of Cookiecutter. Audrey and
-Daniel are on the Cookiecutter core team.*
-
-.. _@pydanny: https://github.com/pydanny
-.. _@luzfcb: https://github.com/luzfcb
-.. _@theskumar: https://github.com/theskumar
-.. _@audreyr: https://github.com/audreyr
-.. _@jayfk: https://github.com/jayfk
-.. _@webyneter: https://github.com/webyneter
-.. _@browniebroke: https://github.com/browniebroke
-.. _@sfdye: https://github.com/sfdye
-
-Other Contributors
-------------------
-
-Listed in alphabetical order.
-
-========================== ============================ ==============
- Name Github Twitter
-========================== ============================ ==============
- 18 `@dezoito`_
- 2O4 `@2O4`_
- a7p `@a7p`_
- Aaron Eikenberry `@aeikenberry`_
- Adam Bogdał `@bogdal`_
- Adam Dobrawy `@ad-m`_
- Adam Steele `@adammsteele`_
- Agam Dua
- Alberto Sanchez `@alb3rto`_
- Alex Tsai `@caffodian`_
- Alvaro [Andor] `@andor-pierdelacabeza`_
- Amjith Ramanujam `@amjith`_
- Andreas Meistad `@ameistad`_
- Andres Gonzalez `@andresgz`_
- Andrew Mikhnevich `@zcho`_
- Andy Rose
- Anna Callahan `@jazztpt`_
- Anna Sidwell `@takkaria`_
- Antonia Blair `@antoniablair`_ @antoniablairart
- Anuj Bansal `@ahhda`_
- Arcuri Davide `@dadokkio`_
- Areski Belaid `@areski`_
- Arkadiusz Michał Ryś `@arkadiuszmichalrys`_
- Ashley Camba
- Barclay Gauld `@yunti`_
- Bartek `@btknu`_
- Ben Lopatin
- Ben Warren `@bwarren2`_
- Benjamin Abel
- Bert de Miranda `@bertdemiranda`_
- Bo Lopker `@blopker`_
- Bo Peng `@BoPeng`_
- Bouke Haarsma
- Brent Payne `@brentpayne`_ @brentpayne
- Bruce Olivier `@bolivierjr`_
- Burhan Khalid `@burhan`_ @burhan
- Caio Ariede `@caioariede`_ @caioariede
- Carl Johnson `@carlmjohnson`_ @carlmjohnson
- Catherine Devlin `@catherinedevlin`_
- Cédric Gaspoz `@cgaspoz`_
- Charlie Smith `@chuckus`_
- Chris Curvey `@ccurvey`_
- Chris Franklin
- Chris Franklin `@hairychris`_
- Chris Pappalardo `@ChrisPappalardo`_
- Christopher Clarke `@chrisdev`_
- Cole Mackenzie `@cmackenzie1`_
- Cole Maclean `@cole`_ @cole
- Collederas `@Collederas`_
- Craig Margieson `@cmargieson`_
- Cristian Vargas `@cdvv7788`_
- Cullen Rhodes `@c-rhodes`_
- Curtis St Pierre `@curtisstpierre`_ @cstpierre1388
- Dan Shultz `@shultz`_
- Dani Hodovic `@danihodovic`_
- Daniel Hepper `@dhepper`_ @danielhepper
- Daniel Hillier `@danifus`_
- Daniele Tricoli `@eriol`_
- David Díaz `@ddiazpinto`_ @DavidDiazPinto
- Davit Tovmasyan `@davitovmasyan`_
- Davur Clementsen `@dsclementsen`_ @davur
- Delio Castillo `@jangeador`_ @jangeador
- Demetris Stavrou `@demestav`_
- Denis Bobrov `@delneg`_
- Denis Orehovsky `@apirobot`_
- Denis Savran `@blaxpy`_
- Diane Chen `@purplediane`_ @purplediane88
- Dónal Adams `@epileptic-fish`_
- Dong Huynh `@trungdong`_
- Emanuel Calso `@bloodpet`_ @bloodpet
- Eraldo Energy `@eraldo`_
- Eric Groom `@ericgroom`_
- Eyad Al Sibai `@eyadsibai`_
- Felipe Arruda `@arruda`_
- Florian Idelberger `@step21`_ @windrush
- Garry Cairns `@garry-cairns`_
- Garry Polley `@garrypolley`_
- Gilbishkosma `@Gilbishkosma`_
- Hamish Durkin `@durkode`_
- Hana Quadara `@hanaquadara`_
- Harry Moreno `@morenoh149`_ @morenoh149
- Harry Percival `@hjwp`_
- Hendrik Schneider `@hendrikschneider`_
- Henrique G. G. Pereira `@ikkebr`_
- Howie Zhao `@howiezhao`_
- Ian Lee `@IanLee1521`_
- Irfan Ahmad `@erfaan`_ @erfaan
- Isaac12x `@Isaac12x`_
- Ivan Khomutov `@ikhomutov`_
- Jan Van Bruggen `@jvanbrug`_
- Jelmer Draaijer `@foarsitter`_
- Jerome Caisip `@jeromecaisip`_
- Jens Nilsson `@phiberjenz`_
- Jerome Leclanche `@jleclanche`_ @Adys
- Jimmy Gitonga `@afrowave`_ @afrowave
- John Cass `@jcass77`_ @cass_john
- Julien Almarcha `@sladinji`_
- Julio Castillo `@juliocc`_
- Kaido Kert `@kaidokert`_
- kappataumu `@kappataumu`_ @kappataumu
- Kaveh `@ka7eh`_
- Keith Bailey `@keithjeb`_
- Keith Webber `@townie`_
- Kevin A. Stone
- Kevin Ndung'u `@kevgathuku`_
- Keyvan Mosharraf `@keyvanm`_
- Krzysztof Szumny `@noisy`_
- Krzysztof Żuraw `@krzysztofzuraw`_
- Leo won `@leollon`_
- Leo Zhou `@glasslion`_
- Leonardo Jimenez `@xpostudio4`_
- Lin Xianyi `@iynaix`_
- Luis Nell `@originell`_
- Lukas Klein
- Lyla Fischer
- Malik Sulaimanov `@flyudvik`_ @flyudvik
- Martin Blech
- Martin Saizar `@msaizar`_
- Mateusz Ostaszewski `@mostaszewski`_
- Mathijs Hoogland `@MathijsHoogland`_
- Matt Braymer-Hayes `@mattayes`_ @mattayes
- Matt Knapper `@mknapper1`_
- Matt Linares
- Matt Menzenski `@menzenski`_
- Matt Warren `@mfwarren`_
- Matthew Sisley `@mjsisley`_
- Meghan Heintz `@dot2dotseurat`_
- Mesut Yılmaz `@myilmaz`_
- Michael Gecht `@mimischi`_ @_mischi
- Michael Samoylov `@msamoylov`_
- Min ho Kim `@minho42`_
- mozillazg `@mozillazg`_
- Nico Stefani `@nicolas471`_ @moby_dick91
- Oleg Russkin `@rolep`_
- Pablo `@oubiga`_
- Parbhat Puri `@parbhat`_
- Peter Bittner `@bittner`_
- Peter Coles `@mrcoles`_
- Philipp Matthies `@canonnervio`_
- Pierre Chiquet `@pchiquet`_
- Raony Guimarães Corrêa `@raonyguimaraes`_
- Raphael Pierzina `@hackebrot`_
- Reggie Riser `@reggieriser`_
- René Muhl `@rm--`_
- Roman Afanaskin `@siauPatrick`_
- Roman Osipenko `@romanosipenko`_
- Russell Davies
- Sam Collins `@MightySCollins`_
- Sascha `@saschalalala`_ @saschalalala
- Shupeyko Nikita `@webyneter`_
- Sławek Ehlert `@slafs`_
- Srinivas Nyayapati `@shireenrao`_
- stepmr `@stepmr`_
- Steve Steiner `@ssteinerX`_
- Sule Marshall `@suledev`_
- Tano Abeleyra `@tanoabeleyra`_
- Taylor Baldwin
- Théo Segonds `@show0k`_
- Tim Claessens `@timclaessens`_
- Tim Freund `@timfreund`_
- Tom Atkins `@knitatoms`_
- Tom Offermann
- Travis McNeill `@Travistock`_ @tavistock_esq
- Tubo Shi `@Tubo`_
- Umair Ashraf `@umrashrf`_ @fabumair
- Vadim Iskuchekov `@Egregors`_ @egregors
- Vicente G. Reyes `@reyesvicente`_ @highcenburg
- Vitaly Babiy
- Vivian Guillen `@viviangb`_
- Vlad Doster `@vladdoster`_
- Will Farley `@goldhand`_ @g01dhand
- William Archinal `@archinal`_
- Xaver Y.R. Chen `@yrchen`_ @yrchen
- Yaroslav Halchenko
- Yuchen Xie `@mapx`_
-========================== ============================ ==============
-
-.. _@a7p: https://github.com/a7p
-.. _@2O4: https://github.com/2O4
-.. _@ad-m: https://github.com/ad-m
-.. _@adammsteele: https://github.com/adammsteele
-.. _@aeikenberry: https://github.com/aeikenberry
-.. _@afrowave: https://github.com/afrowave
-.. _@ahhda: https://github.com/ahhda
-.. _@alb3rto: https://github.com/alb3rto
-.. _@ameistad: https://github.com/ameistad
-.. _@amjith: https://github.com/amjith
-.. _@andor-pierdelacabeza: https://github.com/andor-pierdelacabeza
-.. _@andresgz: https://github.com/andresgz
-.. _@antoniablair: https://github.com/antoniablair
-.. _@apirobot: https://github.com/apirobot
-.. _@archinal: https://github.com/archinal
-.. _@areski: https://github.com/areski
-.. _@arkadiuszmichalrys: https://github.com/ArkadiuszMichalRys
-.. _@arruda: https://github.com/arruda
-.. _@bertdemiranda: https://github.com/bertdemiranda
-.. _@bittner: https://github.com/bittner
-.. _@blaxpy: https://github.com/blaxpy
-.. _@bloodpet: https://github.com/bloodpet
-.. _@blopker: https://github.com/blopker
-.. _@bogdal: https://github.com/bogdal
-.. _@bolivierjr: https://github.com/bolivierjr
-.. _@BoPeng: https://github.com/BoPeng
-.. _@brentpayne: https://github.com/brentpayne
-.. _@btknu: https://github.com/btknu
-.. _@burhan: https://github.com/burhan
-.. _@bwarren2: https://github.com/bwarren2
-.. _@c-rhodes: https://github.com/c-rhodes
-.. _@caffodian: https://github.com/caffodian
-.. _@canonnervio: https://github.com/canonnervio
-.. _@caioariede: https://github.com/caioariede
-.. _@carlmjohnson: https://github.com/carlmjohnson
-.. _@catherinedevlin: https://github.com/catherinedevlin
-.. _@ccurvey: https://github.com/ccurvey
-.. _@cdvv7788: https://github.com/cdvv7788
-.. _@cgaspoz: https://github.com/cgaspoz
-.. _@chrisdev: https://github.com/chrisdev
-.. _@ChrisPappalardo: https://github.com/ChrisPappalardo
-.. _@chuckus: https://github.com/chuckus
-.. _@cmackenzie1: https://github.com/cmackenzie1
-.. _@cmargieson: https://github.com/cmargieson
-.. _@cole: https://github.com/cole
-.. _@Collederas: https://github.com/Collederas
-.. _@curtisstpierre: https://github.com/curtisstpierre
-.. _@dadokkio: https://github.com/dadokkio
-.. _@danihodovic: https://github.com/danihodovic
-.. _@danifus: https://github.com/danifus
-.. _@davitovmasyan: https://github.com/davitovmasyan
-.. _@ddiazpinto: https://github.com/ddiazpinto
-.. _@delneg: https://github.com/delneg
-.. _@demestav: https://github.com/demestav
-.. _@dezoito: https://github.com/dezoito
-.. _@dhepper: https://github.com/dhepper
-.. _@dot2dotseurat: https://github.com/dot2dotseurat
-.. _@dsclementsen: https://github.com/dsclementsen
-.. _@durkode: https://github.com/durkode
-.. _@Egregors: https://github.com/Egregors
-.. _@epileptic-fish: https://gihub.com/epileptic-fish
-.. _@eraldo: https://github.com/eraldo
-.. _@erfaan: https://github.com/erfaan
-.. _@ericgroom: https://github.com/ericgroom
-.. _@eriol: https://github.com/eriol
-.. _@eyadsibai: https://github.com/eyadsibai
-.. _@flyudvik: https://github.com/flyudvik
-.. _@foarsitter: https://github.com/foarsitter
-.. _@garry-cairns: https://github.com/garry-cairns
-.. _@garrypolley: https://github.com/garrypolley
-.. _@Gilbishkosma: https://github.com/Gilbishkosma
-.. _@glasslion: https://github.com/glasslion
-.. _@goldhand: https://github.com/goldhand
-.. _@hackebrot: https://github.com/hackebrot
-.. _@hairychris: https://github.com/hairychris
-.. _@hanaquadara: https://github.com/hanaquadara
-.. _@hendrikschneider: https://github.com/hendrikschneider
-.. _@hjwp: https://github.com/hjwp
-.. _@howiezhao: https://github.com/howiezhao
-.. _@IanLee1521: https://github.com/IanLee1521
-.. _@ikhomutov: https://github.com/ikhomutov
-.. _@ikkebr: https://github.com/ikkebr
-.. _@Isaac12x: https://github.com/Isaac12x
-.. _@iynaix: https://github.com/iynaix
-.. _@jangeador: https://github.com/jangeador
-.. _@jazztpt: https://github.com/jazztpt
-.. _@jcass77: https://github.com/jcass77
-.. _@jeromecaisip: https://github.com/jeromecaisip
-.. _@jleclanche: https://github.com/jleclanche
-.. _@juliocc: https://github.com/juliocc
-.. _@jvanbrug: https://github.com/jvanbrug
-.. _@ka7eh: https://github.com/ka7eh
-.. _@kaidokert: https://github.com/kaidokert
-.. _@kappataumu: https://github.com/kappataumu
-.. _@keithjeb: https://github.com/keithjeb
-.. _@kevgathuku: https://github.com/kevgathuku
-.. _@keyvanm: https://github.com/keyvanm
-.. _@knitatoms: https://github.com/knitatoms
-.. _@krzysztofzuraw: https://github.com/krzysztofzuraw
-.. _@leollon: https://github.com/leollon
-.. _@MathijsHoogland: https://github.com/MathijsHoogland
-.. _@mapx: https://github.com/mapx
-.. _@mattayes: https://github.com/mattayes
-.. _@menzenski: https://github.com/menzenski
-.. _@mfwarren: https://github.com/mfwarren
-.. _@MightySCollins: https://github.com/MightySCollins
-.. _@mimischi: https://github.com/mimischi
-.. _@minho42: https://github.com/minho42
-.. _@mjsisley: https://github.com/mjsisley
-.. _@mknapper1: https://github.com/mknapper1
-.. _@morenoh149: https://github.com/morenoh149
-.. _@mostaszewski: https://github.com/mostaszewski
-.. _@mozillazg: https://github.com/mozillazg
-.. _@mrcoles: https://github.com/mrcoles
-.. _@msaizar: https://github.com/msaizar
-.. _@msamoylov: https://github.com/msamoylov
-.. _@myilmaz: https://github.com/myilmaz
-.. _@nicolas471: https://github.com/nicolas471
-.. _@noisy: https://github.com/noisy
-.. _@originell: https://github.com/originell
-.. _@oubiga: https://github.com/oubiga
-.. _@parbhat: https://github.com/parbhat
-.. _@pchiquet: https://github.com/pchiquet
-.. _@phiberjenz: https://github.com/phiberjenz
-.. _@purplediane: https://github.com/purplediane
-.. _@raonyguimaraes: https://github.com/raonyguimaraes
-.. _@reggieriser: https://github.com/reggieriser
-.. _@reyesvicente: https://github.com/reyesvicente
-.. _@rm--: https://github.com/rm--
-.. _@rolep: https://github.com/rolep
-.. _@romanosipenko: https://github.com/romanosipenko
-.. _@saschalalala: https://github.com/saschalalala
-.. _@shireenrao: https://github.com/shireenrao
-.. _@show0k: https://github.com/show0k
-.. _@shultz: https://github.com/shultz
-.. _@siauPatrick: https://github.com/siauPatrick
-.. _@sladinji: https://github.com/sladinji
-.. _@slafs: https://github.com/slafs
-.. _@ssteinerX: https://github.com/ssteinerx
-.. _@step21: https://github.com/step21
-.. _@stepmr: https://github.com/stepmr
-.. _@suledev: https://github.com/suledev
-.. _@takkaria: https://github.com/takkaria
-.. _@tanoabeleyra: https://github.com/tanoabeleyra
-.. _@timclaessens: https://github.com/timclaessens
-.. _@timfreund: https://github.com/timfreund
-.. _@townie: https://github.com/townie
-.. _@Travistock: https://github.com/Tavistock
-.. _@trungdong: https://github.com/trungdong
-.. _@Tubo: https://github.com/tubo
-.. _@umrashrf: https://github.com/umrashrf
-.. _@viviangb: https://github.com/viviangb
-.. _@vladdoster: https://github.com/vladdoster
-.. _@xpostudio4: https://github.com/xpostudio4
-.. _@yrchen: https://github.com/yrchen
-.. _@yunti: https://github.com/yunti
-.. _@zcho: https://github.com/zcho
-
-Special Thanks
-~~~~~~~~~~~~~~
-
-The following haven't provided code directly, but have provided guidance and advice.
-
-* Jannis Leidel
-* Nate Aune
-* Barry Morrison
diff --git a/LICENSE b/LICENSE
index 28466d40f..a67e4da21 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2013-2018, Daniel Roy Greenfeld
+Copyright (c) 2013-2020, Daniel Roy Greenfeld
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..0697862c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,248 @@
+# Cookiecutter Django
+
+[](https://github.com/cookiecutter/cookiecutter-django/actions/workflows/ci.yml?query=branch%3Amaster)
+[](https://cookiecutter-django.readthedocs.io/en/latest/?badge=latest)
+[](https://pyup.io/repos/github/cookiecutter/cookiecutter-django/)
+[](https://discord.gg/uFXweDQc5a)
+[](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:
+- 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 4.0
+- Works with Python 3.10
+- 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 or Webpack
+- 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, Google Cloud Storage or Azure 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, Azure Storage or [Whitenoise](https://whitenoise.readthedocs.io/)
+- Configuration for [Celery](https://docs.celeryq.dev) 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 ([MySQL fork](https://github.com/mabdullahadeel/cookiecutter-django-mysql) also available).
+- 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 is the best ice cream-themed Django reference in the universe!
+
+### PyUp
+
+
+
+
+
+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 [My Awesome Project]: Reddit Clone
+ project_slug [reddit_clone]: reddit
+ description [Behold My Awesome Project!]: A reddit clone.
+ author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
+ domain_name [example.com]: myreddit.com
+ email [daniel-greenfeld@example.com]: pydanny@gmail.com
+ version [0.1.0]: 0.0.1
+ 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
+ timezone [UTC]: America/Los_Angeles
+ windows [n]: n
+ use_pycharm [n]: y
+ use_docker [n]: n
+ Select postgresql_version:
+ 1 - 14
+ 2 - 13
+ 3 - 12
+ 4 - 11
+ 5 - 10
+ Choose from 1, 2, 3, 4, 5 [1]: 1
+ Select cloud_provider:
+ 1 - AWS
+ 2 - GCP
+ 3 - None
+ Choose from 1, 2, 3 [1]: 1
+ Select mail_service:
+ 1 - Mailgun
+ 2 - Amazon SES
+ 3 - Mailjet
+ 4 - Mandrill
+ 5 - Postmark
+ 6 - Sendgrid
+ 7 - SendinBlue
+ 8 - SparkPost
+ 9 - Other SMTP
+ Choose from 1, 2, 3, 4, 5, 6, 7, 8, 9 [1]: 1
+ use_async [n]: n
+ use_drf [n]: y
+ Select frontend_pipeline:
+ 1 - None
+ 2 - Django Compressor
+ 3 - Gulp
+ 4 - Webpack
+ Choose from 1, 2, 3, 4 [1]: 1
+ use_celery [n]: y
+ use_mailhog [n]: n
+ use_sentry [n]: y
+ use_whitenoise [n]: n
+ use_heroku [n]: y
+ Select ci_tool:
+ 1 - None
+ 2 - Travis
+ 3 - Gitlab
+ 4 - Github
+ Choose from 1, 2, 3, 4 [1]: 4
+ 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/uFXweDQc5a).
+
+## 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.
+
+## For MySQL users
+To get full MySQL support in addition to the default Postgresql, you can use this fork of the cookiecutter-django:
+https://github.com/mabdullahadeel/cookiecutter-django-mysql
+
+## Releases
+
+Need a stable release? You can find them at
+
+## 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
+
+- [Cookiecutter Django With Amazon RDS](https://haseeburrehman.com/posts/cookiecutter-django-with-amazon-rds/) - Apr, 2, 2021
+- [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.
diff --git a/README.rst b/README.rst
deleted file mode 100644
index b90177613..000000000
--- a/README.rst
+++ /dev/null
@@ -1,320 +0,0 @@
-Cookiecutter Django
-=======================
-
-.. image:: https://travis-ci.org/pydanny/cookiecutter-django.svg?branch=master
- :target: https://travis-ci.org/pydanny/cookiecutter-django?branch=master
- :alt: Build Status
-
-.. image:: https://pyup.io/repos/github/pydanny/cookiecutter-django/shield.svg
- :target: https://pyup.io/repos/github/pydanny/cookiecutter-django/
- :alt: Updates
-
-.. image:: https://img.shields.io/badge/cookiecutter-Join%20on%20Slack-green?style=flat&logo=slack
- :target: https://join.slack.com/t/cookie-cutter/shared_invite/enQtNzI0Mzg5NjE5Nzk5LTRlYWI2YTZhYmQ4YmU1Y2Q2NmE1ZjkwOGM0NDQyNTIwY2M4ZTgyNDVkNjMxMDdhZGI5ZGE5YmJjM2M3ODJlY2U
-
-.. image:: https://www.codetriage.com/pydanny/cookiecutter-django/badges/users.svg
- :target: https://www.codetriage.com/pydanny/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/pydanny/cookiecutter-django/issues/528#issuecomment-212650373
-.. _issues: https://github.com/pydanny/cookiecutter-django/issues/new
-
-Features
----------
-
-* For Django 2.2
-* Works with Python 3.7
-* Renders Django projects with 100% starting test coverage
-* Twitter Bootstrap_ v4 (`maintained Foundation fork`_ also available)
-* 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 custom static build using Gulp and livereload
-* Send emails via Anymail_ (using Mailgun_ by default, but switchable)
-* Media storage using Amazon S3, Google Cloud Storage or a local nginx instance
-* 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
-
-.. _`maintained Foundation fork`: https://github.com/Parbhat/cookiecutter-django-foundation
-
-
-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 (9.4 - 11.3)
-* 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 `_, `Patreon `_): expertise in Django and AWS ELB.
-
-* Nikita Shupeyko, Core Developer (`GitHub `_): expertise in Python/Django, hands-on DevOps and frontend experience.
-
-Projects that provide financial support to the maintainers:
-
-Two Scoops of Django 1.11
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. image:: https://cdn.shopify.com/s/files/1/0304/6901/products/2017-06-29-tsd11-sticker-02.png
- :name: Two Scoops of Django 1.11 Cover
- :align: center
- :alt: Two Scoops of Django
- :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
-
-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/pydanny/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 - 11.3
- 2 - 10.8
- 3 - 9.6
- 4 - 9.5
- 5 - 9.4
- 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 - nginx
- 4 - 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 `Slack`_.
-
-.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/cookiecutter-django
-.. _`issue`: https://github.com/pydanny/cookiecutter-django/issues
-.. _`Slack`: https://join.slack.com/t/cookie-cutter/shared_invite/enQtNzI0Mzg5NjE5Nzk5LTRlYWI2YTZhYmQ4YmU1Y2Q2NmE1ZjkwOGM0NDQyNTIwY2M4ZTgyNDVkNjMxMDdhZGI5ZGE5YmJjM2M3ODJlY2U
-
-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.io Users
------------------
-
-If you are using `pyup.io`_ to keep your dependencies updated and secure, use the code *cookiecutter* during checkout to get 15% off every month.
-
-.. _`pyup.io`: https://pyup.io
-
-"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/pydanny/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/audreyr/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/
diff --git a/cookiecutter.json b/cookiecutter.json
index 049add5fe..ff1cfa4ef 100644
--- a/cookiecutter.json
+++ b/cookiecutter.json
@@ -18,25 +18,38 @@
"use_pycharm": "n",
"use_docker": "n",
"postgresql_version": [
- "11.3",
- "10.8",
- "9.6",
- "9.5",
- "9.4"
- ],
- "js_task_runner": [
- "None",
- "Gulp"
+ "14",
+ "13",
+ "12",
+ "11",
+ "10"
],
"cloud_provider": [
"AWS",
"GCP",
+ "Azure",
"nginx",
"None"
],
+ "mail_service": [
+ "Mailgun",
+ "Amazon SES",
+ "Mailjet",
+ "Mandrill",
+ "Postmark",
+ "Sendgrid",
+ "SendinBlue",
+ "SparkPost",
+ "Other SMTP"
+ ],
+ "use_async": "n",
"use_drf": "n",
- "custom_bootstrap_compilation": "n",
- "use_compressor": "n",
+ "frontend_pipeline": [
+ "None",
+ "Django Compressor",
+ "Gulp",
+ "Webpack"
+ ],
"use_celery": "n",
"use_mailhog": "n",
"use_sentry": "n",
@@ -45,9 +58,9 @@
"ci_tool": [
"None",
"Travis",
- "Gitlab"
+ "Gitlab",
+ "Github"
],
"keep_local_envs_in_vcs": "y",
-
"debug": "n"
}
diff --git a/docs/conf.py b/docs/conf.py
index 469aa12d4..b53e6a7e7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,10 +7,7 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.
-
from datetime import datetime
-import os
-import sys
now = datetime.now()
@@ -42,7 +39,7 @@ master_doc = "index"
# General information about the project.
project = "Cookiecutter Django"
-copyright = "2013-{}, Daniel Roy Greenfeld".format(now.year)
+copyright = f"2013-{now.year}, Daniel Roy Greenfeld"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -92,7 +89,7 @@ pygments_style = "sphinx"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -242,7 +239,8 @@ texinfo_documents = [
"Cookiecutter Django documentation",
"Daniel Roy Greenfeld",
"Cookiecutter Django",
- "A Cookiecutter template for creating production-ready Django projects quickly.",
+ "A Cookiecutter template for creating production-ready "
+ "Django projects quickly.",
"Miscellaneous",
)
]
diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst
index 53e980379..71c6e11b2 100644
--- a/docs/deployment-on-heroku.rst
+++ b/docs/deployment-on-heroku.rst
@@ -3,23 +3,24 @@ Deployment on Heroku
.. index:: Heroku
-Commands to run
----------------
+Script
+------
Run these commands to deploy the project to Heroku:
.. code-block:: bash
- heroku create --buildpack https://github.com/heroku/heroku-buildpack-python
+ heroku create --buildpack heroku/python
- heroku addons:create heroku-postgresql:hobby-dev
+ heroku addons:create heroku-postgresql:mini
# On Windows use double quotes for the time zone, e.g.
# heroku pg:backups schedule --at "02:00 America/Los_Angeles" DATABASE_URL
heroku pg:backups schedule --at '02:00 America/Los_Angeles' DATABASE_URL
heroku pg:promote DATABASE_URL
- heroku addons:create heroku-redis:hobby-dev
+ heroku addons:create heroku-redis:mini
+ # Assuming you chose Mailgun as mail service (see below for others)
heroku addons:create mailgun:starter
heroku config:set PYTHONHASHSEED=random
@@ -53,11 +54,25 @@ Run these commands to deploy the project to Heroku:
heroku open
+Notes
+-----
+
+Email Service
++++++++++++++
+
+The script above assumes that you've chose Mailgun as email service. If you want to use another one, check the `documentation for django-anymail `_ to know which environment variables to set. Heroku provides other `add-ons for emails `_ (e.g. Sendgrid) which can be configured with a similar one line command.
.. warning::
.. include:: mailgun.rst
+Heroku & Docker
++++++++++++++++
+
+Although Heroku has some sort of `Docker support`_, it's not supported by cookiecutter-django.
+We invite you to follow Heroku documentation about it.
+
+.. _Docker support: https://devcenter.heroku.com/articles/build-docker-images-heroku-yml
Optional actions
----------------
@@ -94,10 +109,10 @@ Or add the DSN for your account, if you already have one:
.. _Sentry add-on: https://elements.heroku.com/addons/sentry
-Gulp & Bootstrap compilation
-++++++++++++++++++++++++++++
+Gulp or Webpack
++++++++++++++++
-If you've opted for a custom bootstrap build, you'll most likely need to setup
+If you've opted for Gulp or Webpack as frontend pipeline, you'll most likely need to setup
your app to use `multiple buildpacks`_: one for Python & one for Node.js:
.. code-block:: bash
@@ -106,16 +121,8 @@ your app to use `multiple buildpacks`_: one for Python & one for Node.js:
At time of writing, this should do the trick: during deployment,
the Heroku should run ``npm install`` and then ``npm build``,
-which runs Gulp in cookiecutter-django.
+which run the SASS compilation & JS bundling.
If things don't work, please refer to the Heroku docs.
.. _multiple buildpacks: https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app
-
-About Heroku & Docker
----------------------
-
-Although Heroku has some sort of `Docker support`_, it's not supported by cookiecutter-django.
-We invite you to follow Heroku documentation about it.
-
-.. _Docker support: https://devcenter.heroku.com/articles/build-docker-images-heroku-yml
diff --git a/docs/deployment-on-pythonanywhere.rst b/docs/deployment-on-pythonanywhere.rst
index 4738d5a55..7984d7b5e 100644
--- a/docs/deployment-on-pythonanywhere.rst
+++ b/docs/deployment-on-pythonanywhere.rst
@@ -15,7 +15,7 @@ Full instructions follow, but here's a high-level view.
2. Set your config variables in the *postactivate* script
-3. Run the *manage.py* ``migrate`` and ``collectstatic`` commands
+3. Run the *manage.py* ``migrate`` and ``collectstatic`` commands. If you've opted for django-compressor, also run ``compress``
4. Add an entry to the PythonAnywhere *Web tab*
@@ -25,7 +25,6 @@ Full instructions follow, but here's a high-level view.
Once you've been through this one-off config, future deployments are much simpler: just ``git pull`` and then hit the "Reload" button :)
-
Getting your code and dependencies installed on PythonAnywhere
--------------------------------------------------------------
@@ -35,11 +34,10 @@ Make sure your project is fully committed and pushed up to Bitbucket or Github o
git clone # you can also use hg
cd my-project-name
- mkvirtualenv --python=/usr/bin/python3.7 my-project-name
+ mkvirtualenv --python=/usr/bin/python3.10 my-project-name
pip install -r requirements/production.txt # may take a few minutes
-
Setting environment variables in the console
--------------------------------------------
@@ -57,7 +55,7 @@ Set environment variables via the virtualenv "postactivate" script (this will se
vi $VIRTUAL_ENV/bin/postactivate
-**TIP:** *If you don't like vi, you can also edit this file via the PythonAnywhere "Files" menu; look in the ".virtualenvs" folder*.
+.. note:: If you don't like vi, you can also edit this file via the PythonAnywhere "Files" menu; look in the ".virtualenvs" folder.
Add these exports
@@ -73,13 +71,14 @@ Add these exports
export DJANGO_AWS_ACCESS_KEY_ID=
export DJANGO_AWS_SECRET_ACCESS_KEY=
export DJANGO_AWS_STORAGE_BUCKET_NAME=
- export DATABASE_URL=''
+ export DATABASE_URL=''
+ export REDIS_URL=''
-**NOTE:** *The AWS details are not required if you're using whitenoise or the built-in pythonanywhere static files service, but you do need to set them to blank, as above.*
+.. note:: The AWS details are not required if you're using whitenoise or the built-in pythonanywhere static files service, but you do need to set them to blank, as above.
-Database setup:
----------------
+Database setup
+--------------
Go to the PythonAnywhere **Databases tab** and configure your database.
@@ -109,17 +108,26 @@ Now run the migration, and collectstatic:
source $VIRTUAL_ENV/bin/postactivate
python manage.py migrate
python manage.py collectstatic
+ # if using django-compressor:
+ python manage.py compress
# and, optionally
python manage.py createsuperuser
+Redis
+-----
+
+PythonAnywhere does NOT `offer a built-in solution `_ for Redis, however the production setup from Cookiecutter Django uses Redis as cache and requires one.
+
+We recommend to signup to a separate service offering hosted Redis (e.g. `Redislab `_) and use the URL they provide.
+
Configure the PythonAnywhere Web Tab
------------------------------------
Go to the PythonAnywhere **Web tab**, hit **Add new web app**, and choose **Manual Config**, and then the version of Python you used for your virtualenv.
-**NOTE:** *If you're using a custom domain (not on \*.pythonanywhere.com), then you'll need to set up a CNAME with your domain registrar.*
+.. note:: If you're using a custom domain (not on \*.pythonanywhere.com), then you'll need to set up a CNAME with your domain registrar.
When you're redirected back to the web app config screen, set the **path to your virtualenv**. If you used virtualenvwrapper as above, you can just enter its name.
@@ -152,15 +160,14 @@ Click through to the **WSGI configuration file** link (near the top) and edit th
Back on the Web tab, hit **Reload**, and your app should be live!
-**NOTE:** *you may see security warnings until you set up your SSL certificates. If you
-want to suppress them temporarily, set DJANGO_SECURE_SSL_REDIRECT to blank. Follow
-the instructions here to get SSL set up: https://help.pythonanywhere.com/pages/SSLOwnDomains/*
+.. note:: You may see security warnings until you set up your SSL certificates. If you want to suppress them temporarily, set ``DJANGO_SECURE_SSL_REDIRECT`` to blank. Follow `these instructions `_ to get SSL set up.
+
Optional: static files
----------------------
-If you want to use the PythonAnywhere static files service instead of using whitenoise or S3, you'll find its configuration section on the Web tab. Essentially you'll need an entry to match your ``STATIC_URL`` and ``STATIC_ROOT`` settings. There's more info here: https://help.pythonanywhere.com/pages/DjangoStaticFiles
+If you want to use the PythonAnywhere static files service instead of using whitenoise or S3, you'll find its configuration section on the Web tab. Essentially you'll need an entry to match your ``STATIC_URL`` and ``STATIC_ROOT`` settings. There's more info `in this article `_.
Future deployments
@@ -175,7 +182,9 @@ For subsequent deployments, the procedure is much simpler. In a Bash console:
git pull
python manage.py migrate
python manage.py collectstatic
+ # if using django-compressor:
+ python manage.py compress
And then go to the Web tab and hit **Reload**
-**TIP:** *if you're really keen, you can set up git-push based deployments: https://blog.pythonanywhere.com/87/*
+.. note:: If you're really keen, you can set up git-push based deployments: https://blog.pythonanywhere.com/87/
diff --git a/docs/deployment-with-docker.rst b/docs/deployment-with-docker.rst
index 0df50ff45..a431679bf 100644
--- a/docs/deployment-with-docker.rst
+++ b/docs/deployment-with-docker.rst
@@ -25,7 +25,9 @@ Provided you have opted for Celery (via setting ``use_celery`` to ``y``) there a
* ``celeryworker`` running a Celery worker process;
* ``celerybeat`` running a Celery beat process;
-* ``flower`` running Flower_ (for more info, check out :ref:`CeleryFlower` instructions for local environment).
+* ``flower`` running Flower_.
+
+The ``flower`` service is served by Traefik over HTTPS, through the port ``5555``. For more information about Flower and its login credentials, check out :ref:`CeleryFlower` instructions for local environment.
.. _`Flower`: https://github.com/mher/flower
@@ -80,8 +82,34 @@ The Traefik reverse proxy used in the default configuration will get you a valid
You can read more about this feature and how to configure it, at `Automatic HTTPS`_ in the Traefik docs.
-.. _Automatic HTTPS: https://docs.traefik.io/configuration/acme/
+.. _Automatic HTTPS: https://docs.traefik.io/https/acme/
+.. _webpack-whitenoise-limitation:
+
+Webpack without Whitenoise limitation
+-------------------------------------
+
+If you opt for Webpack without Whitenoise, Webpack needs to know the static URL at build time, when running ``docker-compose build`` (See ``webpack/prod.config.js``). Depending on your setup, this URL may come from the following environment variables:
+
+- ``AWS_STORAGE_BUCKET_NAME``
+- ``DJANGO_AWS_S3_CUSTOM_DOMAIN``
+- ``DJANGO_GCP_STORAGE_BUCKET_NAME``
+- ``DJANGO_AZURE_CONTAINER_NAME``
+
+The Django settings are getting these values at runtime via the ``.envs/.production/.django`` file , but Docker does not read this file at build time, it only look for a ``.env`` in the root of the project. Failing to pass the values correctly will result in a page without CSS styles nor javascript.
+
+To solve this, you can either:
+
+1. merge all the env files into ``.env`` by running::
+
+ merge_production_dotenvs_in_dotenv.py
+
+2. create a ``.env`` file in the root of the project with just variables you need. You'll need to also define them in ``.envs/.production/.django`` (hence duplicating them).
+3. set these variables when running the build command::
+
+ DJANGO_AWS_S3_CUSTOM_DOMAIN=example.com docker-compose -f production.yml build``.
+
+None of these options are ideal, we're open to suggestions on how to improve this. If you think you have one, please open an issue or a pull request.
(Optional) Postgres Data Volume Modifications
---------------------------------------------
@@ -122,8 +150,8 @@ To check the logs out, run::
If you want to scale your application, run::
- docker-compose -f production.yml scale django=4
- docker-compose -f production.yml scale celeryworker=2
+ docker-compose -f production.yml up --scale django=4
+ docker-compose -f production.yml up --scale celeryworker=2
.. warning:: don't try to scale ``postgres``, ``celerybeat``, or ``traefik``.
diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst
index 09e684986..a7d77e108 100644
--- a/docs/developing-locally-docker.rst
+++ b/docs/developing-locally-docker.rst
@@ -3,9 +3,6 @@ Getting Up and Running Locally With Docker
.. index:: Docker
-The steps below will get you up and running with a local development environment.
-All of these commands assume you are in the root of your generated project.
-
.. note::
If you're new to Docker, please be aware that some resources are cached system-wide
@@ -18,10 +15,17 @@ Prerequisites
* Docker; if you don't have it yet, follow the `installation instructions`_;
* Docker Compose; refer to the official documentation for the `installation guide`_.
+* Pre-commit; refer to the official documentation for the `pre-commit`_.
+* Cookiecutter; refer to the official GitHub repository of `Cookiecutter`_
.. _`installation instructions`: https://docs.docker.com/install/#supported-platforms
.. _`installation guide`: https://docs.docker.com/compose/install/
+.. _`pre-commit`: https://pre-commit.com/#install
+.. _`Cookiecutter`: https://github.com/cookiecutter/cookiecutter
+Before Getting Started
+----------------------
+.. include:: generate-project-block.rst
Build the Stack
---------------
@@ -32,6 +36,13 @@ This can take a while, especially the first time you run this particular command
Generally, if you want to emulate production environment use ``production.yml`` instead. And this is true for any other actions you might need to perform: whenever a switch is required, just do it!
+Before doing any git commit, `pre-commit`_ should be installed globally on your local machine, and then::
+
+ $ git init
+ $ pre-commit install
+
+Failing to do so will result with a bunch of CI and Linter errors that can be avoided with pre-commit.
+
Run the Stack
-------------
@@ -116,7 +127,7 @@ Consider the aforementioned ``.envs/.local/.postgres``: ::
The three envs we are presented with here are ``POSTGRES_DB``, ``POSTGRES_USER``, and ``POSTGRES_PASSWORD`` (by the way, their values have also been generated for you). You might have figured out already where these definitions will end up; it's all the same with ``django`` service container envs.
-One final touch: should you ever need to merge ``.envs/production/*`` in a single ``.env`` run the ``merge_production_dotenvs_in_dotenv.py``: ::
+One final touch: should you ever need to merge ``.envs/.production/*`` in a single ``.env`` run the ``merge_production_dotenvs_in_dotenv.py``: ::
$ python merge_production_dotenvs_in_dotenv.py
@@ -154,12 +165,23 @@ django-debug-toolbar
In order for ``django-debug-toolbar`` to work designate your Docker Machine IP with ``INTERNAL_IPS`` in ``local.py``.
+docker
+""""""
+
+The ``container_name`` from the yml file can be used to check on containers with docker commands, for example: ::
+
+ $ docker logs _local_celeryworker
+ $ docker top _local_celeryworker
+
+
+Notice that the ``container_name`` is generated dynamically using your project slug as a prefix
+
Mailhog
~~~~~~~
When developing locally you can go with MailHog_ for email testing provided ``use_mailhog`` was set to ``y`` on setup. To proceed,
-#. make sure ``mailhog`` container is up and running;
+#. make sure ``_local_mailhog`` container is up and running;
#. open up ``http://127.0.0.1:8025``.
@@ -169,10 +191,9 @@ When developing locally you can go with MailHog_ for email testing provided ``us
Celery tasks in local development
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-When not using docker Celery tasks are set to run in Eager mode, so that a full stack is not needed. When using docker the task
-scheduler will be used by default.
+When not using docker Celery tasks are set to run in Eager mode, so that a full stack is not needed. When using docker the task scheduler will be used by default.
-If you need tasks to be executed on the main thread during development set CELERY_TASK_ALWAYS_EAGER = True in config/settings/local.py.
+If you need tasks to be executed on the main thread during development set ``CELERY_TASK_ALWAYS_EAGER = True`` in ``config/settings/local.py``.
Possible uses could be for testing, or ease of profiling with DJDT.
@@ -191,3 +212,96 @@ Prerequisites:
By default, it's enabled both in local and production environments (``local.yml`` and ``production.yml`` Docker Compose configs, respectively) through a ``flower`` service. For added security, ``flower`` requires its clients to provide authentication credentials specified as the corresponding environments' ``.envs/.local/.django`` and ``.envs/.production/.django`` ``CELERY_FLOWER_USER`` and ``CELERY_FLOWER_PASSWORD`` environment variables. Check out ``localhost:5555`` and see for yourself.
.. _`Flower`: https://github.com/mher/flower
+
+Developing locally with HTTPS
+-----------------------------
+
+Increasingly it is becoming necessary to develop software in a secure environment in order that there are very few changes when deploying to production. Recently Facebook changed their policies for apps/sites that use Facebook login which requires the use of an HTTPS URL for the OAuth redirect URL. So if you want to use the ``users`` application with a OAuth provider such as Facebook, securing your communication to the local development environment will be necessary.
+
+In order to create a secure environment, we need to have a trusted SSL certificate installed in our Docker application.
+
+#. **Let's Encrypt**
+
+ The official line from Let’s Encrypt is:
+
+ [For local development section] ... The best option: Generate your own certificate, either self-signed or signed by a local root, and trust it in your operating system’s trust store. Then use that certificate in your local web server. See below for details.
+
+ See `letsencrypt.org - certificates-for-localhost`_
+
+ .. _`letsencrypt.org - certificates-for-localhost`: https://letsencrypt.org/docs/certificates-for-localhost/
+
+#. **mkcert: Valid Https Certificates For Localhost**
+
+ `mkcert`_ is a simple by design tool that hides all the arcane knowledge required to generate valid TLS certificates. It works for any hostname or IP, including localhost. It supports macOS, Linux, and Windows, and Firefox, Chrome and Java. It even works on mobile devices with a couple manual steps.
+
+ See https://blog.filippo.io/mkcert-valid-https-certificates-for-localhost/
+
+ .. _`mkcert`: https://github.com/FiloSottile/mkcert/blob/master/README.md#supported-root-stores
+
+After installing a trusted TLS certificate, configure your docker installation. We are going to configure an ``nginx`` reverse-proxy server. This makes sure that it does not interfere with our ``traefik`` configuration that is reserved for production environments.
+
+These are the places that you should configure to secure your local environment.
+
+certs
+~~~~~
+
+Take the certificates that you generated and place them in a folder called ``certs`` in the project's root folder. Assuming that you registered your local hostname as ``my-dev-env.local``, the certificates you will put in the folder should have the names ``my-dev-env.local.crt`` and ``my-dev-env.local.key``.
+
+local.yml
+~~~~~~~~~
+
+#. Add the ``nginx-proxy`` service. ::
+
+ ...
+
+ nginx-proxy:
+ image: jwilder/nginx-proxy:alpine
+ container_name: nginx-proxy
+ ports:
+ - "80:80"
+ - "443:443"
+ volumes:
+ - /var/run/docker.sock:/tmp/docker.sock:ro
+ - ./certs:/etc/nginx/certs
+ restart: always
+ depends_on:
+ - django
+
+ ...
+
+#. Link the ``nginx-proxy`` to ``django`` through environment variables.
+
+ ``django`` already has an ``.env`` file connected to it. Add the following variables. You should do this especially if you are working with a team and you want to keep your local environment details to yourself.
+
+ ::
+
+ # HTTPS
+ # ------------------------------------------------------------------------------
+ VIRTUAL_HOST=my-dev-env.local
+ VIRTUAL_PORT=8000
+
+ The services run behind the reverse proxy.
+
+config/settings/local.py
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+You should allow the new hostname. ::
+
+ ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1", "my-dev-env.local"]
+
+Rebuild your ``docker`` application. ::
+
+ $ docker-compose -f local.yml up -d --build
+
+Go to your browser and type in your URL bar ``https://my-dev-env.local``
+
+See `https with nginx`_ for more information on this configuration.
+
+ .. _`https with nginx`: https://codewithhugo.com/docker-compose-local-https/
+
+.gitignore
+~~~~~~~~~~
+
+Add ``certs/*`` to the ``.gitignore`` file. This allows the folder to be included in the repo but its contents to be ignored.
+
+*This configuration is for local development environments only. Do not use this for production since you might expose your local* ``rootCA-key.pem``.
diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst
index 7a58d0999..fb66536fc 100644
--- a/docs/developing-locally.rst
+++ b/docs/developing-locally.rst
@@ -9,33 +9,41 @@ Setting Up Development Environment
Make sure to have the following on your host:
-* Python 3.7
+* Python 3.10
* PostgreSQL_.
* Redis_, if using Celery
+* Cookiecutter_
First things first.
#. Create a virtualenv: ::
- $ python3.7 -m venv
+ $ python3.10 -m venv
#. Activate the virtualenv you have just created: ::
$ source /bin/activate
+#.
+ .. include:: generate-project-block.rst
+
#. Install development requirements: ::
+ $ cd
$ pip install -r requirements/local.txt
+ $ git init # A git repo is required for pre-commit to install
$ pre-commit install
- .. note::
+ .. note::
- the `pre-commit` exists in the generated project as default.
- for the details of `pre-commit`, follow the [site of pre-commit](https://pre-commit.com/).
+ the `pre-commit` hook exists in the generated project as default.
+ For the details of `pre-commit`, follow the `pre-commit`_ site.
#. Create a new PostgreSQL database using createdb_: ::
- $ createdb -U postgres --password
+ $ createdb --username=postgres
+
+ ``project_slug`` is what you have entered as the project_slug at the setup stage.
.. note::
@@ -68,15 +76,21 @@ First things first.
$ python manage.py migrate
-#. See the application being served through Django development server: ::
+#. If you're running synchronously, see the application being served through Django development server: ::
$ python manage.py runserver 0.0.0.0:8000
+or if you're running asynchronously: ::
+
+ $ uvicorn config.asgi:application --host 0.0.0.0 --reload --reload-include '*.html'
+
.. _PostgreSQL: https://www.postgresql.org/download/
.. _Redis: https://redis.io/download
+.. _CookieCutter: https://github.com/cookiecutter/cookiecutter
.. _createdb: https://www.postgresql.org/docs/current/static/app-createdb.html
-.. _initial PostgreSQL set up: http://suite.opengeo.org/docs/latest/dataadmin/pgGettingStarted/firstconnect.html
+.. _initial PostgreSQL set up: https://web.archive.org/web/20190303010033/http://suite.opengeo.org/docs/latest/dataadmin/pgGettingStarted/firstconnect.html
.. _postgres documentation: https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html
+.. _pre-commit: https://pre-commit.com/
.. _direnv: https://direnv.net/
@@ -127,18 +141,55 @@ In production, we have Mailgun_ configured to have your back!
Celery
------
-If the project is configured to use Celery as a task scheduler then by default tasks are set to run on the main thread
-when developing locally. If you have the appropriate setup on your local machine then set the following
-in ``config/settings/local.py``::
+If the project is configured to use Celery as a task scheduler then, by default, tasks are set to run on the main thread when developing locally instead of getting sent to a broker. However, if you have Redis setup on your local machine, you can set the following in ``config/settings/local.py``::
CELERY_TASK_ALWAYS_EAGER = False
+Next, make sure `redis-server` is installed (per the `Getting started with Redis`_ guide) and run the server in one terminal::
+
+ $ redis-server
+
+Start the Celery worker by running the following command in another terminal::
+
+ $ celery -A config.celery_app worker --loglevel=info
+
+That Celery worker should be running whenever your app is running, typically as a background process,
+so that it can pick up any tasks that get queued. Learn more from the `Celery Workers Guide`_.
+
+The project comes with a simple task for manual testing purposes, inside `/users/tasks.py`. To queue that task locally, start the Django shell, import the task, and call `delay()` on it::
+
+ $ python manage.py shell
+ >> from .users.tasks import get_users_count
+ >> get_users_count.delay()
+
+You can also use Django admin to queue up tasks, thanks to the `django-celerybeat`_ package.
+
+.. _Getting started with Redis guide: https://redis.io/docs/getting-started/
+.. _Celery Workers Guide: https://docs.celeryq.dev/en/stable/userguide/workers.html
+.. _django-celerybeat: https://django-celery-beat.readthedocs.io/en/latest/
+
Sass Compilation & Live Reloading
---------------------------------
-If you’d like to take advantage of live reloading and Sass compilation you can do so with a little
-bit of preparation, see :ref:`sass-compilation-live-reload`.
+If you've opted for Gulp or Webpack as front-end pipeline, the project comes configured with `Sass`_ compilation and `live reloading`_. As you change you Sass/JS source files, the task runner will automatically rebuild the corresponding CSS and JS assets and reload them in your browser without refreshing the page.
+
+#. Make sure that `Node.js`_ v16 is installed on your machine.
+#. In the project root, install the JS dependencies with::
+
+ $ npm install
+
+#. Now - with your virtualenv activated - start the application by running::
+
+ $ npm run dev
+
+ The app will now run with live reloading enabled, applying front-end changes dynamically.
+
+.. note:: The task will start 2 processes in parallel: the static assets build loop on one side, and the Django server on the other. You do NOT need to run Django as your would normally with ``manage.py runserver``.
+
+.. _Node.js: http://nodejs.org/download/
+.. _Sass: https://sass-lang.com/
+.. _live reloading: https://browsersync.io
Summary
-------
diff --git a/docs/docker-postgres-backups.rst b/docs/docker-postgres-backups.rst
index 6ccb7cf1e..875d737eb 100644
--- a/docs/docker-postgres-backups.rst
+++ b/docs/docker-postgres-backups.rst
@@ -55,8 +55,11 @@ With a single backup file copied to ``.`` that would be ::
$ docker cp 9c5c3f055843:/backups/backup_2018_03_13T09_05_07.sql.gz .
-.. _`command`: https://docs.docker.com/engine/reference/commandline/cp/
+You can also get the container ID using ``docker-compose -f local.yml ps -q postgres`` so if you want to automate your backups, you don't have to check the container ID manually every time. Here is the full command ::
+ $ docker cp $(docker-compose -f local.yml ps -q postgres):/backups ./backups
+
+.. _`command`: https://docs.docker.com/engine/reference/commandline/cp/
Restoring from the Existing Backup
----------------------------------
diff --git a/docs/document.rst b/docs/document.rst
index 7207e357c..974c66c69 100644
--- a/docs/document.rst
+++ b/docs/document.rst
@@ -4,42 +4,41 @@ Document
=========
This project uses Sphinx_ documentation generator.
-After you have set up to `develop locally`_, run the following commands to generate the HTML documentation: ::
- $ sphinx-build docs/ docs/_build/html/
+After you have set up to `develop locally`_, run the following command from the project directory to build and serve HTML documentation: ::
+
+ $ make -C docs livehtml
If you set up your project to `develop locally with docker`_, run the following command: ::
- $ docker-compose -f local.yml run --rm django sphinx-build docs/ docs/_build/html/
+ $ docker-compose -f local.yml up docs
+
+Navigate to port 9000 on your host to see the documentation. This will be opened automatically at `localhost`_ for local, non-docker development.
+
+Note: using Docker for documentation sets up a temporary SQLite file by setting the environment variable ``DATABASE_URL=sqlite:///readthedocs.db`` in ``docs/conf.py`` to avoid a dependency on PostgreSQL.
Generate API documentation
----------------------------
-Sphinx can automatically generate documentation from docstrings, to enable this feature, follow these steps:
+Edit the ``docs`` files and project application docstrings to create your documentation.
-1. Add Sphinx extension in ``docs/conf.py`` file, like below: ::
+Sphinx can automatically include class and function signatures and docstrings in generated documentation.
+See the generated project documentation for more examples.
- extensions = [
- 'sphinx.ext.autodoc',
- ]
+Setting up ReadTheDocs
+----------------------
-2. Uncomment the following lines in the ``docs/conf.py`` file: ::
+To setup your documentation on `ReadTheDocs`_, you must
- # import django
- # sys.path.insert(0, os.path.abspath('..'))
- # os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
- # django.setup()
+1. Go to `ReadTheDocs`_ and login/create an account
+2. Add your GitHub repository
+3. Trigger a build
-3. Run the following command: ::
-
- $ sphinx-apidoc -f -o ./docs/modules/ ./tpub/ migrations/*
-
- If you set up your project to `develop locally with docker`_, run the following command: ::
-
- $ docker-compose -f local.yml run --rm django sphinx-apidoc -f -o ./docs/modules ./tpub/ migrations/*
-
-4. Regenerate HTML documentation as written above.
+Additionally, you can auto-build Pull Request previews, but `you must enable it`_.
+.. _localhost: http://localhost:9000/
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html
.. _develop locally: ./developing-locally.html
.. _develop locally with docker: ./developing-locally-docker.html
+.. _ReadTheDocs: https://readthedocs.org/
+.. _you must enable it: https://docs.readthedocs.io/en/latest/guides/autobuild-docs-for-pull-requests.html#autobuild-documentation-for-pull-requests
diff --git a/docs/faq.rst b/docs/faq.rst
index 1481a8bac..52a99467c 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -6,11 +6,11 @@ FAQ
Why is there a django.contrib.sites directory in Cookiecutter Django?
---------------------------------------------------------------------
-It is there to add a migration so you don't have to manually change the ``sites.Site`` record from ``example.com`` to whatever your domain is. Instead, your ``{{cookiecutter.domain_name}}`` and {{cookiecutter.project_name}} value is placed by **Cookiecutter** in the domain and name fields respectively.
+It is there to add a migration so you don't have to manually change the ``sites.Site`` record from ``example.com`` to whatever your domain is. Instead, your ``{{cookiecutter.domain_name}}`` and ``{{cookiecutter.project_name}}`` value is placed by **Cookiecutter** in the domain and name fields respectively.
See `0003_set_site_domain_and_name.py`_.
-.. _`0003_set_site_domain_and_name.py`: https://github.com/pydanny/cookiecutter-django/blob/master/%7B%7Bcookiecutter.project_slug%7D%7D/%7B%7Bcookiecutter.project_slug%7D%7D/contrib/sites/migrations/0003_set_site_domain_and_name.py
+.. _`0003_set_site_domain_and_name.py`: https://github.com/cookiecutter/cookiecutter-django/blob/master/%7B%7Bcookiecutter.project_slug%7D%7D/%7B%7Bcookiecutter.project_slug%7D%7D/contrib/sites/migrations/0003_set_site_domain_and_name.py
Why aren't you using just one configuration file (12-Factor App)
@@ -24,4 +24,4 @@ Why doesn't this follow the layout from Two Scoops of Django?
You may notice that some elements of this project do not exactly match what we describe in chapter 3 of `Two Scoops of Django 1.11`_. The reason for that is this project, amongst other things, serves as a test bed for trying out new ideas and concepts. Sometimes they work, sometimes they don't, but the end result is that it won't necessarily match precisely what is described in the book I co-authored.
-.. _Two Scoops of Django 1.11: https://www.twoscoopspress.com/collections/django/products/two-scoops-of-django-1-11
+.. _Two Scoops of Django 1.11: https://www.feldroy.com/collections/django/products/two-scoops-of-django-1-11
diff --git a/docs/generate-project-block.rst b/docs/generate-project-block.rst
new file mode 100644
index 000000000..2842b551d
--- /dev/null
+++ b/docs/generate-project-block.rst
@@ -0,0 +1,7 @@
+Generate a new cookiecutter-django project: ::
+
+ $ cookiecutter gh:cookiecutter/cookiecutter-django
+
+For more information refer to
+:ref:`Project Generation Options `.
+
diff --git a/docs/index.rst b/docs/index.rst
index 8e0d04aa3..dae641d10 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,14 @@
.. cookiecutter-django documentation master file.
Welcome to Cookiecutter Django's documentation!
-====================================================================
+===============================================
-A Cookiecutter_ template for Django.
+Powered by Cookiecutter_, Cookiecutter Django is a project template for jumpstarting production-ready Django projects. The template offers a number of generation options, we invite you to check the :ref:`dedicated page ` to learn more about each of them.
-.. _cookiecutter: https://github.com/audreyr/cookiecutter
+.. _cookiecutter: https://github.com/cookiecutter/cookiecutter
-Contents:
+Contents
+--------
.. toctree::
:maxdepth: 2
@@ -23,11 +24,12 @@ Contents:
deployment-on-heroku
deployment-with-docker
docker-postgres-backups
+ websocket
faq
troubleshooting
Indices and tables
-==================
+------------------
* :ref:`genindex`
* :ref:`search`
diff --git a/docs/linters.rst b/docs/linters.rst
index 2d6232181..a4f60cc8d 100644
--- a/docs/linters.rst
+++ b/docs/linters.rst
@@ -19,7 +19,7 @@ The config for flake8 is located in setup.cfg. It specifies:
pylint
------
-This is included in flake8's checks, but you can also run it separately to see a more detailed report: ::
+To run pylint: ::
$ pylint
diff --git a/docs/live-reloading-and-sass-compilation.rst b/docs/live-reloading-and-sass-compilation.rst
deleted file mode 100644
index a55b4fd8c..000000000
--- a/docs/live-reloading-and-sass-compilation.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-.. _sass-compilation-live-reload:
-
-Sass Compilation & Live Reloading
-=================================
-
-If you'd like to take advantage of `live reload`_ and Sass compilation:
-
-- Make sure that nodejs_ is installed. Then in the project root run::
-
- $ npm install
-
-.. _nodejs: http://nodejs.org/download/
-
-- Now you just need::
-
- $ npm run dev
-
-The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled.
-When changing your Sass files, they will be automatically recompiled and change will be reflected in your browser without refreshing.
-
-To get live reloading to work you'll probably need to install an `appropriate browser extension`_
-
-.. _live reload: http://livereload.com/
-.. _appropriate browser extension: http://livereload.com/extensions/
diff --git a/docs/mailgun.rst b/docs/mailgun.rst
index 1f34e3c86..b5f49b625 100644
--- a/docs/mailgun.rst
+++ b/docs/mailgun.rst
@@ -1,7 +1,7 @@
If your email server used to send email isn't configured properly (Mailgun by default),
attempting to send an email will cause an Internal Server Error.
-By default, django-allauth is setup to `have emails verifications mandatory`_,
+By default, ``django-allauth`` is setup to `have emails verifications mandatory`_,
which means it'll send a verification email when an unverified user tries to
log-in or when someone tries to sign-up.
diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst
index 2ed77facd..d4ad8a9aa 100644
--- a/docs/project-generation-options.rst
+++ b/docs/project-generation-options.rst
@@ -1,6 +1,12 @@
+.. _template-options:
+
Project Generation Options
==========================
+This page describes all the template options that will be prompted by the `cookiecutter CLI`_ prior to generating your project.
+
+.. _cookiecutter CLI: https://github.com/cookiecutter/cookiecutter
+
project_name:
Your project's human-readable name, capitals and spaces allowed.
@@ -49,37 +55,50 @@ use_docker:
postgresql_version:
Select a PostgreSQL_ version to use. The choices are:
- 1. 11.3
- 2. 10.8
- 3. 9.6
- 4. 9.5
- 5. 9.4
-
-js_task_runner:
- Select a JavaScript task runner. The choices are:
-
- 1. None
- 2. Gulp_
+ 1. 14
+ 2. 13
+ 3. 12
+ 4. 11
+ 5. 10
cloud_provider:
Select a cloud provider for static & media files. The choices are:
1. AWS_
2. GCP_
- 3. None
+ 3. Azure_
+ 4. None
Note that if you choose no cloud provider, media files won't work.
+mail_service:
+ Select an email service that Django-Anymail provides
+
+ 1. Mailgun_
+ 2. `Amazon SES`_
+ 3. Mailjet_
+ 4. Mandrill_
+ 5. Postmark_
+ 6. SendGrid_
+ 7. SendinBlue_
+ 8. SparkPost_
+ 9. `Other SMTP`_
+
+use_async:
+ Indicates whether the project should use web sockets with Uvicorn + Gunicorn.
+
use_drf:
Indicates whether the project should be configured to use `Django Rest Framework`_.
-custom_bootstrap_compilation:
- 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.
+frontend_pipeline:
+ Select a pipeline to compile and optimise frontend assets (JS, CSS, ...):
-use_compressor:
- Indicates whether the project should be configured to use `Django Compressor`_.
+ 1. None
+ 2. `Django Compressor`_
+ 3. `Gulp`_
+ 4. `Webpack`_
+
+Both Gulp and Webpack support Bootstrap recompilation with real-time variables alteration.
use_celery:
Indicates whether the project should be configured to use Celery_.
@@ -101,8 +120,9 @@ ci_tool:
Select a CI tool for running tests. The choices are:
1. None
- 2. Travis_
- 3. Gitlab_
+ 2. `Travis CI`_
+ 3. `Gitlab CI`_
+ 4. `Github Actions`_
keep_local_envs_in_vcs:
Indicates whether the project's ``.envs/.local/`` should be kept in VCS
@@ -128,9 +148,21 @@ debug:
.. _PostgreSQL: https://www.postgresql.org/docs/
.. _Gulp: https://github.com/gulpjs/gulp
+.. _Webpack: https://webpack.js.org
.. _AWS: https://aws.amazon.com/s3/
.. _GCP: https://cloud.google.com/storage/
+.. _Azure: https://azure.microsoft.com/en-us/products/storage/blobs/
+
+.. _Amazon SES: https://aws.amazon.com/ses/
+.. _Mailgun: https://www.mailgun.com
+.. _Mailjet: https://www.mailjet.com
+.. _Mandrill: http://mandrill.com
+.. _Postmark: https://postmarkapp.com
+.. _SendGrid: https://sendgrid.com
+.. _SendinBlue: https://www.sendinblue.com
+.. _SparkPost: https://www.sparkpost.com
+.. _Other SMTP: https://anymail.readthedocs.io/en/stable/
.. _Django Rest Framework: https://github.com/encode/django-rest-framework/
@@ -150,3 +182,4 @@ debug:
.. _GitLab CI: https://docs.gitlab.com/ee/ci/
+.. _Github Actions: https://docs.github.com/en/actions
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 000000000..2cc8302a2
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==5.3.0
+sphinx-rtd-theme==1.1.1
diff --git a/docs/settings.rst b/docs/settings.rst
index e586c9634..4691adbbd 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -45,13 +45,35 @@ DJANGO_AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID n/a
DJANGO_AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY n/a raises error
DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a raises error
DJANGO_AWS_S3_REGION_NAME AWS_S3_REGION_NAME n/a None
+DJANGO_AWS_S3_CUSTOM_DOMAIN AWS_S3_CUSTOM_DOMAIN n/a None
+DJANGO_AWS_S3_MAX_MEMORY_SIZE AWS_S3_MAX_MEMORY_SIZE n/a 100_000_000
DJANGO_GCP_STORAGE_BUCKET_NAME GS_BUCKET_NAME n/a raises error
GOOGLE_APPLICATION_CREDENTIALS n/a n/a raises error
+DJANGO_AZURE_ACCOUNT_KEY AZURE_ACCOUNT_KEY n/a raises error
+DJANGO_AZURE_ACCOUNT_NAME AZURE_ACCOUNT_NAME n/a raises error
+DJANGO_AZURE_CONTAINER_NAME AZURE_CONTAINER n/a raises error
SENTRY_DSN SENTRY_DSN n/a raises error
+SENTRY_ENVIRONMENT n/a n/a production
+SENTRY_TRACES_SAMPLE_RATE n/a n/a 0.0
DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO
MAILGUN_API_KEY MAILGUN_API_KEY n/a raises error
MAILGUN_DOMAIN MAILGUN_SENDER_DOMAIN n/a raises error
MAILGUN_API_URL n/a n/a "https://api.mailgun.net/v3"
+MAILJET_API_KEY MAILJET_API_KEY n/a raises error
+MAILJET_SECRET_KEY MAILJET_SECRET_KEY n/a raises error
+MAILJET_API_URL n/a n/a "https://api.mailjet.com/v3"
+MANDRILL_API_KEY MANDRILL_API_KEY n/a raises error
+MANDRILL_API_URL n/a n/a "https://mandrillapp.com/api/1.0"
+POSTMARK_SERVER_TOKEN POSTMARK_SERVER_TOKEN n/a raises error
+POSTMARK_API_URL n/a n/a "https://api.postmarkapp.com/"
+SENDGRID_API_KEY SENDGRID_API_KEY n/a raises error
+SENDGRID_GENERATE_MESSAGE_ID True n/a raises error
+SENDGRID_MERGE_FIELD_FORMAT None n/a raises error
+SENDGRID_API_URL n/a n/a "https://api.sendgrid.com/v3/"
+SENDINBLUE_API_KEY SENDINBLUE_API_KEY n/a raises error
+SENDINBLUE_API_URL n/a n/a "https://api.sendinblue.com/v3/"
+SPARKPOST_API_KEY SPARKPOST_API_KEY n/a raises error
+SPARKPOST_API_URL n/a n/a "https://api.sparkpost.com/api/v1"
======================================= =========================== ============================================== ======================================================================
--------------------------
diff --git a/docs/testing.rst b/docs/testing.rst
index dd6fcb48f..bea45c6dd 100644
--- a/docs/testing.rst
+++ b/docs/testing.rst
@@ -28,10 +28,15 @@ Coverage
You should build your tests to provide the highest level of **code coverage**. You can run the ``pytest`` with code ``coverage`` by typing in the following command: ::
- $ docker-compose -f local.yml run --rm django coverage run -m pytest
+ $ coverage run -m pytest
Once the tests are complete, in order to see the code coverage, run the following command: ::
+ $ coverage report
+
+If you're running the project locally with Docker, use these commands instead: ::
+
+ $ docker-compose -f local.yml run --rm django coverage run -m pytest
$ docker-compose -f local.yml run --rm django coverage report
.. note::
@@ -53,4 +58,4 @@ Once the tests are complete, in order to see the code coverage, run the followin
.. _develop locally with docker: ./developing-locally-docker.html
.. _customize: https://docs.pytest.org/en/latest/customize.html
.. _unittest: https://docs.python.org/3/library/unittest.html#module-unittest
-.. _configuring: https://coverage.readthedocs.io/en/v4.5.x/config.html
+.. _configuring: https://coverage.readthedocs.io/en/latest/config.html
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index 8aa1b1f9b..293e9b652 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -1,5 +1,5 @@
Troubleshooting
-=====================================
+===============
This page contains some advice about errors and problems commonly encountered during the development of Cookiecutter Django applications.
@@ -38,6 +38,16 @@ To fix this, you can either:
.. _rm: https://docs.docker.com/engine/reference/commandline/volume_rm/
.. _prune: https://docs.docker.com/v17.09/engine/reference/commandline/system_prune/
+Variable is not set. Defaulting to a blank string
+-------------------------------------------------
+
+Example::
+
+ WARN[0000] The "DJANGO_AWS_STORAGE_BUCKET_NAME" variable is not set. Defaulting to a blank string.
+ WARN[0000] The "DJANGO_AWS_S3_CUSTOM_DOMAIN" variable is not set. Defaulting to a blank string.
+
+You have probably opted for Docker + Webpack without Whitenoise. This is a know limitation of the combination, which needs a little bit of manual intervention. See the :ref:`dedicated section about it `.
+
Others
------
@@ -47,5 +57,5 @@ Others
#. New apps not getting created in project root: This is the expected behavior, because cookiecutter-django does not change the way that django startapp works, you'll have to fix this manually (see `#1725`_)
-.. _#528: https://github.com/pydanny/cookiecutter-django/issues/528#issuecomment-212650373
-.. _#1725: https://github.com/pydanny/cookiecutter-django/issues/1725#issuecomment-407493176
+.. _#528: https://github.com/cookiecutter/cookiecutter-django/issues/528#issuecomment-212650373
+.. _#1725: https://github.com/cookiecutter/cookiecutter-django/issues/1725#issuecomment-407493176
diff --git a/docs/websocket.rst b/docs/websocket.rst
new file mode 100644
index 000000000..9d2e3264a
--- /dev/null
+++ b/docs/websocket.rst
@@ -0,0 +1,25 @@
+.. _websocket:
+
+=========
+Websocket
+=========
+
+You can enable web sockets if you select ``use_async`` option when creating a project. That indicates whether the project can use web sockets with Uvicorn + Gunicorn.
+
+Usage
+-----
+
+JavaScript example: ::
+
+ > ws = new WebSocket('ws://localhost:8000/') // or 'wss:///' in prod
+ WebSocket {url: "ws://localhost:8000/", readyState: 0, bufferedAmount: 0, onopen: null, onerror: null, …}
+ > ws.onmessage = event => console.log(event.data)
+ event => console.log(event.data)
+ > ws.send("ping")
+ undefined
+ pong!
+
+
+If you don't use Traefik, you might have to configure your reverse proxy accordingly (example with Nginx_).
+
+.. _Nginx: https://www.nginx.com/blog/websocket-nginx/
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
index 5cc8c32f7..b64bbbafd 100644
--- a/hooks/post_gen_project.py
+++ b/hooks/post_gen_project.py
@@ -5,10 +5,12 @@ NOTE:
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
+TODO: restrict Cookiecutter Django project initialization to
+ Python 3.x environments only
"""
from __future__ import print_function
+import json
import os
import random
import shutil
@@ -59,6 +61,10 @@ def remove_docker_files():
file_names = ["local.yml", "production.yml", ".dockerignore"]
for file_name in file_names:
os.remove(file_name)
+ if "{{ cookiecutter.use_pycharm }}".lower() == "y":
+ file_names = ["docker_compose_up_django.xml", "docker_compose_up_docs.xml"]
+ for file_name in file_names:
+ os.remove(os.path.join(".idea", "runConfigurations", file_name))
def remove_utility_files():
@@ -75,6 +81,15 @@ def remove_heroku_files():
# don't remove the file if we are using travisci but not using heroku
continue
os.remove(file_name)
+ remove_heroku_build_hooks()
+
+
+def remove_heroku_build_hooks():
+ shutil.rmtree("bin")
+
+
+def remove_sass_files():
+ shutil.rmtree(os.path.join("{{cookiecutter.project_slug}}", "static", "sass"))
def remove_gulp_files():
@@ -83,12 +98,105 @@ def remove_gulp_files():
os.remove(file_name)
+def remove_webpack_files():
+ shutil.rmtree("webpack")
+ remove_vendors_js()
+
+
+def remove_vendors_js():
+ vendors_js_path = os.path.join(
+ "{{ cookiecutter.project_slug }}",
+ "static",
+ "js",
+ "vendors.js",
+ )
+ if os.path.exists(vendors_js_path):
+ os.remove(vendors_js_path)
+
+
def remove_packagejson_file():
file_names = ["package.json"]
for file_name in file_names:
os.remove(file_name)
+def update_package_json(remove_dev_deps=None, remove_keys=None, scripts=None):
+ remove_dev_deps = remove_dev_deps or []
+ remove_keys = remove_keys or []
+ scripts = scripts or {}
+ with open("package.json", mode="r") as fd:
+ content = json.load(fd)
+ for package_name in remove_dev_deps:
+ content["devDependencies"].pop(package_name)
+ for key in remove_keys:
+ content.pop(key)
+ content["scripts"].update(scripts)
+ with open("package.json", mode="w") as fd:
+ json.dump(content, fd, ensure_ascii=False, indent=2)
+ fd.write("\n")
+
+
+def handle_js_runner(choice, use_docker, use_async):
+ if choice == "Gulp":
+ update_package_json(
+ remove_dev_deps=[
+ "@babel/core",
+ "@babel/preset-env",
+ "babel-loader",
+ "concurrently",
+ "css-loader",
+ "mini-css-extract-plugin",
+ "postcss-loader",
+ "postcss-preset-env",
+ "sass-loader",
+ "webpack",
+ "webpack-bundle-tracker",
+ "webpack-cli",
+ "webpack-dev-server",
+ "webpack-merge",
+ ],
+ remove_keys=["babel"],
+ scripts={
+ "dev": "gulp",
+ "build": "gulp generate-assets",
+ },
+ )
+ remove_webpack_files()
+ elif choice == "Webpack":
+ scripts = {
+ "dev": "webpack serve --config webpack/dev.config.js",
+ "build": "webpack --config webpack/prod.config.js",
+ }
+ remove_dev_deps = [
+ "browser-sync",
+ "cssnano",
+ "gulp",
+ "gulp-imagemin",
+ "gulp-plumber",
+ "gulp-postcss",
+ "gulp-rename",
+ "gulp-sass",
+ "gulp-uglify-es",
+ ]
+ if not use_docker:
+ dev_django_cmd = (
+ "uvicorn config.asgi:application --reload"
+ if use_async
+ else "python manage.py runserver_plus"
+ )
+ scripts.update(
+ {
+ "dev": "concurrently npm:dev:*",
+ "dev:webpack": "webpack serve --config webpack/dev.config.js",
+ "dev:django": dev_django_cmd,
+ }
+ )
+ else:
+ remove_dev_deps.append("concurrently")
+ update_package_json(remove_dev_deps=remove_dev_deps, scripts=scripts)
+ remove_gulp_files()
+
+
def remove_celery_files():
file_names = [
os.path.join("config", "celery_app.py"),
@@ -101,6 +209,15 @@ def remove_celery_files():
os.remove(file_name)
+def remove_async_files():
+ file_names = [
+ os.path.join("config", "asgi.py"),
+ os.path.join("config", "websocket.py"),
+ ]
+ for file_name in file_names:
+ os.remove(file_name)
+
+
def remove_dottravisyml_file():
os.remove(".travis.yml")
@@ -109,11 +226,8 @@ def remove_dotgitlabciyml_file():
os.remove(".gitlab-ci.yml")
-def append_to_project_gitignore(path):
- gitignore_file_path = ".gitignore"
- with open(gitignore_file_path, "a") as gitignore_file:
- gitignore_file.write(path)
- gitignore_file.write(os.linesep)
+def remove_dotgithub_folder():
+ shutil.rmtree(".github")
def generate_random_string(
@@ -146,8 +260,8 @@ def set_flag(file_path, flag, value=None, formatted=None, *args, **kwargs):
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, make sure to manually {} later.".format(flag)
+ "We couldn't find a secure pseudo-random number generator on your "
+ "system. Please, make sure to manually {} later.".format(flag)
)
random_string = flag
if formatted is not None:
@@ -230,10 +344,10 @@ def set_celery_flower_password(file_path, value=None):
return celery_flower_password
-def append_to_gitignore_file(s):
+def append_to_gitignore_file(ignored_line):
with open(".gitignore", "a") as gitignore_file:
- gitignore_file.write(s)
- gitignore_file.write(os.linesep)
+ gitignore_file.write(ignored_line)
+ gitignore_file.write("\n")
def set_flags_in_envs(postgres_user, celery_flower_user, debug=False):
@@ -272,6 +386,7 @@ def set_flags_in_settings_files():
def remove_envs_and_associated_files():
shutil.rmtree(".envs")
os.remove("merge_production_dotenvs_in_dotenv.py")
+ shutil.rmtree("tests")
def remove_celery_compose_dirs():
@@ -290,6 +405,25 @@ def remove_aws_dockerfile():
def remove_drf_starter_files():
os.remove(os.path.join("config", "api_router.py"))
shutil.rmtree(os.path.join("{{cookiecutter.project_slug}}", "users", "api"))
+ os.remove(
+ os.path.join(
+ "{{cookiecutter.project_slug}}", "users", "tests", "test_drf_urls.py"
+ )
+ )
+ os.remove(
+ os.path.join(
+ "{{cookiecutter.project_slug}}", "users", "tests", "test_drf_views.py"
+ )
+ )
+ os.remove(
+ os.path.join(
+ "{{cookiecutter.project_slug}}", "users", "tests", "test_swagger.py"
+ )
+ )
+
+
+def remove_storages_module():
+ os.remove(os.path.join("{{cookiecutter.project_slug}}", "utils", "storages.py"))
def main():
@@ -317,12 +451,14 @@ def main():
if (
"{{ cookiecutter.use_docker }}".lower() == "y"
- and "{{ cookiecutter.cloud_provider}}".lower() != "aws"
+ and "{{ cookiecutter.cloud_provider}}" != "AWS"
):
remove_aws_dockerfile()
if "{{ cookiecutter.use_heroku }}".lower() == "n":
remove_heroku_files()
+ elif "{{ cookiecutter.frontend_pipeline }}" != "Django Compressor":
+ remove_heroku_build_hooks()
if (
"{{ cookiecutter.use_docker }}".lower() == "n"
@@ -341,32 +477,47 @@ def main():
if "{{ cookiecutter.keep_local_envs_in_vcs }}".lower() == "y":
append_to_gitignore_file("!.envs/.local/")
- if "{{ cookiecutter.js_task_runner}}".lower() == "none":
+ if "{{ cookiecutter.frontend_pipeline }}" in ["None", "Django Compressor"]:
remove_gulp_files()
+ remove_webpack_files()
+ remove_sass_files()
remove_packagejson_file()
if "{{ cookiecutter.use_docker }}".lower() == "y":
remove_node_dockerfile()
+ else:
+ handle_js_runner(
+ "{{ cookiecutter.frontend_pipeline }}",
+ use_docker=("{{ cookiecutter.use_docker }}".lower() == "y"),
+ use_async=("{{ cookiecutter.use_async }}".lower() == "y"),
+ )
- if "{{ cookiecutter.cloud_provider}}".lower() == "none":
+ if "{{ cookiecutter.cloud_provider }}" == "None":
print(
WARNING + "You chose not to use a cloud provider, "
"media files won't be served in production." + TERMINATOR
)
+ remove_storages_module()
if "{{ cookiecutter.use_celery }}".lower() == "n":
remove_celery_files()
if "{{ cookiecutter.use_docker }}".lower() == "y":
remove_celery_compose_dirs()
- if "{{ cookiecutter.ci_tool }}".lower() != "travis":
+ if "{{ cookiecutter.ci_tool }}" != "Travis":
remove_dottravisyml_file()
- if "{{ cookiecutter.ci_tool }}".lower() != "gitlab":
+ if "{{ cookiecutter.ci_tool }}" != "Gitlab":
remove_dotgitlabciyml_file()
+ if "{{ cookiecutter.ci_tool }}" != "Github":
+ remove_dotgithub_folder()
+
if "{{ cookiecutter.use_drf }}".lower() == "n":
remove_drf_starter_files()
+ if "{{ cookiecutter.use_async }}".lower() == "n":
+ remove_async_files()
+
print(SUCCESS + "Project initialized, keep up the good work!" + TERMINATOR)
diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py
index 668a6e278..c3eef1e43 100644
--- a/hooks/pre_gen_project.py
+++ b/hooks/pre_gen_project.py
@@ -4,7 +4,8 @@ NOTE:
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
+TODO: restrict Cookiecutter Django project initialization
+ to Python 3.x environments only
"""
from __future__ import print_function
@@ -35,11 +36,11 @@ if "{{ cookiecutter.use_docker }}".lower() == "n":
if python_major_version == 2:
print(
WARNING + "You're running cookiecutter under Python 2, but the generated "
- "project requires Python 3.7+. Do you want to proceed (y/n)? " + TERMINATOR
+ "project requires Python 3.10+. Do you want to proceed (y/n)? " + TERMINATOR
)
yes_options, no_options = frozenset(["y"]), frozenset(["n"])
while True:
- choice = raw_input().lower()
+ choice = raw_input().lower() # noqa: F821
if choice in yes_options:
break
@@ -65,6 +66,17 @@ if (
and "{{ cookiecutter.cloud_provider }}" == "None"
):
print(
- "You should either use Whitenoise or select a Cloud Provider to serve static files"
+ "You should either use Whitenoise or select a "
+ "Cloud Provider to serve static files"
+ )
+ sys.exit(1)
+
+if (
+ "{{ cookiecutter.mail_service }}" == "Amazon SES"
+ and "{{ cookiecutter.cloud_provider }}" != "AWS"
+):
+ print(
+ "You should either use AWS or select a different "
+ "Mail Service for sending emails."
)
sys.exit(1)
diff --git a/pytest.ini b/pytest.ini
index 89aeb302c..52506f47d 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -1,7 +1,3 @@
[pytest]
-addopts = -x --tb=short
-python_paths = .
+addopts = -v --tb=short
norecursedirs = .tox .git */migrations/* */static/* docs venv */{{cookiecutter.project_slug}}/*
-markers =
- flake8: Run flake8 on all possible template combinations
- black: Run black on all possible template combinations
diff --git a/requirements.txt b/requirements.txt
index 06f5a80ed..2b7c69d33 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,17 +1,26 @@
-cookiecutter==1.7.0
-sh==1.12.14
+cookiecutter==2.1.1
+sh==1.14.3; sys_platform != "win32"
binaryornot==0.4.4
# Code quality
# ------------------------------------------------------------------------------
-black==19.10b0
-flake8==3.7.9
+black==22.12.0
+isort==5.12.0
+flake8==6.0.0
+flake8-isort==6.0.0
+pre-commit==3.0.1
# Testing
# ------------------------------------------------------------------------------
-tox==3.14.5
-pytest==5.3.5
-pytest_cases==1.12.2
-pytest-cookies==0.5.1
-pytest-xdist==1.31.0
-pyyaml==5.3
+tox==4.4.2
+pytest==7.2.1
+pytest-cookies==0.6.1
+pytest-instafail==0.4.2
+pyyaml==6.0
+
+# Scripting
+# ------------------------------------------------------------------------------
+PyGithub==1.57
+gitpython==3.1.30
+jinja2==3.1.2
+requests==2.28.2
diff --git a/scripts/__init__.py b/scripts/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/scripts/create_django_issue.py b/scripts/create_django_issue.py
new file mode 100644
index 000000000..5809f393d
--- /dev/null
+++ b/scripts/create_django_issue.py
@@ -0,0 +1,320 @@
+"""
+Creates an issue that generates a table for dependency checking whether
+all packages support the latest Django version. "Latest" does not include
+patches, only comparing major and minor version numbers.
+
+This script handles when there are multiple Django versions that need
+to keep up to date.
+"""
+from __future__ import annotations
+
+import os
+import re
+import sys
+from collections.abc import Iterable
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, NamedTuple
+
+import requests
+from github import Github
+
+if TYPE_CHECKING:
+ from github.Issue import Issue
+
+CURRENT_FILE = Path(__file__)
+ROOT = CURRENT_FILE.parents[1]
+REQUIREMENTS_DIR = ROOT / "{{cookiecutter.project_slug}}" / "requirements"
+GITHUB_TOKEN = os.getenv("GITHUB_TOKEN", None)
+GITHUB_REPO = os.getenv("GITHUB_REPOSITORY", None)
+
+
+class DjVersion(NamedTuple):
+ """
+ Wrapper to parse, compare and render Django versions.
+
+ Only keeps track on (major, minor) versions, excluding patches and pre-releases.
+ """
+
+ major: int
+ minor: int
+
+ def __str__(self) -> str:
+ """To render as string."""
+ return f"{self.major}.{self.minor}"
+
+ @classmethod
+ def parse(cls, version_str: str) -> DjVersion:
+ """Parse interesting values from the version string."""
+ major, minor, *_ = version_str.split(".")
+ return cls(major=int(major), minor=int(minor))
+
+ @classmethod
+ def parse_to_tuple(cls, version_str: str):
+ version = cls.parse(version_str=version_str)
+ return version.major, version.minor
+
+
+def get_package_info(package: str) -> dict:
+ """Get package metadata using PyPI API."""
+ # "django" converts to "Django" on redirect
+ r = requests.get(f"https://pypi.org/pypi/{package}/json", allow_redirects=True)
+ if not r.ok:
+ print(f"Couldn't find package: {package}")
+ sys.exit(1)
+ return r.json()
+
+
+def get_django_versions() -> Iterable[DjVersion]:
+ """List all django versions."""
+ django_package_info: dict[str, Any] = get_package_info("django")
+ releases = django_package_info["releases"].keys()
+ for release_str in releases:
+ if release_str.replace(".", "").isdigit():
+ # Exclude pre-releases with non-numeric characters in version
+ yield DjVersion.parse(release_str)
+
+
+def get_name_and_version(requirements_line: str) -> tuple[str, ...]:
+ """Get the name a version of a package from a line in the requirement file."""
+ full_name, version = requirements_line.split(" ", 1)[0].split("==")
+ name_without_extras = full_name.split("[", 1)[0]
+ return name_without_extras, version
+
+
+def get_all_latest_django_versions(
+ django_max_version: tuple[DjVersion] = None,
+) -> tuple[DjVersion, list[DjVersion]]:
+ """
+ Grabs all Django versions that are worthy of a GitHub issue.
+ Depends on Django versions having higher major version or minor version.
+ """
+ _django_max_version = (99, 99)
+ if django_max_version:
+ _django_max_version = django_max_version
+
+ print("Fetching all Django versions from PyPI")
+ base_txt = REQUIREMENTS_DIR / "base.txt"
+ with base_txt.open() as f:
+ for line in f.readlines():
+ if "django==" in line.lower():
+ break
+ else:
+ print(f"django not found in {base_txt}") # Huh...?
+ sys.exit(1)
+
+ # Begin parsing and verification
+ _, current_version_str = get_name_and_version(line)
+ # Get a tuple of (major, minor) - ignoring patch version
+ current_minor_version = DjVersion.parse(current_version_str)
+ newer_versions: set[DjVersion] = set()
+ for django_version in get_django_versions():
+ if current_minor_version < django_version <= _django_max_version:
+ newer_versions.add(django_version)
+
+ return current_minor_version, sorted(newer_versions, reverse=True)
+
+
+_TABLE_HEADER = """
+
+## {file}.txt
+
+| Name | Version in Master | {dj_version} Compatible Version | OK |
+| ---- | :---------------: | :-----------------------------: | :-: |
+"""
+VITAL_BUT_UNKNOWN = [
+ "django-environ", # not updated often
+]
+
+
+class GitHubManager:
+ def __init__(self, base_dj_version: DjVersion, needed_dj_versions: list[DjVersion]):
+ self.github = Github(GITHUB_TOKEN)
+ self.repo = self.github.get_repo(GITHUB_REPO)
+
+ self.base_dj_version = base_dj_version
+ self.needed_dj_versions = needed_dj_versions
+ # (major+minor) Version and description
+ self.existing_issues: dict[DjVersion, Issue] = {}
+
+ # Load all requirements from our requirements files and preload their
+ # package information like a cache:
+ self.requirements_files = ["base", "local", "production"]
+ # Format:
+ # requirement file name: {package name: (master_version, package_info)}
+ self.requirements: dict[str, dict[str, tuple[str, dict]]] = {
+ x: {} for x in self.requirements_files
+ }
+
+ def setup(self) -> None:
+ self.load_requirements()
+ self.load_existing_issues()
+
+ def load_requirements(self):
+ print("Reading requirements")
+ for requirements_file in self.requirements_files:
+ with (REQUIREMENTS_DIR / f"{requirements_file}.txt").open() as f:
+ for line in f.readlines():
+ if (
+ "==" in line
+ and not line.startswith("{%")
+ and not line.startswith(" #")
+ and not line.startswith("#")
+ and not line.startswith(" ")
+ ):
+ name, version = get_name_and_version(line)
+ self.requirements[requirements_file][name] = (
+ version,
+ get_package_info(name),
+ )
+
+ def load_existing_issues(self):
+ """Closes the issue if the base Django version is greater than needed"""
+ print("Load existing issues from GitHub")
+ qualifiers = {
+ "repo": GITHUB_REPO,
+ "author": "app/github-actions",
+ "state": "open",
+ "is": "issue",
+ "in": "title",
+ }
+ issues = list(
+ self.github.search_issues(
+ "[Django Update]", "created", "desc", **qualifiers
+ )
+ )
+ print(f"Found {len(issues)} issues matching search")
+ for issue in issues:
+ matches = re.match(r"\[Update Django] Django (\d+.\d+)$", issue.title)
+ if not matches:
+ continue
+ issue_version = DjVersion.parse(matches.group(1))
+ if self.base_dj_version > issue_version:
+ issue.edit(state="closed")
+ print(f"Closed issue {issue.title} (ID: [{issue.id}]({issue.url}))")
+ else:
+ self.existing_issues[issue_version] = issue
+
+ def get_compatibility(
+ self, package_name: str, package_info: dict, needed_dj_version: DjVersion
+ ):
+ """
+ Verify compatibility via setup.py classifiers. If Django is not in the
+ classifiers, then default compatibility is n/a and OK is ✅.
+
+ If it's a package that's vital but known to not be updated often, we give it
+ a ❓. If a package has ❓ or 🕒, then we allow manual update. Automatic updates
+ only include ❌ and ✅.
+ """
+ # If issue previously existed, find package and skip any gtg, manually
+ # updated packages, or known releases that will happen but haven't yet
+ if issue := self.existing_issues.get(needed_dj_version):
+ if index := issue.body.find(package_name):
+ name, _current, prev_compat, ok = (
+ s.strip() for s in issue.body[index:].split("|", 4)[:4]
+ )
+ if ok in ("✅", "❓", "🕒"):
+ return prev_compat, ok
+
+ if package_name in VITAL_BUT_UNKNOWN:
+ return "", "❓"
+
+ # Check classifiers if it includes Django
+ supported_dj_versions: list[DjVersion] = []
+ for classifier in package_info["info"]["classifiers"]:
+ # Usually in the form of "Framework :: Django :: 3.2"
+ tokens = classifier.split(" ")
+ if len(tokens) >= 5 and tokens[2].lower() == "django":
+ version = DjVersion.parse(tokens[4])
+ if len(version) == 2:
+ supported_dj_versions.append(version)
+
+ if supported_dj_versions:
+ if any(v >= needed_dj_version for v in supported_dj_versions):
+ return package_info["info"]["version"], "✅"
+ else:
+ return "", "❌"
+
+ # Django classifier DNE; assume it isn't a Django lib
+ # Great exceptions include pylint-django, where we need to do this manually...
+ return "n/a", "✅"
+
+ HOME_PAGE_URL_KEYS = [
+ "home_page",
+ "project_url",
+ "docs_url",
+ "package_url",
+ "release_url",
+ "bugtrack_url",
+ ]
+
+ def _get_md_home_page_url(self, package_info: dict):
+ urls = [
+ package_info["info"].get(url_key) for url_key in self.HOME_PAGE_URL_KEYS
+ ]
+ try:
+ return f"[{{}}]({next(item for item in urls if item)})"
+ except StopIteration:
+ return "{}"
+
+ def generate_markdown(self, needed_dj_version: DjVersion):
+ requirements = f"{needed_dj_version} requirements tables\n\n"
+ for _file in self.requirements_files:
+ requirements += _TABLE_HEADER.format_map(
+ {"file": _file, "dj_version": needed_dj_version}
+ )
+ for package_name, (version, info) in self.requirements[_file].items():
+ compat_version, icon = self.get_compatibility(
+ package_name, info, needed_dj_version
+ )
+ requirements += (
+ f"| {self._get_md_home_page_url(info).format(package_name)} "
+ f"| {version.strip()} "
+ f"| {compat_version.strip()} "
+ f"| {icon} "
+ f"|\n"
+ )
+
+ return requirements
+
+ def create_or_edit_issue(self, needed_dj_version: DjVersion, description: str):
+ if issue := self.existing_issues.get(needed_dj_version):
+ print(f"Editing issue #{issue.number} for Django {needed_dj_version}")
+ issue.edit(body=description)
+ else:
+ print(f"Creating new issue for Django {needed_dj_version}")
+ issue = self.repo.create_issue(
+ f"[Update Django] Django {needed_dj_version}", description
+ )
+ issue.add_to_labels(f"django{needed_dj_version}")
+
+ def generate(self):
+ for version in self.needed_dj_versions:
+ print(f"Handling GitHub issue for Django {version}")
+ md_content = self.generate_markdown(version)
+ print(f"Generated markdown:\n\n{md_content}")
+ self.create_or_edit_issue(version, md_content)
+
+
+def main(django_max_version=None) -> None:
+ # Check if there are any djs
+ current_dj, latest_djs = get_all_latest_django_versions(
+ django_max_version=django_max_version
+ )
+ if not latest_djs:
+ sys.exit(0)
+ manager = GitHubManager(current_dj, latest_djs)
+ manager.setup()
+ manager.generate()
+
+
+if __name__ == "__main__":
+ if GITHUB_REPO is None:
+ raise RuntimeError(
+ "No github repo, please set the environment variable GITHUB_REPOSITORY"
+ )
+ max_version = None
+ last_arg = sys.argv[-1]
+ if CURRENT_FILE.name not in last_arg:
+ max_version = DjVersion.parse_to_tuple(version_str=last_arg)
+
+ main(django_max_version=max_version)
diff --git a/scripts/update_changelog.py b/scripts/update_changelog.py
new file mode 100644
index 000000000..b50d25066
--- /dev/null
+++ b/scripts/update_changelog.py
@@ -0,0 +1,158 @@
+import datetime as dt
+import os
+import re
+from collections.abc import Iterable
+from pathlib import Path
+
+import git
+import github.PullRequest
+import github.Repository
+from github import Github
+from jinja2 import Template
+
+CURRENT_FILE = Path(__file__)
+ROOT = CURRENT_FILE.parents[1]
+GITHUB_TOKEN = os.getenv("GITHUB_TOKEN")
+GITHUB_REPO = os.getenv("GITHUB_REPOSITORY")
+GIT_BRANCH = os.getenv("GITHUB_REF_NAME")
+
+
+def main() -> None:
+ """
+ Script entry point.
+ """
+ # Generate changelog for PRs merged yesterday
+ merged_date = dt.date.today() - dt.timedelta(days=1)
+ repo = Github(login_or_token=GITHUB_TOKEN).get_repo(GITHUB_REPO)
+ merged_pulls = list(iter_pulls(repo, merged_date))
+ print(f"Merged pull requests: {merged_pulls}")
+ if not merged_pulls:
+ print("Nothing was merged, existing.")
+ return
+
+ # Group pull requests by type of change
+ grouped_pulls = group_pulls_by_change_type(merged_pulls)
+
+ # Generate portion of markdown
+ release_changes_summary = generate_md(grouped_pulls)
+ print(f"Summary of changes: {release_changes_summary}")
+
+ # Update CHANGELOG.md file
+ release = f"{merged_date:%Y.%m.%d}"
+ changelog_path = ROOT / "CHANGELOG.md"
+ write_changelog(changelog_path, release, release_changes_summary)
+ print(f"Wrote {changelog_path}")
+
+ # Update version
+ setup_py_path = ROOT / "setup.py"
+ update_version(setup_py_path, release)
+ print(f"Updated version in {setup_py_path}")
+
+ # Commit changes, create tag and push
+ update_git_repo([changelog_path, setup_py_path], release)
+
+ # Create GitHub release
+ github_release = repo.create_git_release(
+ tag=release,
+ name=release,
+ message=release_changes_summary,
+ )
+ print(f"Created release on GitHub {github_release}")
+
+
+def iter_pulls(
+ repo: github.Repository.Repository,
+ merged_date: dt.date,
+) -> Iterable[github.PullRequest.PullRequest]:
+ """Fetch merged pull requests at the date we're interested in."""
+ recent_pulls = repo.get_pulls(
+ state="closed",
+ sort="updated",
+ direction="desc",
+ ).get_page(0)
+ for pull in recent_pulls:
+ if pull.merged and pull.merged_at.date() == merged_date:
+ yield pull
+
+
+def group_pulls_by_change_type(
+ pull_requests_list: list[github.PullRequest.PullRequest],
+) -> dict[str, list[github.PullRequest.PullRequest]]:
+ """Group pull request by change type."""
+ grouped_pulls = {
+ "Changed": [],
+ "Fixed": [],
+ "Updated": [],
+ }
+ for pull in pull_requests_list:
+ label_names = {label.name for label in pull.labels}
+ if "update" in label_names:
+ group_name = "Updated"
+ elif "bug" in label_names:
+ group_name = "Fixed"
+ else:
+ group_name = "Changed"
+ grouped_pulls[group_name].append(pull)
+ return grouped_pulls
+
+
+def generate_md(grouped_pulls: dict[str, list[github.PullRequest.PullRequest]]) -> str:
+ """Generate markdown file from Jinja template."""
+ changelog_template = ROOT / ".github" / "changelog-template.md"
+ template = Template(changelog_template.read_text(), autoescape=True)
+ return template.render(grouped_pulls=grouped_pulls)
+
+
+def write_changelog(file_path: Path, release: str, content: str) -> None:
+ """Write Release details to the changelog file."""
+ content = f"## {release}\n{content}"
+ old_content = file_path.read_text()
+ updated_content = old_content.replace(
+ "",
+ f"\n\n{content}",
+ )
+ file_path.write_text(updated_content)
+
+
+def update_version(file_path: Path, release: str) -> None:
+ """Update template version in setup.py."""
+ old_content = file_path.read_text()
+ updated_content = re.sub(
+ r'\nversion = "\d+\.\d+\.\d+"\n',
+ f'\nversion = "{release}"\n',
+ old_content,
+ )
+ file_path.write_text(updated_content)
+
+
+def update_git_repo(paths: list[Path], release: str) -> None:
+ """Commit, tag changes in git repo and push to origin."""
+ repo = git.Repo(ROOT)
+ for path in paths:
+ repo.git.add(path)
+ message = f"Release {release}"
+
+ user = repo.git.config("--get", "user.name")
+ email = repo.git.config("--get", "user.email")
+
+ repo.git.commit(
+ m=message,
+ author=f"{user} <{email}>",
+ )
+ repo.git.tag("-a", release, m=message)
+ server = f"https://{GITHUB_TOKEN}@github.com/{GITHUB_REPO}.git"
+ print(f"Pushing changes to {GIT_BRANCH} branch of {GITHUB_REPO}")
+ repo.git.push(server, GIT_BRANCH)
+ repo.git.push("--tags", server, GIT_BRANCH)
+
+
+if __name__ == "__main__":
+ if GITHUB_REPO is None:
+ raise RuntimeError(
+ "No github repo, please set the environment variable GITHUB_REPOSITORY"
+ )
+ if GIT_BRANCH is None:
+ raise RuntimeError(
+ "No git branch set, please set the GITHUB_REF_NAME environment variable"
+ )
+ main()
diff --git a/scripts/update_contributors.py b/scripts/update_contributors.py
new file mode 100644
index 000000000..76ccf60ad
--- /dev/null
+++ b/scripts/update_contributors.py
@@ -0,0 +1,112 @@
+import json
+import os
+from pathlib import Path
+
+from github import Github
+from github.NamedUser import NamedUser
+from jinja2 import Template
+
+CURRENT_FILE = Path(__file__)
+ROOT = CURRENT_FILE.parents[1]
+BOT_LOGINS = ["pyup-bot"]
+GITHUB_TOKEN = os.getenv("GITHUB_TOKEN", None)
+GITHUB_REPO = os.getenv("GITHUB_REPOSITORY", None)
+
+
+def main() -> None:
+ """
+ Script entry point.
+
+ 1. Fetch recent contributors from the Github API
+ 2. Add missing ones to the JSON file
+ 3. Generate Markdown from JSON file
+ """
+ recent_authors = set(iter_recent_authors())
+
+ # Add missing users to the JSON file
+ contrib_file = ContributorsJSONFile()
+ for author in recent_authors:
+ print(f"Checking if {author.login} should be added")
+ if author.login not in contrib_file:
+ contrib_file.add_contributor(author)
+ print(f"Added {author.login} to contributors")
+ contrib_file.save()
+
+ # Generate MD file from JSON file
+ write_md_file(contrib_file.content)
+
+
+def iter_recent_authors():
+ """
+ Fetch users who opened recently merged pull requests.
+
+ Use Github API to fetch recent authors rather than
+ git CLI to work with Github usernames.
+ """
+ repo = Github(login_or_token=GITHUB_TOKEN, per_page=5).get_repo(GITHUB_REPO)
+ recent_pulls = repo.get_pulls(
+ state="closed", sort="updated", direction="desc"
+ ).get_page(0)
+ for pull in recent_pulls:
+ if (
+ pull.merged
+ and pull.user.type == "User"
+ and pull.user.login not in BOT_LOGINS
+ ):
+ yield pull.user
+
+
+class ContributorsJSONFile:
+ """Helper to interact with the JSON file."""
+
+ file_path = ROOT / ".github" / "contributors.json"
+ content = None
+
+ def __init__(self) -> None:
+ """Read initial content."""
+ self.content = json.loads(self.file_path.read_text())
+
+ def __contains__(self, github_login: str):
+ """Provide a nice API to do: `username in file`."""
+ return any(
+ # Github usernames are case insensitive
+ github_login.lower() == contrib["github_login"].lower()
+ for contrib in self.content
+ )
+
+ def add_contributor(self, user: NamedUser):
+ """Append the contributor data we care about at the end."""
+ contributor_data = {
+ "name": user.name or user.login,
+ "github_login": user.login,
+ "twitter_username": user.twitter_username or "",
+ }
+ self.content.append(contributor_data)
+
+ def save(self):
+ """Write the file to disk with indentation."""
+ text_content = json.dumps(self.content, indent=2, ensure_ascii=False)
+ self.file_path.write_text(text_content)
+
+
+def write_md_file(contributors):
+ """Generate markdown file from Jinja template."""
+ contributors_template = ROOT / ".github" / "CONTRIBUTORS-template.md"
+ template = Template(contributors_template.read_text(), autoescape=True)
+ core_contributors = [c for c in contributors if c.get("is_core", False)]
+ other_contributors = (c for c in contributors if not c.get("is_core", False))
+ other_contributors = sorted(other_contributors, key=lambda c: c["name"].lower())
+ content = template.render(
+ core_contributors=core_contributors, other_contributors=other_contributors
+ )
+
+ file_path = ROOT / "CONTRIBUTORS.md"
+ file_path.write_text(content)
+
+
+if __name__ == "__main__":
+ if GITHUB_REPO is None:
+ raise RuntimeError(
+ "No github repo, please set the environment variable GITHUB_REPOSITORY"
+ )
+ main()
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 000000000..dd8f1ef3c
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,7 @@
+[flake8]
+exclude = docs
+max-line-length = 88
+
+[isort]
+profile = black
+known_first_party = tests,scripts,hooks
diff --git a/setup.py b/setup.py
index 330320096..f8321406d 100644
--- a/setup.py
+++ b/setup.py
@@ -1,21 +1,11 @@
#!/usr/bin/env python
-
-import os
-import sys
-
try:
from setuptools import setup
except ImportError:
from distutils.core import setup
-# 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 = "2.2.1"
-
-if sys.argv[-1] == "tag":
- os.system(f'git tag -a {version} -m "version {version}"')
- os.system("git push --tags")
- sys.exit()
+# We use calendar versioning
+version = "2023.01.28"
with open("README.rst") as readme_file:
long_description = readme_file.read()
@@ -23,24 +13,27 @@ with open("README.rst") as readme_file:
setup(
name="cookiecutter-django",
version=version,
- description="A Cookiecutter template for creating production-ready Django projects quickly.",
+ description=(
+ "A Cookiecutter template for creating production-ready "
+ "Django projects quickly."
+ ),
long_description=long_description,
author="Daniel Roy Greenfeld",
author_email="pydanny@gmail.com",
- url="https://github.com/pydanny/cookiecutter-django",
+ url="https://github.com/cookiecutter/cookiecutter-django",
packages=[],
license="BSD",
zip_safe=False,
classifiers=[
"Development Status :: 4 - Beta",
"Environment :: Console",
- "Framework :: Django :: 2.2",
+ "Framework :: Django :: 4.0",
"Intended Audience :: Developers",
"Natural Language :: English",
"License :: OSI Approved :: BSD License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
- "Programming Language :: Python :: 3.7",
+ "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: Implementation :: CPython",
"Topic :: Software Development",
],
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/test_bare.sh b/tests/test_bare.sh
index 7021a7e47..afd12fec8 100755
--- a/tests/test_bare.sh
+++ b/tests/test_bare.sh
@@ -1,19 +1,17 @@
#!/bin/sh
# this is a very simple script that tests the docker configuration for cookiecutter-django
# it is meant to be run from the root directory of the repository, eg:
-# sh tests/test_docker.sh
+# sh tests/test_bare.sh
set -o errexit
-
-# install test requirements
-pip install -r requirements.txt
+set -x
# create a cache directory
mkdir -p .cache/bare
cd .cache/bare
# create the project using the default settings in cookiecutter.json
-cookiecutter ../../ --no-input --overwrite-if-exists use_docker=n $@
+cookiecutter ../../ --no-input --overwrite-if-exists use_docker=n "$@"
cd my_awesome_project
# Install OS deps
@@ -22,5 +20,24 @@ sudo utility/install_os_dependencies.sh install
# Install Python deps
pip install -r requirements/local.txt
+# Lint by running pre-commit on all files
+# Needs a git repo to find the project root
+git init
+git add .
+pre-commit run --show-diff-on-failure -a
+
# run the project's tests
pytest
+
+# Make sure the check doesn't raise any warnings
+python manage.py check --fail-level WARNING
+
+# Run npm build script if package.json is present
+if [ -f "package.json" ]
+then
+ npm install
+ npm run build
+fi
+
+# Generate the HTML for the documentation
+cd docs && make html
diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py
index 39b05d7c6..5608bf884 100755
--- a/tests/test_cookiecutter_generation.py
+++ b/tests/test_cookiecutter_generation.py
@@ -1,16 +1,25 @@
import os
import re
+import sys
import pytest
-from cookiecutter.exceptions import FailedHookException
-from pytest_cases import fixture_plus
-import sh
+
+try:
+ import sh
+except (ImportError, ModuleNotFoundError):
+ sh = None # sh doesn't support Windows
import yaml
from binaryornot.check import is_binary
+from cookiecutter.exceptions import FailedHookException
PATTERN = r"{{(\s?cookiecutter)[.](.*?)}}"
RE_OBJ = re.compile(PATTERN)
+if sys.platform.startswith("win"):
+ pytest.skip("sh doesn't support windows", allow_module_level=True)
+elif sys.platform.startswith("darwin") and os.getenv("CI"):
+ pytest.skip("skipping slow macOS tests on CI", allow_module_level=True)
+
@pytest.fixture
def context():
@@ -26,159 +35,262 @@ def context():
}
-@fixture_plus
-@pytest.mark.parametrize("windows", ["y", "n"], ids=lambda yn: f"win:{yn}")
-@pytest.mark.parametrize("use_docker", ["y", "n"], ids=lambda yn: f"docker:{yn}")
-@pytest.mark.parametrize("use_celery", ["y", "n"], ids=lambda yn: f"celery:{yn}")
-@pytest.mark.parametrize("use_mailhog", ["y", "n"], ids=lambda yn: f"mailhog:{yn}")
-@pytest.mark.parametrize("use_sentry", ["y", "n"], ids=lambda yn: f"sentry:{yn}")
-@pytest.mark.parametrize("use_compressor", ["y", "n"], ids=lambda yn: f"cmpr:{yn}")
-@pytest.mark.parametrize("use_drf", ["y", "n"], ids=lambda yn: f"drf:{yn}")
-@pytest.mark.parametrize(
- "use_whitenoise,cloud_provider",
- [
- ("y", "AWS"),
- ("y", "GCP"),
- ("y", "None"),
- ("n", "AWS"),
- ("n", "GCP"),
- # no whitenoise + no cloud provider is not supported
- ],
- ids=lambda id: f"wnoise:{id[0]}-cloud:{id[1]}",
-)
-def context_combination(
- windows,
- use_docker,
- use_celery,
- use_mailhog,
- use_sentry,
- use_compressor,
- use_whitenoise,
- use_drf,
- cloud_provider,
-):
- """Fixture that parametrize the function where it's used."""
- return {
- "windows": windows,
- "use_docker": use_docker,
- "use_compressor": use_compressor,
- "use_celery": use_celery,
- "use_mailhog": use_mailhog,
- "use_sentry": use_sentry,
- "use_whitenoise": use_whitenoise,
- "use_drf": use_drf,
- "cloud_provider": cloud_provider,
- }
+SUPPORTED_COMBINATIONS = [
+ {"open_source_license": "MIT"},
+ {"open_source_license": "BSD"},
+ {"open_source_license": "GPLv3"},
+ {"open_source_license": "Apache Software License 2.0"},
+ {"open_source_license": "Not open source"},
+ {"windows": "y"},
+ {"windows": "n"},
+ {"use_pycharm": "y"},
+ {"use_pycharm": "n"},
+ {"use_docker": "y"},
+ {"use_docker": "n"},
+ {"postgresql_version": "14"},
+ {"postgresql_version": "13"},
+ {"postgresql_version": "12"},
+ {"postgresql_version": "11"},
+ {"postgresql_version": "10"},
+ {"cloud_provider": "AWS", "use_whitenoise": "y"},
+ {"cloud_provider": "AWS", "use_whitenoise": "n"},
+ {"cloud_provider": "GCP", "use_whitenoise": "y"},
+ {"cloud_provider": "GCP", "use_whitenoise": "n"},
+ {"cloud_provider": "Azure", "use_whitenoise": "y"},
+ {"cloud_provider": "Azure", "use_whitenoise": "n"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Mailgun"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Mailjet"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Mandrill"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Postmark"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Sendgrid"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "SendinBlue"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "SparkPost"},
+ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Other SMTP"},
+ # Note: cloud_provider=None AND use_whitenoise=n is not supported
+ {"cloud_provider": "AWS", "mail_service": "Mailgun"},
+ {"cloud_provider": "AWS", "mail_service": "Amazon SES"},
+ {"cloud_provider": "AWS", "mail_service": "Mailjet"},
+ {"cloud_provider": "AWS", "mail_service": "Mandrill"},
+ {"cloud_provider": "AWS", "mail_service": "Postmark"},
+ {"cloud_provider": "AWS", "mail_service": "Sendgrid"},
+ {"cloud_provider": "AWS", "mail_service": "SendinBlue"},
+ {"cloud_provider": "AWS", "mail_service": "SparkPost"},
+ {"cloud_provider": "AWS", "mail_service": "Other SMTP"},
+ {"cloud_provider": "GCP", "mail_service": "Mailgun"},
+ {"cloud_provider": "GCP", "mail_service": "Mailjet"},
+ {"cloud_provider": "GCP", "mail_service": "Mandrill"},
+ {"cloud_provider": "GCP", "mail_service": "Postmark"},
+ {"cloud_provider": "GCP", "mail_service": "Sendgrid"},
+ {"cloud_provider": "GCP", "mail_service": "SendinBlue"},
+ {"cloud_provider": "GCP", "mail_service": "SparkPost"},
+ {"cloud_provider": "GCP", "mail_service": "Other SMTP"},
+ {"cloud_provider": "Azure", "mail_service": "Mailgun"},
+ {"cloud_provider": "Azure", "mail_service": "Mailjet"},
+ {"cloud_provider": "Azure", "mail_service": "Mandrill"},
+ {"cloud_provider": "Azure", "mail_service": "Postmark"},
+ {"cloud_provider": "Azure", "mail_service": "Sendgrid"},
+ {"cloud_provider": "Azure", "mail_service": "SendinBlue"},
+ {"cloud_provider": "Azure", "mail_service": "SparkPost"},
+ {"cloud_provider": "Azure", "mail_service": "Other SMTP"},
+ # Note: cloud_providers GCP, Azure, and None
+ # with mail_service Amazon SES is not supported
+ {"use_async": "y"},
+ {"use_async": "n"},
+ {"use_drf": "y"},
+ {"use_drf": "n"},
+ {"frontend_pipeline": "None"},
+ {"frontend_pipeline": "Django Compressor"},
+ {"frontend_pipeline": "Gulp"},
+ {"frontend_pipeline": "Webpack"},
+ {"use_celery": "y"},
+ {"use_celery": "n"},
+ {"use_mailhog": "y"},
+ {"use_mailhog": "n"},
+ {"use_sentry": "y"},
+ {"use_sentry": "n"},
+ {"use_whitenoise": "y"},
+ {"use_whitenoise": "n"},
+ {"use_heroku": "y"},
+ {"use_heroku": "n"},
+ {"ci_tool": "None"},
+ {"ci_tool": "Travis"},
+ {"ci_tool": "Gitlab"},
+ {"ci_tool": "Github"},
+ {"keep_local_envs_in_vcs": "y"},
+ {"keep_local_envs_in_vcs": "n"},
+ {"debug": "y"},
+ {"debug": "n"},
+]
+
+UNSUPPORTED_COMBINATIONS = [
+ {"cloud_provider": "None", "use_whitenoise": "n"},
+ {"cloud_provider": "GCP", "mail_service": "Amazon SES"},
+ {"cloud_provider": "Azure", "mail_service": "Amazon SES"},
+ {"cloud_provider": "None", "mail_service": "Amazon SES"},
+]
-def build_files_list(root_dir):
+def _fixture_id(ctx):
+ """Helper to get a user-friendly test name from the parametrized context."""
+ return "-".join(f"{key}:{value}" for key, value in ctx.items())
+
+
+def build_files_list(base_dir):
"""Build a list containing absolute paths to the generated files."""
return [
os.path.join(dirpath, file_path)
- for dirpath, subdirs, files in os.walk(root_dir)
+ for dirpath, subdirs, files in os.walk(base_dir)
for file_path in files
]
def check_paths(paths):
- """Method to check all paths have correct substitutions,
- used by other tests cases
- """
+ """Method to check all paths have correct substitutions."""
# Assert that no match is found in any of the files
for path in paths:
if is_binary(path):
continue
- for line in open(path, "r"):
+ for line in open(path):
match = RE_OBJ.search(line)
- msg = "cookiecutter variable not replaced in {}"
- assert match is None, msg.format(path)
+ assert match is None, f"cookiecutter variable not replaced in {path}"
-def test_project_generation(cookies, context, context_combination):
- """
- Test that project is generated and fully rendered.
+@pytest.mark.parametrize("context_override", SUPPORTED_COMBINATIONS, ids=_fixture_id)
+def test_project_generation(cookies, context, context_override):
+ """Test that project is generated and fully rendered."""
- This is parametrized for each combination from ``context_combination`` fixture
- """
- result = cookies.bake(extra_context={**context, **context_combination})
+ result = cookies.bake(extra_context={**context, **context_override})
assert result.exit_code == 0
assert result.exception is None
- assert result.project.basename == context["project_slug"]
- assert result.project.isdir()
+ assert result.project_path.name == context["project_slug"]
+ assert result.project_path.is_dir()
- paths = build_files_list(str(result.project))
+ paths = build_files_list(str(result.project_path))
assert paths
check_paths(paths)
-@pytest.mark.flake8
-def test_flake8_passes(cookies, context_combination):
- """
- Generated project should pass flake8.
-
- This is parametrized for each combination from ``context_combination`` fixture
- """
- result = cookies.bake(extra_context=context_combination)
+@pytest.mark.parametrize("context_override", SUPPORTED_COMBINATIONS, ids=_fixture_id)
+def test_flake8_passes(cookies, context_override):
+ """Generated project should pass flake8."""
+ result = cookies.bake(extra_context=context_override)
try:
- sh.flake8(str(result.project))
+ sh.flake8(_cwd=str(result.project_path))
except sh.ErrorReturnCode as e:
- pytest.fail(e)
+ pytest.fail(e.stdout.decode())
-@pytest.mark.black
-def test_black_passes(cookies, context_combination):
- """
- Generated project should pass black.
-
- This is parametrized for each combination from ``context_combination`` fixture
- """
- result = cookies.bake(extra_context=context_combination)
+@pytest.mark.parametrize("context_override", SUPPORTED_COMBINATIONS, ids=_fixture_id)
+def test_black_passes(cookies, context_override):
+ """Generated project should pass black."""
+ result = cookies.bake(extra_context=context_override)
try:
- sh.black("--check", "--diff", "--exclude", "migrations", f"{result.project}/")
+ sh.black(
+ "--check",
+ "--diff",
+ "--exclude",
+ "migrations",
+ ".",
+ _cwd=str(result.project_path),
+ )
except sh.ErrorReturnCode as e:
- pytest.fail(e)
+ pytest.fail(e.stdout.decode())
-def test_travis_invokes_pytest(cookies, context):
- context.update({"ci_tool": "Travis"})
+@pytest.mark.parametrize(
+ ["use_docker", "expected_test_script"],
+ [
+ ("n", "pytest"),
+ ("y", "docker-compose -f local.yml run django pytest"),
+ ],
+)
+def test_travis_invokes_pytest(cookies, context, use_docker, expected_test_script):
+ context.update({"ci_tool": "Travis", "use_docker": use_docker})
result = cookies.bake(extra_context=context)
assert result.exit_code == 0
assert result.exception is None
- assert result.project.basename == context["project_slug"]
- assert result.project.isdir()
+ assert result.project_path.name == context["project_slug"]
+ assert result.project_path.is_dir()
- with open(f"{result.project}/.travis.yml", "r") as travis_yml:
+ with open(f"{result.project_path}/.travis.yml") as travis_yml:
try:
- assert yaml.load(travis_yml)["script"] == ["pytest"]
+ yml = yaml.safe_load(travis_yml)["jobs"]["include"]
+ assert yml[0]["script"] == ["flake8"]
+ assert yml[1]["script"] == [expected_test_script]
+ except yaml.YAMLError as e:
+ pytest.fail(str(e))
+
+
+@pytest.mark.parametrize(
+ ["use_docker", "expected_test_script"],
+ [
+ ("n", "pytest"),
+ ("y", "docker-compose -f local.yml run django pytest"),
+ ],
+)
+def test_gitlab_invokes_flake8_and_pytest(
+ cookies, context, use_docker, expected_test_script
+):
+ context.update({"ci_tool": "Gitlab", "use_docker": use_docker})
+ result = cookies.bake(extra_context=context)
+
+ assert result.exit_code == 0
+ assert result.exception is None
+ assert result.project_path.name == context["project_slug"]
+ assert result.project_path.is_dir()
+
+ with open(f"{result.project_path}/.gitlab-ci.yml") as gitlab_yml:
+ try:
+ gitlab_config = yaml.safe_load(gitlab_yml)
+ assert gitlab_config["flake8"]["script"] == ["flake8"]
+ assert gitlab_config["pytest"]["script"] == [expected_test_script]
except yaml.YAMLError as e:
pytest.fail(e)
-def test_gitlab_invokes_flake8_and_pytest(cookies, context):
- context.update({"ci_tool": "Gitlab"})
+@pytest.mark.parametrize(
+ ["use_docker", "expected_test_script"],
+ [
+ ("n", "pytest"),
+ ("y", "docker-compose -f local.yml run django pytest"),
+ ],
+)
+def test_github_invokes_linter_and_pytest(
+ cookies, context, use_docker, expected_test_script
+):
+ context.update({"ci_tool": "Github", "use_docker": use_docker})
result = cookies.bake(extra_context=context)
assert result.exit_code == 0
assert result.exception is None
- assert result.project.basename == context["project_slug"]
- assert result.project.isdir()
+ assert result.project_path.name == context["project_slug"]
+ assert result.project_path.is_dir()
- with open(f"{result.project}/.gitlab-ci.yml", "r") as gitlab_yml:
+ with open(f"{result.project_path}/.github/workflows/ci.yml") as github_yml:
try:
- gitlab_config = yaml.load(gitlab_yml)
- assert gitlab_config["flake8"]["script"] == ["flake8"]
- assert gitlab_config["pytest"]["script"] == ["pytest"]
+ github_config = yaml.safe_load(github_yml)
+ linter_present = False
+ for action_step in github_config["jobs"]["linter"]["steps"]:
+ if action_step.get("uses", "NA").startswith("pre-commit"):
+ linter_present = True
+ assert linter_present
+
+ expected_test_script_present = False
+ for action_step in github_config["jobs"]["pytest"]["steps"]:
+ if action_step.get("run") == expected_test_script:
+ expected_test_script_present = True
+ assert expected_test_script_present
except yaml.YAMLError as e:
pytest.fail(e)
@pytest.mark.parametrize("slug", ["project slug", "Project_Slug"])
def test_invalid_slug(cookies, context, slug):
- """Invalid slug should failed pre-generation hook."""
+ """Invalid slug should fail pre-generation hook."""
context.update({"project_slug": slug})
result = cookies.bake(extra_context=context)
@@ -187,10 +299,28 @@ def test_invalid_slug(cookies, context, slug):
assert isinstance(result.exception, FailedHookException)
-def test_no_whitenoise_and_no_cloud_provider(cookies, context):
- """It should not generate project if neither whitenoise or cloud provider are set"""
- context.update({"use_whitenoise": "n", "cloud_provider": "None"})
+@pytest.mark.parametrize("invalid_context", UNSUPPORTED_COMBINATIONS)
+def test_error_if_incompatible(cookies, context, invalid_context):
+ """It should not generate project an incompatible combination is selected."""
+ context.update(invalid_context)
result = cookies.bake(extra_context=context)
assert result.exit_code != 0
assert isinstance(result.exception, FailedHookException)
+
+
+@pytest.mark.parametrize(
+ ["use_pycharm", "pycharm_docs_exist"],
+ [
+ ("n", False),
+ ("y", True),
+ ],
+)
+def test_pycharm_docs_removed(cookies, context, use_pycharm, pycharm_docs_exist):
+ """."""
+ context.update({"use_pycharm": use_pycharm})
+ result = cookies.bake(extra_context=context)
+
+ with open(f"{result.project_path}/docs/index.rst") as f:
+ has_pycharm_docs = "pycharm/configuration" in f.read()
+ assert has_pycharm_docs is pycharm_docs_exist
diff --git a/tests/test_docker.sh b/tests/test_docker.sh
index 55771c14c..28d232896 100755
--- a/tests/test_docker.sh
+++ b/tests/test_docker.sh
@@ -4,24 +4,29 @@
# sh tests/test_docker.sh
set -o errexit
-
-# install test requirements
-pip install -r requirements.txt
+set -x
# create a cache directory
mkdir -p .cache/docker
cd .cache/docker
# create the project using the default settings in cookiecutter.json
-cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y $@
+cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y "$@"
cd my_awesome_project
+# Lint by running pre-commit on all files
+# Needs a git repo to find the project root
+# We don't have git inside Docker, so run it outside
+git init
+git add .
+pre-commit run --show-diff-on-failure -a
+
+# make sure all images build
+docker-compose -f local.yml build
+
# run the project's type checks
docker-compose -f local.yml run django mypy my_awesome_project
-# Run black with --check option
-docker-compose -f local.yml run django black --check --diff --exclude 'migrations' ./
-
# run the project's tests
docker-compose -f local.yml run django pytest
@@ -29,4 +34,16 @@ docker-compose -f local.yml run django pytest
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
+docker-compose -f local.yml run django python manage.py makemessages --all
+
+# Make sure the check doesn't raise any warnings
+docker-compose -f local.yml run django python manage.py check --fail-level WARNING
+
+# Generate the HTML for the documentation
+docker-compose -f local.yml run docs make html
+
+# Run npm build script if package.json is present
+if [ -f "package.json" ]
+then
+ docker-compose -f local.yml run node npm run build
+fi
diff --git a/tests/test_hooks.py b/tests/test_hooks.py
new file mode 100644
index 000000000..7ca752722
--- /dev/null
+++ b/tests/test_hooks.py
@@ -0,0 +1,28 @@
+"""Unit tests for the hooks"""
+import os
+from pathlib import Path
+
+import pytest
+
+from hooks.post_gen_project import append_to_gitignore_file
+
+
+@pytest.fixture()
+def working_directory(tmp_path):
+ prev_cwd = Path.cwd()
+ os.chdir(tmp_path)
+ try:
+ yield tmp_path
+ finally:
+ os.chdir(prev_cwd)
+
+
+def test_append_to_gitignore_file(working_directory):
+ gitignore_file = working_directory / ".gitignore"
+ gitignore_file.write_text("node_modules/\n")
+ append_to_gitignore_file(".envs/*")
+ linesep = os.linesep.encode()
+ assert (
+ gitignore_file.read_bytes() == b"node_modules/" + linesep + b".envs/*" + linesep
+ )
+ assert gitignore_file.read_text() == "node_modules/\n.envs/*\n"
diff --git a/tox.ini b/tox.ini
index 1c83465cc..0400e4f91 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,19 +1,11 @@
[tox]
skipsdist = true
-envlist = py37,flake8,black,black-template
+envlist = py310,black-template
[testenv]
deps = -rrequirements.txt
-commands = pytest -m "not flake8" -m "not black" {posargs:./tests}
-
-[testenv:flake8]
-deps = -rrequirements.txt
-commands = pytest -m flake8 {posargs:./tests}
-
-[testenv:black]
-deps = -rrequirements.txt
-commands = pytest -m black {posargs:./tests}
+commands = pytest {posargs:./tests}
[testenv:black-template]
deps = black
-commands = black --check hooks tests setup.py docs
+commands = black --check hooks tests setup.py docs scripts
diff --git a/{{cookiecutter.project_slug}}/.coveragerc b/{{cookiecutter.project_slug}}/.coveragerc
deleted file mode 100644
index 283a4b89c..000000000
--- a/{{cookiecutter.project_slug}}/.coveragerc
+++ /dev/null
@@ -1,5 +0,0 @@
-[run]
-include = {{cookiecutter.project_slug}}/*
-omit = *migrations*, *tests*
-plugins =
- django_coverage_plugin
diff --git a/{{cookiecutter.project_slug}}/.dockerignore b/{{cookiecutter.project_slug}}/.dockerignore
index e63c0c184..7369480e3 100644
--- a/{{cookiecutter.project_slug}}/.dockerignore
+++ b/{{cookiecutter.project_slug}}/.dockerignore
@@ -1,4 +1,11 @@
-.*
-!.coveragerc
-!.env
-!.pylintrc
+.editorconfig
+.gitattributes
+.github
+.gitignore
+.gitlab-ci.yml
+.idea
+.pre-commit-config.yaml
+.readthedocs.yml
+.travis.yml
+venv
+.git
diff --git a/{{cookiecutter.project_slug}}/.editorconfig b/{{cookiecutter.project_slug}}/.editorconfig
index 792dd3b06..6a9a5c45d 100644
--- a/{{cookiecutter.project_slug}}/.editorconfig
+++ b/{{cookiecutter.project_slug}}/.editorconfig
@@ -12,19 +12,7 @@ trim_trailing_whitespace = true
indent_style = space
indent_size = 4
-[*.py]
-line_length = 120
-known_first_party = {{ cookiecutter.project_slug }}
-multi_line_output = 3
-default_section = THIRDPARTY
-recursive = true
-skip = venv/
-skip_glob = **/migrations/*.py
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-
-[*.{html,css,scss,json,yml}]
+[*.{html,css,scss,json,yml,xml}]
indent_style = space
indent_size = 2
diff --git a/{{cookiecutter.project_slug}}/.envs/.local/.django b/{{cookiecutter.project_slug}}/.envs/.local/.django
index 919f31185..ef581a1c0 100644
--- a/{{cookiecutter.project_slug}}/.envs/.local/.django
+++ b/{{cookiecutter.project_slug}}/.envs/.local/.django
@@ -14,4 +14,4 @@ REDIS_URL=redis://redis:6379/0
# Flower
CELERY_FLOWER_USER=!!!SET CELERY_FLOWER_USER!!!
CELERY_FLOWER_PASSWORD=!!!SET CELERY_FLOWER_PASSWORD!!!
-{% endif %}
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/.envs/.production/.django b/{{cookiecutter.project_slug}}/.envs/.production/.django
index 2c2e94f2d..ad652c9ad 100644
--- a/{{cookiecutter.project_slug}}/.envs/.production/.django
+++ b/{{cookiecutter.project_slug}}/.envs/.production/.django
@@ -13,9 +13,26 @@ DJANGO_SECURE_SSL_REDIRECT=False
# Email
# ------------------------------------------------------------------------------
-MAILGUN_API_KEY=
DJANGO_SERVER_EMAIL=
+{% if cookiecutter.mail_service == 'Mailgun' %}
+MAILGUN_API_KEY=
MAILGUN_DOMAIN=
+{% elif cookiecutter.mail_service == 'Mailjet' %}
+MAILJET_API_KEY=
+MAILJET_SECRET_KEY=
+{% elif cookiecutter.mail_service == 'Mandrill' %}
+MANDRILL_API_KEY=
+{% elif cookiecutter.mail_service == 'Postmark' %}
+POSTMARK_SERVER_TOKEN=
+{% elif cookiecutter.mail_service == 'Sendgrid' %}
+SENDGRID_API_KEY=
+SENDGRID_GENERATE_MESSAGE_ID=True
+SENDGRID_MERGE_FIELD_FORMAT=None
+{% elif cookiecutter.mail_service == 'SendinBlue' %}
+SENDINBLUE_API_KEY=
+{% elif cookiecutter.mail_service == 'SparkPost' %}
+SPARKPOST_API_KEY=
+{% endif %}
{% if cookiecutter.cloud_provider == 'AWS' %}
# AWS
# ------------------------------------------------------------------------------
@@ -27,15 +44,17 @@ DJANGO_AWS_STORAGE_BUCKET_NAME=
# ------------------------------------------------------------------------------
GOOGLE_APPLICATION_CREDENTIALS=
DJANGO_GCP_STORAGE_BUCKET_NAME=
+{% elif cookiecutter.cloud_provider == 'Azure' %}
+# Azure
+# ------------------------------------------------------------------------------
+DJANGO_AZURE_ACCOUNT_KEY=
+DJANGO_AZURE_ACCOUNT_NAME=
+DJANGO_AZURE_CONTAINER_NAME=
{% endif %}
# django-allauth
# ------------------------------------------------------------------------------
DJANGO_ACCOUNT_ALLOW_REGISTRATION=True
-{% if cookiecutter.use_compressor == 'y' %}
-# django-compressor
-# ------------------------------------------------------------------------------
-COMPRESS_ENABLED=
-{% endif %}
+
# Gunicorn
# ------------------------------------------------------------------------------
WEB_CONCURRENCY=4
diff --git a/{{cookiecutter.project_slug}}/.github/dependabot.yml b/{{cookiecutter.project_slug}}/.github/dependabot.yml
new file mode 100644
index 000000000..420a63cdc
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/.github/dependabot.yml
@@ -0,0 +1,95 @@
+# Config for Dependabot updates. See Documentation here:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ # Update GitHub actions in workflows
+ - package-ecosystem: "github-actions"
+ directory: "/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+{%- if cookiecutter.use_docker == 'y' %}
+
+ # Enable version updates for Docker
+ # We need to specify each Dockerfile in a separate entry because Dependabot doesn't
+ # support wildcards or recursively checking subdirectories. Check this issue for updates:
+ # https://github.com/dependabot/dependabot-core/issues/2178
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/local/django` directory
+ directory: "compose/local/django/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/local/docs` directory
+ directory: "compose/local/docs/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/local/node` directory
+ directory: "compose/local/node/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/production/aws` directory
+ directory: "compose/production/aws/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/production/django` directory
+ directory: "compose/production/django/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/production/postgres` directory
+ directory: "compose/production/postgres/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+ # Enable version updates for Docker
+ - package-ecosystem: "docker"
+ # Look for a `Dockerfile` in the `compose/production/traefik` directory
+ directory: "compose/production/traefik/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+{%- endif %}
+
+ # Enable version updates for Python/Pip - Production
+ - package-ecosystem: "pip"
+ # Look for a `requirements.txt` in the `root` directory
+ # also 'setup.cfg', 'runtime.txt' and 'requirements/*.txt'
+ directory: "/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+{%- if cookiecutter.frontend_pipeline == 'Gulp' %}
+
+ # Enable version updates for javascript/npm
+ - package-ecosystem: "npm"
+ # Look for a `packages.json' in the `root` directory
+ directory: "/"
+ # Check for updates to GitHub Actions every weekday
+ schedule:
+ interval: "daily"
+
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/.github/workflows/ci.yml b/{{cookiecutter.project_slug}}/.github/workflows/ci.yml
new file mode 100644
index 000000000..0790187bd
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/.github/workflows/ci.yml
@@ -0,0 +1,103 @@
+name: CI
+
+# Enable Buildkit and let compose use it to speed up image building
+env:
+ DOCKER_BUILDKIT: 1
+ COMPOSE_DOCKER_CLI_BUILD: 1
+
+on:
+ pull_request:
+ branches: [ "master", "main" ]
+ paths-ignore: [ "docs/**" ]
+
+ push:
+ branches: [ "master", "main" ]
+ paths-ignore: [ "docs/**" ]
+
+concurrency:
+ group: {% raw %}${{ github.head_ref || github.run_id }}{% endraw %}
+ cancel-in-progress: true
+
+jobs:
+ linter:
+ runs-on: ubuntu-latest
+ steps:
+
+ - name: Checkout Code Repository
+ uses: actions/checkout@v3
+
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: "3.10"
+ cache: pip
+ cache-dependency-path: |
+ requirements/base.txt
+ requirements/local.txt
+
+ - name: Run pre-commit
+ uses: pre-commit/action@v2.0.3
+
+ # With no caching at all the entire ci process takes 4m 30s to complete!
+ pytest:
+ runs-on: ubuntu-latest
+ {%- if cookiecutter.use_docker == 'n' %}
+
+ services:
+ {%- if cookiecutter.use_celery == 'y' %}
+ redis:
+ image: redis:6
+ ports:
+ - 6379:6379
+ {%- endif %}
+ postgres:
+ image: postgres:12
+ ports:
+ - 5432:5432
+ env:
+ POSTGRES_PASSWORD: postgres
+
+ env:
+ {%- if cookiecutter.use_celery == 'y' %}
+ CELERY_BROKER_URL: "redis://localhost:6379/0"
+ {%- endif %}
+ # postgres://user:password@host:port/database
+ DATABASE_URL: "postgres://postgres:postgres@localhost:5432/postgres"
+ {%- endif %}
+
+ steps:
+
+ - name: Checkout Code Repository
+ uses: actions/checkout@v3
+ {%- if cookiecutter.use_docker == 'y' %}
+
+ - name: Build the Stack
+ run: docker-compose -f local.yml build
+
+ - name: Run DB Migrations
+ run: docker-compose -f local.yml run --rm django python manage.py migrate
+
+ - name: Run Django Tests
+ run: docker-compose -f local.yml run django pytest
+
+ - name: Tear down the Stack
+ run: docker-compose -f local.yml down
+ {%- else %}
+
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: "3.10"
+ cache: pip
+ cache-dependency-path: |
+ requirements/base.txt
+ requirements/local.txt
+
+ - name: Install Dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install -r requirements/local.txt
+
+ - name: Test with pytest
+ run: pytest
+ {%- endif %}
diff --git a/{{cookiecutter.project_slug}}/.gitignore b/{{cookiecutter.project_slug}}/.gitignore
index cb8ad8358..19bb2bc07 100644
--- a/{{cookiecutter.project_slug}}/.gitignore
+++ b/{{cookiecutter.project_slug}}/.gitignore
@@ -159,6 +159,10 @@ typings/
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
{% if cookiecutter.use_pycharm == 'y' -%}
@@ -321,28 +325,30 @@ Session.vim
# Auto-generated tag files
tags
-{% if cookiecutter.use_docker == 'n' %}
-### VirtualEnv template
-# Virtualenv
-[Bb]in
-[Ii]nclude
-[Ll]ib
-[Ll]ib64
-[Ss]cripts
-pyvenv.cfg
-pip-selfcheck.json
-.env
-{% endif %}
+# Redis dump file
+dump.rdb
### Project template
-{% if cookiecutter.use_mailhog == 'y' and cookiecutter.use_docker == 'n' %}
+{%- if cookiecutter.use_mailhog == 'y' and cookiecutter.use_docker == 'n' %}
MailHog
{%- endif %}
{{ cookiecutter.project_slug }}/media/
.pytest_cache/
-{% if cookiecutter.use_docker == 'y' %}
+{%- if cookiecutter.use_docker == 'y' %}
.ipython/
{%- endif %}
+
+{%- if cookiecutter.frontend_pipeline == 'Gulp' %}
+project.css
+project.min.css
+vendors.js
+*.min.js
+*.min.js.map
+{%- endif %}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+{{ cookiecutter.project_slug }}/static/webpack_bundles/
+webpack-stats.json
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/.gitlab-ci.yml b/{{cookiecutter.project_slug}}/.gitlab-ci.yml
index 15ff73b10..dbb65fb73 100644
--- a/{{cookiecutter.project_slug}}/.gitlab-ci.yml
+++ b/{{cookiecutter.project_slug}}/.gitlab-ci.yml
@@ -6,10 +6,14 @@ variables:
POSTGRES_USER: '{{ cookiecutter.project_slug }}'
POSTGRES_PASSWORD: ''
POSTGRES_DB: 'test_{{ cookiecutter.project_slug }}'
+ POSTGRES_HOST_AUTH_METHOD: trust
+ {% if cookiecutter.use_celery == 'y' -%}
+ CELERY_BROKER_URL: 'redis://redis:6379/0'
+ {%- endif %}
flake8:
stage: lint
- image: python:3.7-alpine
+ image: python:3.10-alpine
before_script:
- pip install -q flake8
script:
@@ -17,11 +21,25 @@ flake8:
pytest:
stage: test
- image: python:3.7
+ {% if cookiecutter.use_docker == 'y' -%}
+ image: docker/compose:1.29.2
tags:
- docker
services:
- - postgres:11
+ - docker:dind
+ before_script:
+ - docker-compose -f local.yml build
+ # Ensure celerybeat does not crash due to non-existent tables
+ - docker-compose -f local.yml run --rm django python manage.py migrate
+ - docker-compose -f local.yml up -d
+ script:
+ - docker-compose -f local.yml run django pytest
+ {%- else -%}
+ image: python:3.10
+ tags:
+ - python
+ services:
+ - postgres:{{ cookiecutter.postgresql_version }}
variables:
DATABASE_URL: pgsql://$POSTGRES_USER:$POSTGRES_PASSWORD@postgres/$POSTGRES_DB
@@ -30,4 +48,5 @@ pytest:
script:
- pytest
+ {%- endif %}
diff --git a/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_django.xml b/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_django.xml
new file mode 100644
index 000000000..e84c5ffdd
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_django.xml
@@ -0,0 +1,23 @@
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_docs.xml b/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_docs.xml
new file mode 100644
index 000000000..0f77b28df
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/.idea/runConfigurations/docker_compose_up_docs.xml
@@ -0,0 +1,16 @@
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/{{cookiecutter.project_slug}}/.idea/{{cookiecutter.project_slug}}.iml b/{{cookiecutter.project_slug}}/.idea/{{cookiecutter.project_slug}}.iml
index d408765a5..fe1aeae52 100644
--- a/{{cookiecutter.project_slug}}/.idea/{{cookiecutter.project_slug}}.iml
+++ b/{{cookiecutter.project_slug}}/.idea/{{cookiecutter.project_slug}}.iml
@@ -13,12 +13,12 @@
- {% if cookiecutter.js_task_runner != 'None' %}
-
+ {% if cookiecutter.frontend_pipeline in ['Gulp', 'Webpack'] %}
+
- {% else %}
-
+ {% else %}
+
{% endif %}
diff --git a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
index b9d69a9a1..a273bdf17 100644
--- a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
+++ b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
@@ -1,19 +1,39 @@
-exclude: 'docs|node_modules|migrations|.git|.tox'
+exclude: "^docs/|/migrations/"
default_stages: [commit]
-fail_fast: true
repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: master
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.4.0
hooks:
- id: trailing-whitespace
- files: (^|/)a/.+\.(py|html|sh|css|js)$
+ - id: end-of-file-fixer
+ - id: check-yaml
-- repo: local
+ - repo: https://github.com/asottile/pyupgrade
+ rev: v3.3.1
+ hooks:
+ - id: pyupgrade
+ args: [--py310-plus]
+
+ - repo: https://github.com/psf/black
+ rev: 22.12.0
+ hooks:
+ - id: black
+
+ - repo: https://github.com/PyCQA/isort
+ rev: 5.12.0
+ hooks:
+ - id: isort
+
+ - repo: https://github.com/PyCQA/flake8
+ rev: 6.0.0
hooks:
- id: flake8
- name: flake8
- entry: flake8
- language: python
- types: [python]
+ args: ["--config=setup.cfg"]
+ additional_dependencies: [flake8-isort]
+# sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date
+ci:
+ autoupdate_schedule: weekly
+ skip: []
+ submodules: false
diff --git a/{{cookiecutter.project_slug}}/.pylintrc b/{{cookiecutter.project_slug}}/.pylintrc
index a0955f076..9d604334b 100644
--- a/{{cookiecutter.project_slug}}/.pylintrc
+++ b/{{cookiecutter.project_slug}}/.pylintrc
@@ -1,6 +1,6 @@
[MASTER]
-load-plugins=pylint_django{% if cookiecutter.use_celery == "y" %}, pylint_celery {% endif %}
-
+load-plugins=pylint_django{% if cookiecutter.use_celery == "y" %}, pylint_celery{% endif %}
+django-settings-module=config.settings.local
[FORMAT]
max-line-length=120
diff --git a/{{cookiecutter.project_slug}}/.readthedocs.yml b/{{cookiecutter.project_slug}}/.readthedocs.yml
new file mode 100644
index 000000000..e943a5fa9
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/.readthedocs.yml
@@ -0,0 +1,12 @@
+version: 2
+
+sphinx:
+ configuration: docs/conf.py
+
+build:
+ image: testing
+
+python:
+ version: 3.10
+ install:
+ - requirements: requirements/local.txt
diff --git a/{{cookiecutter.project_slug}}/.travis.yml b/{{cookiecutter.project_slug}}/.travis.yml
index 31695e419..326d78392 100644
--- a/{{cookiecutter.project_slug}}/.travis.yml
+++ b/{{cookiecutter.project_slug}}/.travis.yml
@@ -1,17 +1,45 @@
-dist: xenial
-services:
- - postgresql
-before_install:
- - sudo apt-get update -qq
- - sudo apt-get install -qq build-essential gettext python-dev zlib1g-dev libpq-dev xvfb
- - sudo apt-get install -qq libjpeg8-dev libfreetype6-dev libwebp-dev
- - sudo apt-get install -qq graphviz-dev python-setuptools python3-dev python-virtualenv python-pip
- - sudo apt-get install -qq firefox automake libtool libreadline6 libreadline6-dev libreadline-dev
- - sudo apt-get install -qq libsqlite3-dev libxml2 libxml2-dev libssl-dev libbz2-dev wget curl llvm
+dist: focal
+
language: python
python:
- - "3.7"
-install:
- - pip install -r requirements/local.txt
-script:
- - "pytest"
+ - "3.10"
+
+services:
+ - {% if cookiecutter.use_docker == 'y' %}docker{% else %}postgresql{% endif %}
+jobs:
+ include:
+ - name: "Linter"
+ before_script:
+ - pip install -q flake8
+ script:
+ - "flake8"
+
+ - name: "Django Test"
+ {%- if cookiecutter.use_docker == 'y' %}
+ before_script:
+ - docker-compose -v
+ - docker -v
+ - docker-compose -f local.yml build
+ # Ensure celerybeat does not crash due to non-existent tables
+ - docker-compose -f local.yml run --rm django python manage.py migrate
+ - docker-compose -f local.yml up -d
+ script:
+ - "docker-compose -f local.yml run django pytest"
+ after_failure:
+ - docker-compose -f local.yml logs
+ {%- else %}
+ before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq build-essential gettext python-dev zlib1g-dev libpq-dev xvfb
+ - sudo apt-get install -qq libjpeg8-dev libfreetype6-dev libwebp-dev
+ - sudo apt-get install -qq graphviz-dev python-setuptools python3-dev python-virtualenv python-pip
+ - sudo apt-get install -qq firefox automake libtool libreadline6 libreadline6-dev libreadline-dev
+ - sudo apt-get install -qq libsqlite3-dev libxml2 libxml2-dev libssl-dev libbz2-dev wget curl llvm
+ language: python
+ python:
+ - "3.10"
+ install:
+ - pip install -r requirements/local.txt
+ script:
+ - "pytest"
+ {%- endif %}
diff --git a/{{cookiecutter.project_slug}}/LICENSE b/{{cookiecutter.project_slug}}/LICENSE
index 3a6c7e13a..812fa0fa6 100644
--- a/{{cookiecutter.project_slug}}/LICENSE
+++ b/{{cookiecutter.project_slug}}/LICENSE
@@ -7,7 +7,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-{% elif cookiecutter.open_source_license == 'BSD' %}
+{%- elif cookiecutter.open_source_license == 'BSD' %}
Copyright (c) {% now 'utc', '%Y' %}, {{ cookiecutter.author_name }}
All rights reserved.
@@ -35,7 +35,7 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
-{% elif cookiecutter.open_source_license == 'GPLv3' %}
+{%- elif cookiecutter.open_source_license == 'GPLv3' %}
Copyright (c) {% now 'utc', '%Y' %}, {{ cookiecutter.author_name }}
This program is free software: you can redistribute it and/or modify
@@ -50,4 +50,196 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
-{% endif %}
+{%- elif cookiecutter.open_source_license == 'Apache Software License 2.0' %}
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ Copyright {% now 'utc', '%Y' %} {{ cookiecutter.author_name }}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/Procfile b/{{cookiecutter.project_slug}}/Procfile
index 5b8e9eaf8..2f2fbe927 100644
--- a/{{cookiecutter.project_slug}}/Procfile
+++ b/{{cookiecutter.project_slug}}/Procfile
@@ -1,5 +1,10 @@
release: python manage.py migrate
+{%- if cookiecutter.use_async == "y" %}
+web: gunicorn config.asgi:application -k uvicorn.workers.UvicornWorker
+{%- else %}
web: gunicorn config.wsgi:application
-{% if cookiecutter.use_celery == "y" -%}
-worker: celery worker --app=config.celery_app --loglevel=info
+{%- endif %}
+{%- if cookiecutter.use_celery == "y" %}
+worker: REMAP_SIGTERM=SIGQUIT celery -A config.celery_app worker --loglevel=info
+beat: REMAP_SIGTERM=SIGQUIT celery -A config.celery_app beat --loglevel=info
{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md
new file mode 100644
index 000000000..16ee6d1fe
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/README.md
@@ -0,0 +1,141 @@
+# {{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 a **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](https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html#sass-compilation-live-reloading).
+
+{%- 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 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 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.frontend_pipeline in ['Gulp', 'Webpack'] %}
+
+### Custom Bootstrap Compilation
+
+The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
+Bootstrap v5 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/v5.1.3/scss/_variables.scss), or get explanations on them in the [Bootstrap docs](https://getbootstrap.com/docs/5.1/customize/sass/).
+
+Bootstrap's javascript as well as its dependencies are concatenated into a single file: `static/js/vendors.js`.
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst
deleted file mode 100644
index 1deeafbec..000000000
--- a/{{cookiecutter.project_slug}}/README.rst
+++ /dev/null
@@ -1,173 +0,0 @@
-{{cookiecutter.project_name}}
-{{ '=' * cookiecutter.project_name|length }}
-
-{{cookiecutter.description}}
-
-.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg
- :target: https://github.com/pydanny/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 ``_ 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 %}
diff --git a/{{cookiecutter.project_slug}}/bin/post_compile b/{{cookiecutter.project_slug}}/bin/post_compile
new file mode 100644
index 000000000..a9c94b39a
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/bin/post_compile
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+compress_enabled() {
+python << END
+import sys
+
+from environ import Env
+
+env = Env(COMPRESS_ENABLED=(bool, True))
+if env('COMPRESS_ENABLED'):
+ sys.exit(0)
+else:
+ sys.exit(1)
+
+END
+}
+
+if compress_enabled
+then
+ python manage.py compress
+fi
+python manage.py collectstatic --noinput
diff --git a/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile b/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile
index 94c799520..3ea6b2d4c 100644
--- a/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile
+++ b/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile
@@ -1,21 +1,57 @@
-FROM python:3.7-slim-buster
+ARG PYTHON_VERSION=3.10-slim-bullseye
+
+# define an alias for the specfic python version used in this file.
+FROM python:${PYTHON_VERSION} as python
+
+# Python build stage
+FROM python as python-build-stage
+
+ARG BUILD_ENVIRONMENT=local
+
+# Install apt packages
+RUN apt-get update && apt-get install --no-install-recommends -y \
+ # dependencies for building Python packages
+ build-essential \
+ # psycopg2 dependencies
+ libpq-dev
+
+# Requirements are installed here to ensure they will be cached.
+COPY ./requirements .
+
+# Create Python Dependency and Sub-Dependency Wheels.
+RUN pip wheel --wheel-dir /usr/src/app/wheels \
+ -r ${BUILD_ENVIRONMENT}.txt
+
+
+# Python 'run' stage
+FROM python as python-run-stage
+
+ARG BUILD_ENVIRONMENT=local
+ARG APP_HOME=/app
ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV BUILD_ENV ${BUILD_ENVIRONMENT}
-RUN apt-get update \
- # dependencies for building Python packages
- && apt-get install -y build-essential \
+WORKDIR ${APP_HOME}
+
+# Install required system dependencies
+RUN apt-get update && apt-get install --no-install-recommends -y \
# psycopg2 dependencies
- && apt-get install -y libpq-dev \
+ libpq-dev \
# Translations dependencies
- && apt-get install -y gettext \
+ gettext \
# cleaning up unused files
&& apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
&& rm -rf /var/lib/apt/lists/*
-# Requirements are installed here to ensure they will be cached.
-COPY ./requirements /requirements
-RUN pip install -r /requirements/local.txt
+# All absolute dir copies ignore workdir instruction. All relative dir copies are wrt to the workdir instruction
+# copy python dependency wheels from python-build-stage
+COPY --from=python-build-stage /usr/src/app/wheels /wheels/
+
+# use wheels to install python dependencies
+RUN pip install --no-cache-dir --no-index --find-links=/wheels/ /wheels/* \
+ && rm -rf /wheels/
COPY ./compose/production/django/entrypoint /entrypoint
RUN sed -i 's/\r$//g' /entrypoint
@@ -24,6 +60,7 @@ RUN chmod +x /entrypoint
COPY ./compose/local/django/start /start
RUN sed -i 's/\r$//g' /start
RUN chmod +x /start
+
{% if cookiecutter.use_celery == "y" %}
COPY ./compose/local/django/celery/worker/start /start-celeryworker
RUN sed -i 's/\r$//g' /start-celeryworker
@@ -37,6 +74,8 @@ COPY ./compose/local/django/celery/flower/start /start-flower
RUN sed -i 's/\r$//g' /start-flower
RUN chmod +x /start-flower
{% endif %}
-WORKDIR /app
+
+# copy application code to WORKDIR
+COPY . ${APP_HOME}
ENTRYPOINT ["/entrypoint"]
diff --git a/{{cookiecutter.project_slug}}/compose/local/django/celery/beat/start b/{{cookiecutter.project_slug}}/compose/local/django/celery/beat/start
index c04a7365e..61f83968b 100644
--- a/{{cookiecutter.project_slug}}/compose/local/django/celery/beat/start
+++ b/{{cookiecutter.project_slug}}/compose/local/django/celery/beat/start
@@ -5,4 +5,4 @@ set -o nounset
rm -f './celerybeat.pid'
-celery -A config.celery_app beat -l INFO
+exec watchfiles celery.__main__.main --args '-A config.celery_app beat -l INFO'
diff --git a/{{cookiecutter.project_slug}}/compose/local/django/celery/flower/start b/{{cookiecutter.project_slug}}/compose/local/django/celery/flower/start
index 5bcaa8164..ac3cc6b36 100644
--- a/{{cookiecutter.project_slug}}/compose/local/django/celery/flower/start
+++ b/{{cookiecutter.project_slug}}/compose/local/django/celery/flower/start
@@ -3,8 +3,6 @@
set -o errexit
set -o nounset
-
-celery flower \
- --app=config.celery_app \
- --broker="${CELERY_BROKER_URL}" \
- --basic_auth="${CELERY_FLOWER_USER}:${CELERY_FLOWER_PASSWORD}"
+exec watchfiles celery.__main__.main \
+ --args \
+ "-A config.celery_app -b \"${CELERY_BROKER_URL}\" flower --basic_auth=\"${CELERY_FLOWER_USER}:${CELERY_FLOWER_PASSWORD}\""
diff --git a/{{cookiecutter.project_slug}}/compose/local/django/celery/worker/start b/{{cookiecutter.project_slug}}/compose/local/django/celery/worker/start
index acd6f1574..16341fdd1 100644
--- a/{{cookiecutter.project_slug}}/compose/local/django/celery/worker/start
+++ b/{{cookiecutter.project_slug}}/compose/local/django/celery/worker/start
@@ -4,4 +4,4 @@ set -o errexit
set -o nounset
-celery -A config.celery_app worker -l INFO
+exec watchfiles celery.__main__.main --args '-A config.celery_app worker -l INFO'
diff --git a/{{cookiecutter.project_slug}}/compose/local/django/start b/{{cookiecutter.project_slug}}/compose/local/django/start
index f076ee51e..ec57dc8e4 100644
--- a/{{cookiecutter.project_slug}}/compose/local/django/start
+++ b/{{cookiecutter.project_slug}}/compose/local/django/start
@@ -6,4 +6,8 @@ set -o nounset
python manage.py migrate
-python manage.py runserver_plus 0.0.0.0:8000
+{%- if cookiecutter.use_async == 'y' %}
+exec uvicorn config.asgi:application --host 0.0.0.0 --reload --reload-include '*.html'
+{%- else %}
+exec python manage.py runserver_plus 0.0.0.0:8000
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/compose/local/docs/Dockerfile b/{{cookiecutter.project_slug}}/compose/local/docs/Dockerfile
new file mode 100644
index 000000000..c45d18c95
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/compose/local/docs/Dockerfile
@@ -0,0 +1,64 @@
+ARG PYTHON_VERSION=3.10-slim-bullseye
+
+# define an alias for the specfic python version used in this file.
+FROM python:${PYTHON_VERSION} as python
+
+
+# Python build stage
+FROM python as python-build-stage
+
+ENV PYTHONDONTWRITEBYTECODE 1
+
+RUN apt-get update && apt-get install --no-install-recommends -y \
+ # dependencies for building Python packages
+ build-essential \
+ # psycopg2 dependencies
+ libpq-dev \
+ # cleaning up unused files
+ && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+ && rm -rf /var/lib/apt/lists/*
+
+# Requirements are installed here to ensure they will be cached.
+COPY ./requirements /requirements
+
+# create python dependency wheels
+RUN pip wheel --no-cache-dir --wheel-dir /usr/src/app/wheels \
+ -r /requirements/local.txt -r /requirements/production.txt \
+ && rm -rf /requirements
+
+
+# Python 'run' stage
+FROM python as python-run-stage
+
+ARG BUILD_ENVIRONMENT
+ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+
+RUN apt-get update && apt-get install --no-install-recommends -y \
+ # To run the Makefile
+ make \
+ # psycopg2 dependencies
+ libpq-dev \
+ # Translations dependencies
+ gettext \
+ # Uncomment below lines to enable Sphinx output to latex and pdf
+ # texlive-latex-recommended \
+ # texlive-fonts-recommended \
+ # texlive-latex-extra \
+ # latexmk \
+ # cleaning up unused files
+ && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+ && rm -rf /var/lib/apt/lists/*
+
+# copy python dependency wheels from python-build-stage
+COPY --from=python-build-stage /usr/src/app/wheels /wheels
+
+# use wheels to install python dependencies
+RUN pip install --no-cache /wheels/* \
+ && rm -rf /wheels
+
+COPY ./compose/local/docs/start /start-docs
+RUN sed -i 's/\r$//g' /start-docs
+RUN chmod +x /start-docs
+
+WORKDIR /docs
diff --git a/{{cookiecutter.project_slug}}/compose/local/docs/start b/{{cookiecutter.project_slug}}/compose/local/docs/start
new file mode 100644
index 000000000..96a94f566
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/compose/local/docs/start
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+exec make livehtml
diff --git a/{{cookiecutter.project_slug}}/compose/local/node/Dockerfile b/{{cookiecutter.project_slug}}/compose/local/node/Dockerfile
index f9976e206..8062fa689 100644
--- a/{{cookiecutter.project_slug}}/compose/local/node/Dockerfile
+++ b/{{cookiecutter.project_slug}}/compose/local/node/Dockerfile
@@ -1,4 +1,4 @@
-FROM node:10-stretch-slim
+FROM node:16-bullseye-slim
WORKDIR /app
diff --git a/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/download b/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/download
index 8d5ea091f..0c515935f 100644
--- a/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/download
+++ b/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/download
@@ -21,4 +21,3 @@ export AWS_STORAGE_BUCKET_NAME="${DJANGO_AWS_STORAGE_BUCKET_NAME}"
aws s3 cp s3://${AWS_STORAGE_BUCKET_NAME}${BACKUP_DIR_PATH}/${1} ${BACKUP_DIR_PATH}/${1}
message_success "Finished downloading ${1}."
-
diff --git a/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/upload b/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/upload
index 4a89dcb5a..9446b9304 100644
--- a/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/upload
+++ b/{{cookiecutter.project_slug}}/compose/production/aws/maintenance/upload
@@ -27,4 +27,3 @@ message_info "Cleaning the directory ${BACKUP_DIR_PATH}"
rm -rf ${BACKUP_DIR_PATH}/*
message_success "Finished uploading and cleaning."
-
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile b/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile
index 42ecbeafc..ef80441ba 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile
+++ b/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile
@@ -1,71 +1,127 @@
-{% if cookiecutter.js_task_runner == 'Gulp' -%}
-FROM node:10-stretch-slim as client-builder
+ARG PYTHON_VERSION=3.10-slim-bullseye
-WORKDIR /app
-COPY ./package.json /app
+{% if cookiecutter.frontend_pipeline in ['Gulp', 'Webpack'] -%}
+FROM node:16-bullseye-slim as client-builder
+
+ARG APP_HOME=/app
+WORKDIR ${APP_HOME}
+
+COPY ./package.json ${APP_HOME}
RUN npm install && npm cache clean --force
-COPY . /app
+COPY . ${APP_HOME}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' and cookiecutter.use_whitenoise == 'n' %}
+{%- if cookiecutter.cloud_provider == 'AWS' %}
+ARG DJANGO_AWS_STORAGE_BUCKET_NAME
+ENV DJANGO_AWS_STORAGE_BUCKET_NAME=${DJANGO_AWS_STORAGE_BUCKET_NAME}
+ARG DJANGO_AWS_S3_CUSTOM_DOMAIN
+ENV DJANGO_AWS_S3_CUSTOM_DOMAIN=${DJANGO_AWS_S3_CUSTOM_DOMAIN}
+{%- elif cookiecutter.cloud_provider == 'GCP' %}
+ARG DJANGO_GCP_STORAGE_BUCKET_NAME
+ENV DJANGO_GCP_STORAGE_BUCKET_NAME=${DJANGO_GCP_STORAGE_BUCKET_NAME}
+{%- elif cookiecutter.cloud_provider == 'Azure' %}
+ARG DJANGO_AZURE_ACCOUNT_NAME
+ENV DJANGO_AZURE_ACCOUNT_NAME=${DJANGO_AZURE_ACCOUNT_NAME}
+{%- endif %}
+{%- endif %}
RUN npm run build
-# Python build stage
{%- endif %}
-FROM python:3.7-slim-buster
+
+# define an alias for the specfic python version used in this file.
+FROM python:${PYTHON_VERSION} as python
+
+# Python build stage
+FROM python as python-build-stage
+
+ARG BUILD_ENVIRONMENT=production
+
+# Install apt packages
+RUN apt-get update && apt-get install --no-install-recommends -y \
+ # dependencies for building Python packages
+ build-essential \
+ # psycopg2 dependencies
+ libpq-dev
+
+# Requirements are installed here to ensure they will be cached.
+COPY ./requirements .
+
+# Create Python Dependency and Sub-Dependency Wheels.
+RUN pip wheel --wheel-dir /usr/src/app/wheels \
+ -r ${BUILD_ENVIRONMENT}.txt
+
+
+# Python 'run' stage
+FROM python as python-run-stage
+
+ARG BUILD_ENVIRONMENT=production
+ARG APP_HOME=/app
ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV BUILD_ENV ${BUILD_ENVIRONMENT}
-RUN apt-get update \
- # dependencies for building Python packages
- && apt-get install -y build-essential \
- # psycopg2 dependencies
- && apt-get install -y libpq-dev \
- # Translations dependencies
- && apt-get install -y gettext \
- # cleaning up unused files
- && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
- && rm -rf /var/lib/apt/lists/*
+WORKDIR ${APP_HOME}
RUN addgroup --system django \
&& adduser --system --ingroup django django
-# Requirements are installed here to ensure they will be cached.
-COPY ./requirements /requirements
-RUN pip install --no-cache-dir -r /requirements/production.txt \
- && rm -rf /requirements
-COPY ./compose/production/django/entrypoint /entrypoint
+# Install required system dependencies
+RUN apt-get update && apt-get install --no-install-recommends -y \
+ # psycopg2 dependencies
+ libpq-dev \
+ # Translations dependencies
+ gettext \
+ # cleaning up unused files
+ && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+ && rm -rf /var/lib/apt/lists/*
+
+# All absolute dir copies ignore workdir instruction. All relative dir copies are wrt to the workdir instruction
+# copy python dependency wheels from python-build-stage
+COPY --from=python-build-stage /usr/src/app/wheels /wheels/
+
+# use wheels to install python dependencies
+RUN pip install --no-cache-dir --no-index --find-links=/wheels/ /wheels/* \
+ && rm -rf /wheels/
+
+
+COPY --chown=django:django ./compose/production/django/entrypoint /entrypoint
RUN sed -i 's/\r$//g' /entrypoint
RUN chmod +x /entrypoint
-RUN chown django /entrypoint
-COPY ./compose/production/django/start /start
+
+COPY --chown=django:django ./compose/production/django/start /start
RUN sed -i 's/\r$//g' /start
RUN chmod +x /start
-RUN chown django /start
+
{%- if cookiecutter.use_celery == "y" %}
-COPY ./compose/production/django/celery/worker/start /start-celeryworker
+COPY --chown=django:django ./compose/production/django/celery/worker/start /start-celeryworker
RUN sed -i 's/\r$//g' /start-celeryworker
RUN chmod +x /start-celeryworker
-RUN chown django /start-celeryworker
-COPY ./compose/production/django/celery/beat/start /start-celerybeat
+
+COPY --chown=django:django ./compose/production/django/celery/beat/start /start-celerybeat
RUN sed -i 's/\r$//g' /start-celerybeat
RUN chmod +x /start-celerybeat
-RUN chown django /start-celerybeat
+
COPY ./compose/production/django/celery/flower/start /start-flower
RUN sed -i 's/\r$//g' /start-flower
RUN chmod +x /start-flower
{%- endif %}
-{%- if cookiecutter.js_task_runner == 'Gulp' %}
-COPY --from=client-builder --chown=django:django /app /app
+
+# copy application code to WORKDIR
+{%- if cookiecutter.frontend_pipeline in ['Gulp', 'Webpack'] %}
+COPY --from=client-builder --chown=django:django ${APP_HOME} ${APP_HOME}
{% else %}
-COPY --chown=django:django . /app
+COPY --chown=django:django . ${APP_HOME}
{%- endif %}
+# make django owner of the WORKDIR directory as well.
+RUN chown django:django ${APP_HOME}
+
USER django
-WORKDIR /app
-
ENTRYPOINT ["/entrypoint"]
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/celery/beat/start b/{{cookiecutter.project_slug}}/compose/production/django/celery/beat/start
index 20b93123a..42ddca910 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/celery/beat/start
+++ b/{{cookiecutter.project_slug}}/compose/production/django/celery/beat/start
@@ -5,4 +5,4 @@ set -o pipefail
set -o nounset
-celery -A config.celery_app beat -l INFO
+exec celery -A config.celery_app beat -l INFO
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/celery/flower/start b/{{cookiecutter.project_slug}}/compose/production/django/celery/flower/start
index 5bcaa8164..4180d6778 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/celery/flower/start
+++ b/{{cookiecutter.project_slug}}/compose/production/django/celery/flower/start
@@ -4,7 +4,8 @@ set -o errexit
set -o nounset
-celery flower \
- --app=config.celery_app \
- --broker="${CELERY_BROKER_URL}" \
+exec celery \
+ -A config.celery_app \
+ -b "${CELERY_BROKER_URL}" \
+ flower \
--basic_auth="${CELERY_FLOWER_USER}:${CELERY_FLOWER_PASSWORD}"
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/celery/worker/start b/{{cookiecutter.project_slug}}/compose/production/django/celery/worker/start
index 38fb77f35..af0c8f7b5 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/celery/worker/start
+++ b/{{cookiecutter.project_slug}}/compose/production/django/celery/worker/start
@@ -5,4 +5,4 @@ set -o pipefail
set -o nounset
-celery -A config.celery_app worker -l INFO
+exec celery -A config.celery_app worker -l INFO
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/entrypoint b/{{cookiecutter.project_slug}}/compose/production/django/entrypoint
index 95ab8297a..2fbcad955 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/entrypoint
+++ b/{{cookiecutter.project_slug}}/compose/production/django/entrypoint
@@ -16,30 +16,34 @@ if [ -z "${POSTGRES_USER}" ]; then
fi
export DATABASE_URL="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}"
-postgres_ready() {
python << END
import sys
+import time
import psycopg2
-try:
- psycopg2.connect(
- dbname="${POSTGRES_DB}",
- user="${POSTGRES_USER}",
- password="${POSTGRES_PASSWORD}",
- host="${POSTGRES_HOST}",
- port="${POSTGRES_PORT}",
- )
-except psycopg2.OperationalError:
- sys.exit(-1)
-sys.exit(0)
+suggest_unrecoverable_after = 30
+start = time.time()
+while True:
+ try:
+ psycopg2.connect(
+ dbname="${POSTGRES_DB}",
+ user="${POSTGRES_USER}",
+ password="${POSTGRES_PASSWORD}",
+ host="${POSTGRES_HOST}",
+ port="${POSTGRES_PORT}",
+ )
+ break
+ except psycopg2.OperationalError as error:
+ sys.stderr.write("Waiting for PostgreSQL to become available...\n")
+
+ if time.time() - start > suggest_unrecoverable_after:
+ sys.stderr.write(" This is taking longer than expected. The following exception may be indicative of an unrecoverable error: '{}'\n".format(error))
+
+ time.sleep(1)
END
-}
-until postgres_ready; do
- >&2 echo 'Waiting for PostgreSQL to become available...'
- sleep 1
-done
+
>&2 echo 'PostgreSQL is available'
exec "$@"
diff --git a/{{cookiecutter.project_slug}}/compose/production/django/start b/{{cookiecutter.project_slug}}/compose/production/django/start
index 709c1dd04..73f686bd7 100644
--- a/{{cookiecutter.project_slug}}/compose/production/django/start
+++ b/{{cookiecutter.project_slug}}/compose/production/django/start
@@ -6,4 +6,29 @@ set -o nounset
python /app/manage.py collectstatic --noinput
-/usr/local/bin/gunicorn config.wsgi --bind 0.0.0.0:5000 --chdir=/app
+{% if cookiecutter.use_whitenoise == 'y' and cookiecutter.frontend_pipeline == 'Django Compressor' %}
+compress_enabled() {
+python << END
+import sys
+
+from environ import Env
+
+env = Env(COMPRESS_ENABLED=(bool, True))
+if env('COMPRESS_ENABLED'):
+ sys.exit(0)
+else:
+ sys.exit(1)
+
+END
+}
+
+if compress_enabled; then
+ # NOTE this command will fail if django-compressor is disabled
+ python /app/manage.py compress
+fi
+{%- endif %}
+{%- if cookiecutter.use_async == 'y' %}
+exec /usr/local/bin/gunicorn config.asgi --bind 0.0.0.0:5000 --chdir=/app -k uvicorn.workers.UvicornWorker
+{%- else %}
+exec /usr/local/bin/gunicorn config.wsgi --bind 0.0.0.0:5000 --chdir=/app
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/compose/production/traefik/Dockerfile b/{{cookiecutter.project_slug}}/compose/production/traefik/Dockerfile
index 746aa2b48..aa879052b 100644
--- a/{{cookiecutter.project_slug}}/compose/production/traefik/Dockerfile
+++ b/{{cookiecutter.project_slug}}/compose/production/traefik/Dockerfile
@@ -1,5 +1,5 @@
-FROM traefik:v2.0
-RUN mkdir -p /etc/traefik/acme
-RUN touch /etc/traefik/acme/acme.json
-RUN chmod 600 /etc/traefik/acme/acme.json
+FROM traefik:v2.2.11
+RUN mkdir -p /etc/traefik/acme \
+ && touch /etc/traefik/acme/acme.json \
+ && chmod 600 /etc/traefik/acme/acme.json
COPY ./compose/production/traefik/traefik.yml /etc/traefik
diff --git a/{{cookiecutter.project_slug}}/compose/production/traefik/traefik.yml b/{{cookiecutter.project_slug}}/compose/production/traefik/traefik.yml
index 4e22a7d62..38e132446 100644
--- a/{{cookiecutter.project_slug}}/compose/production/traefik/traefik.yml
+++ b/{{cookiecutter.project_slug}}/compose/production/traefik/traefik.yml
@@ -5,10 +5,20 @@ entryPoints:
web:
# http
address: ":80"
+ http:
+ # https://docs.traefik.io/routing/entrypoints/#entrypoint
+ redirections:
+ entryPoint:
+ to: web-secure
web-secure:
# https
address: ":443"
+ {%- if cookiecutter.use_celery == 'y' %}
+
+ flower:
+ address: ":5555"
+ {%- endif %}
certificatesResolvers:
letsencrypt:
@@ -22,17 +32,12 @@ certificatesResolvers:
http:
routers:
- web-router:
- rule: "Host(`{{ cookiecutter.domain_name }}`)"
- entryPoints:
- - web
- middlewares:
- - redirect
- - csrf
- service: django
-
web-secure-router:
+ {%- if cookiecutter.domain_name.count('.') == 1 %}
+ rule: "Host(`{{ cookiecutter.domain_name }}`) || Host(`www.{{ cookiecutter.domain_name }}`)"
+ {%- else %}
rule: "Host(`{{ cookiecutter.domain_name }}`)"
+ {%- endif %}
entryPoints:
- web-secure
middlewares:
@@ -41,6 +46,17 @@ http:
tls:
# https://docs.traefik.io/master/routing/routers/#certresolver
certResolver: letsencrypt
+ {%- if cookiecutter.use_celery == 'y' %}
+
+ flower-secure-router:
+ rule: "Host(`{{ cookiecutter.domain_name }}`)"
+ entryPoints:
+ - flower
+ service: flower
+ tls:
+ # https://docs.traefik.io/master/routing/routers/#certresolver
+ certResolver: letsencrypt
+ {%- endif %}
{%- if cookiecutter.cloud_provider == 'nginx' %}
web-media-router:
@@ -55,22 +71,24 @@ http:
{%- endif %}
middlewares:
- redirect:
- # https://docs.traefik.io/master/middlewares/redirectscheme/
- redirectScheme:
- scheme: https
- permanent: true
csrf:
# https://docs.traefik.io/master/middlewares/headers/#hostsproxyheaders
# https://docs.djangoproject.com/en/dev/ref/csrf/#ajax
headers:
- hostsProxyHeaders: ['X-CSRFToken']
+ hostsProxyHeaders: ["X-CSRFToken"]
services:
django:
loadBalancer:
servers:
- url: http://django:5000
+ {%- if cookiecutter.use_celery == 'y' %}
+
+ flower:
+ loadBalancer:
+ servers:
+ - url: http://flower:5555
+ {%- endif %}
{%- if cookiecutter.cloud_provider == 'nginx' %}
django-media:
loadBalancer:
diff --git a/{{cookiecutter.project_slug}}/config/api_router.py b/{{cookiecutter.project_slug}}/config/api_router.py
index 46a797a74..743069b2c 100644
--- a/{{cookiecutter.project_slug}}/config/api_router.py
+++ b/{{cookiecutter.project_slug}}/config/api_router.py
@@ -1,5 +1,6 @@
-from rest_framework.routers import DefaultRouter, SimpleRouter
from django.conf import settings
+from rest_framework.routers import DefaultRouter, SimpleRouter
+
from {{ cookiecutter.project_slug }}.users.api.views import UserViewSet
if settings.DEBUG:
diff --git a/{{cookiecutter.project_slug}}/config/asgi.py b/{{cookiecutter.project_slug}}/config/asgi.py
new file mode 100644
index 000000000..65e76ca0a
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/config/asgi.py
@@ -0,0 +1,40 @@
+"""
+ASGI config for {{ cookiecutter.project_name }} project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/dev/howto/deployment/asgi/
+
+"""
+import os
+import sys
+from pathlib import Path
+
+from django.core.asgi import get_asgi_application
+
+# This allows easy placement of apps within the interior
+# {{ cookiecutter.project_slug }} directory.
+BASE_DIR = Path(__file__).resolve(strict=True).parent.parent
+sys.path.append(str(BASE_DIR / "{{ cookiecutter.project_slug }}"))
+
+# If DJANGO_SETTINGS_MODULE is unset, default to the local settings
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
+
+# This application object is used by any ASGI server configured to use this file.
+django_application = get_asgi_application()
+# Apply ASGI middleware here.
+# from helloworld.asgi import HelloWorldApplication
+# application = HelloWorldApplication(application)
+
+# Import websocket application here, so apps from django_application are loaded first
+from config.websocket import websocket_application # noqa isort:skip
+
+
+async def application(scope, receive, send):
+ if scope["type"] == "http":
+ await django_application(scope, receive, send)
+ elif scope["type"] == "websocket":
+ await websocket_application(scope, receive, send)
+ else:
+ raise NotImplementedError(f"Unknown scope type {scope['type']}")
diff --git a/{{cookiecutter.project_slug}}/config/celery_app.py b/{{cookiecutter.project_slug}}/config/celery_app.py
index e275f054f..0728a649e 100644
--- a/{{cookiecutter.project_slug}}/config/celery_app.py
+++ b/{{cookiecutter.project_slug}}/config/celery_app.py
@@ -1,4 +1,5 @@
import os
+
from celery import Celery
# set the default Django settings module for the 'celery' program.
diff --git a/{{cookiecutter.project_slug}}/config/settings/base.py b/{{cookiecutter.project_slug}}/config/settings/base.py
index 6ad8e820b..cc77b864a 100644
--- a/{{cookiecutter.project_slug}}/config/settings/base.py
+++ b/{{cookiecutter.project_slug}}/config/settings/base.py
@@ -1,20 +1,19 @@
"""
Base settings to build other settings files upon.
"""
+from pathlib import Path
import environ
-ROOT_DIR = (
- environ.Path(__file__) - 3
-) # ({{ cookiecutter.project_slug }}/config/settings/base.py - 3 = {{ cookiecutter.project_slug }}/)
-APPS_DIR = ROOT_DIR.path("{{ cookiecutter.project_slug }}")
-
+BASE_DIR = Path(__file__).resolve(strict=True).parent.parent.parent
+# {{ cookiecutter.project_slug }}/
+APPS_DIR = BASE_DIR / "{{ cookiecutter.project_slug }}"
env = environ.Env()
READ_DOT_ENV_FILE = env.bool("DJANGO_READ_DOT_ENV_FILE", default=False)
if READ_DOT_ENV_FILE:
# OS environment variables take precedence over variables from .env
- env.read_env(str(ROOT_DIR.path(".env")))
+ env.read_env(str(BASE_DIR / ".env"))
# GENERAL
# ------------------------------------------------------------------------------
@@ -31,12 +30,10 @@ LANGUAGE_CODE = "en-us"
SITE_ID = 1
# https://docs.djangoproject.com/en/dev/ref/settings/#use-i18n
USE_I18N = True
-# https://docs.djangoproject.com/en/dev/ref/settings/#use-l10n
-USE_L10N = True
# https://docs.djangoproject.com/en/dev/ref/settings/#use-tz
USE_TZ = True
# https://docs.djangoproject.com/en/dev/ref/settings/#locale-paths
-LOCALE_PATHS = [ROOT_DIR.path("locale")]
+LOCALE_PATHS = [str(BASE_DIR / "locale")]
# DATABASES
# ------------------------------------------------------------------------------
@@ -45,10 +42,15 @@ LOCALE_PATHS = [ROOT_DIR.path("locale")]
DATABASES = {"default": env.db("DATABASE_URL")}
{%- else %}
DATABASES = {
- "default": env.db("DATABASE_URL", default="postgres://{% if cookiecutter.windows == 'y' %}localhost{% endif %}/{{cookiecutter.project_slug}}")
+ "default": env.db(
+ "DATABASE_URL",
+ default="postgres://{% if cookiecutter.windows == 'y' %}localhost{% endif %}/{{cookiecutter.project_slug}}",
+ ),
}
{%- endif %}
DATABASES["default"]["ATOMIC_REQUESTS"] = True
+# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-DEFAULT_AUTO_FIELD
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
# URLS
# ------------------------------------------------------------------------------
@@ -72,17 +74,26 @@ DJANGO_APPS = [
]
THIRD_PARTY_APPS = [
"crispy_forms",
+ "crispy_bootstrap5",
"allauth",
"allauth.account",
"allauth.socialaccount",
- "rest_framework",
{%- if cookiecutter.use_celery == 'y' %}
"django_celery_beat",
{%- endif %}
+{%- if cookiecutter.use_drf == "y" %}
+ "rest_framework",
+ "rest_framework.authtoken",
+ "corsheaders",
+ "drf_spectacular",
+{%- endif %}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+ "webpack_loader",
+{%- endif %}
]
LOCAL_APPS = [
- "{{ cookiecutter.project_slug }}.users.apps.UsersConfig",
+ "{{ cookiecutter.project_slug }}.users",
# Your stuff: custom apps go here
]
# https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
@@ -132,6 +143,9 @@ AUTH_PASSWORD_VALIDATORS = [
# https://docs.djangoproject.com/en/dev/ref/settings/#middleware
MIDDLEWARE = [
"django.middleware.security.SecurityMiddleware",
+{%- if cookiecutter.use_drf == 'y' %}
+ "corsheaders.middleware.CorsMiddleware",
+{%- endif %}
{%- if cookiecutter.use_whitenoise == 'y' %}
"whitenoise.middleware.WhiteNoiseMiddleware",
{%- endif %}
@@ -141,18 +155,17 @@ MIDDLEWARE = [
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
- "django.middleware.common.BrokenLinkEmailsMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
]
# STATIC
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#static-root
-STATIC_ROOT = str(ROOT_DIR("staticfiles"))
+STATIC_ROOT = str(BASE_DIR / "staticfiles")
# https://docs.djangoproject.com/en/dev/ref/settings/#static-url
STATIC_URL = "/static/"
# https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#std:setting-STATICFILES_DIRS
-STATICFILES_DIRS = [str(APPS_DIR.path("static"))]
+STATICFILES_DIRS = [str(APPS_DIR / "static")]
# https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#staticfiles-finders
STATICFILES_FINDERS = [
"django.contrib.staticfiles.finders.FileSystemFinder",
@@ -162,7 +175,7 @@ STATICFILES_FINDERS = [
# MEDIA
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#media-root
-MEDIA_ROOT = str(APPS_DIR("media"))
+MEDIA_ROOT = str(APPS_DIR / "media")
# https://docs.djangoproject.com/en/dev/ref/settings/#media-url
MEDIA_URL = "/media/"
@@ -173,15 +186,11 @@ TEMPLATES = [
{
# https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-TEMPLATES-BACKEND
"BACKEND": "django.template.backends.django.DjangoTemplates",
- # https://docs.djangoproject.com/en/dev/ref/settings/#template-dirs
- "DIRS": [str(APPS_DIR.path("templates"))],
+ # https://docs.djangoproject.com/en/dev/ref/settings/#dirs
+ "DIRS": [str(APPS_DIR / "templates")],
+ # https://docs.djangoproject.com/en/dev/ref/settings/#app-dirs
+ "APP_DIRS": True,
"OPTIONS": {
- # https://docs.djangoproject.com/en/dev/ref/settings/#template-loaders
- # https://docs.djangoproject.com/en/dev/ref/templates/api/#loader-types
- "loaders": [
- "django.template.loaders.filesystem.Loader",
- "django.template.loaders.app_directories.Loader",
- ],
# https://docs.djangoproject.com/en/dev/ref/settings/#template-context-processors
"context_processors": [
"django.template.context_processors.debug",
@@ -192,7 +201,7 @@ TEMPLATES = [
"django.template.context_processors.static",
"django.template.context_processors.tz",
"django.contrib.messages.context_processors.messages",
- "{{ cookiecutter.project_slug }}.utils.context_processors.settings_context",
+ "{{cookiecutter.project_slug}}.users.context_processors.allauth_settings",
],
},
}
@@ -202,12 +211,13 @@ TEMPLATES = [
FORM_RENDERER = "django.forms.renderers.TemplatesSetting"
# http://django-crispy-forms.readthedocs.io/en/latest/install.html#template-packs
-CRISPY_TEMPLATE_PACK = "bootstrap4"
+CRISPY_TEMPLATE_PACK = "bootstrap5"
+CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
# FIXTURES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#fixture-dirs
-FIXTURE_DIRS = (str(APPS_DIR.path("fixtures")),)
+FIXTURE_DIRS = (str(APPS_DIR / "fixtures"),)
# SECURITY
# ------------------------------------------------------------------------------
@@ -224,9 +234,10 @@ X_FRAME_OPTIONS = "DENY"
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#email-backend
EMAIL_BACKEND = env(
- "DJANGO_EMAIL_BACKEND", default="django.core.mail.backends.smtp.EmailBackend"
+ "DJANGO_EMAIL_BACKEND",
+ default="django.core.mail.backends.smtp.EmailBackend",
)
-# https://docs.djangoproject.com/en/2.2/ref/settings/#email-timeout
+# https://docs.djangoproject.com/en/dev/ref/settings/#email-timeout
EMAIL_TIMEOUT = 5
# ADMIN
@@ -266,26 +277,37 @@ LOGGING = {
# Celery
# ------------------------------------------------------------------------------
if USE_TZ:
- # http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-timezone
+ # https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-timezone
CELERY_TIMEZONE = TIME_ZONE
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-broker_url
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-broker_url
CELERY_BROKER_URL = env("CELERY_BROKER_URL")
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-result_backend
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-result_backend
CELERY_RESULT_BACKEND = CELERY_BROKER_URL
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-accept_content
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-extended
+CELERY_RESULT_EXTENDED = True
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-backend-always-retry
+# https://github.com/celery/celery/pull/6122
+CELERY_RESULT_BACKEND_ALWAYS_RETRY = True
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#result-backend-max-retries
+CELERY_RESULT_BACKEND_MAX_RETRIES = 10
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-accept_content
CELERY_ACCEPT_CONTENT = ["json"]
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-task_serializer
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-task_serializer
CELERY_TASK_SERIALIZER = "json"
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-result_serializer
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std:setting-result_serializer
CELERY_RESULT_SERIALIZER = "json"
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#task-time-limit
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-time-limit
# TODO: set to whatever value is adequate in your circumstances
CELERY_TASK_TIME_LIMIT = 5 * 60
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#task-soft-time-limit
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-soft-time-limit
# TODO: set to whatever value is adequate in your circumstances
CELERY_TASK_SOFT_TIME_LIMIT = 60
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#beat-scheduler
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#beat-scheduler
CELERY_BEAT_SCHEDULER = "django_celery_beat.schedulers:DatabaseScheduler"
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#worker-send-task-events
+CELERY_WORKER_SEND_TASK_EVENTS = True
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#std-setting-task_send_sent_event
+CELERY_TASK_SEND_SENT_EVENT = True
{%- endif %}
# django-allauth
@@ -299,9 +321,13 @@ ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_EMAIL_VERIFICATION = "mandatory"
# https://django-allauth.readthedocs.io/en/latest/configuration.html
ACCOUNT_ADAPTER = "{{cookiecutter.project_slug}}.users.adapters.AccountAdapter"
+# https://django-allauth.readthedocs.io/en/latest/forms.html
+ACCOUNT_FORMS = {"signup": "{{cookiecutter.project_slug}}.users.forms.UserSignupForm"}
# https://django-allauth.readthedocs.io/en/latest/configuration.html
SOCIALACCOUNT_ADAPTER = "{{cookiecutter.project_slug}}.users.adapters.SocialAccountAdapter"
-{% if cookiecutter.use_compressor == 'y' -%}
+# https://django-allauth.readthedocs.io/en/latest/forms.html
+SOCIALACCOUNT_FORMS = {"signup": "{{cookiecutter.project_slug}}.users.forms.UserSocialSignupForm"}
+{% if cookiecutter.frontend_pipeline == 'Django Compressor' -%}
# django-compressor
# ------------------------------------------------------------------------------
# https://django-compressor.readthedocs.io/en/latest/quickstart/#installation
@@ -309,7 +335,7 @@ INSTALLED_APPS += ["compressor"]
STATICFILES_FINDERS += ["compressor.finders.CompressorFinder"]
{%- endif %}
{% if cookiecutter.use_drf == "y" -%}
-# django-reset-framework
+# django-rest-framework
# -------------------------------------------------------------------------------
# django-rest-framework - https://www.django-rest-framework.org/api-guide/settings/
REST_FRAMEWORK = {
@@ -318,7 +344,33 @@ REST_FRAMEWORK = {
"rest_framework.authentication.TokenAuthentication",
),
"DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.IsAuthenticated",),
+ "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
}
+
+# django-cors-headers - https://github.com/adamchainz/django-cors-headers#setup
+CORS_URLS_REGEX = r"^/api/.*$"
+
+# By Default swagger ui is available only to admin user(s). You can change permission classes to change that
+# See more configuration options at https://drf-spectacular.readthedocs.io/en/latest/settings.html#settings
+SPECTACULAR_SETTINGS = {
+ "TITLE": "{{ cookiecutter.project_name }} API",
+ "DESCRIPTION": "Documentation of API endpoints of {{ cookiecutter.project_name }}",
+ "VERSION": "1.0.0",
+ "SERVE_PERMISSIONS": ["rest_framework.permissions.IsAdminUser"],
+}
+{%- endif %}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+# django-webpack-loader
+# ------------------------------------------------------------------------------
+WEBPACK_LOADER = {
+ "DEFAULT": {
+ "CACHE": not DEBUG,
+ "STATS_FILE": BASE_DIR / "webpack-stats.json",
+ "POLL_INTERVAL": 0.1,
+ "IGNORE": [r".+\.hot-update.js", r".+\.map"],
+ }
+}
+
{%- endif %}
# Your stuff...
# ------------------------------------------------------------------------------
diff --git a/{{cookiecutter.project_slug}}/config/settings/local.py b/{{cookiecutter.project_slug}}/config/settings/local.py
index 015d8aff8..7220c5e4c 100644
--- a/{{cookiecutter.project_slug}}/config/settings/local.py
+++ b/{{cookiecutter.project_slug}}/config/settings/local.py
@@ -68,7 +68,15 @@ if env("USE_DOCKER") == "yes":
import socket
hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())
- INTERNAL_IPS += [ip[:-1] + "1" for ip in ips]
+ INTERNAL_IPS += [".".join(ip.split(".")[:-1] + ["1"]) for ip in ips]
+ {%- if cookiecutter.frontend_pipeline in ['Gulp', 'Webpack'] %}
+ try:
+ _, _, ips = socket.gethostbyname_ex("node")
+ INTERNAL_IPS.extend(ips)
+ except socket.gaierror:
+ # The node container isn't started (yet?)
+ pass
+ {%- endif %}
{%- endif %}
# django-extensions
@@ -80,12 +88,18 @@ INSTALLED_APPS += ["django_extensions"] # noqa F405
# Celery
# ------------------------------------------------------------------------------
{% if cookiecutter.use_docker == 'n' -%}
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#task-always-eager
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-always-eager
CELERY_TASK_ALWAYS_EAGER = True
{%- endif %}
-# http://docs.celeryproject.org/en/latest/userguide/configuration.html#task-eager-propagates
+# https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-eager-propagates
CELERY_TASK_EAGER_PROPAGATES = True
+{%- endif %}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+# django-webpack-loader
+# ------------------------------------------------------------------------------
+WEBPACK_LOADER["DEFAULT"]["CACHE"] = not DEBUG # noqa F405
+
{%- endif %}
# Your stuff...
# ------------------------------------------------------------------------------
diff --git a/{{cookiecutter.project_slug}}/config/settings/production.py b/{{cookiecutter.project_slug}}/config/settings/production.py
index a93a6a2d5..071fab621 100644
--- a/{{cookiecutter.project_slug}}/config/settings/production.py
+++ b/{{cookiecutter.project_slug}}/config/settings/production.py
@@ -2,12 +2,12 @@
import logging
import sentry_sdk
-
-from sentry_sdk.integrations.django import DjangoIntegration
-from sentry_sdk.integrations.logging import LoggingIntegration
{%- if cookiecutter.use_celery == 'y' %}
from sentry_sdk.integrations.celery import CeleryIntegration
-{% endif %}
+{%- endif %}
+from sentry_sdk.integrations.django import DjangoIntegration
+from sentry_sdk.integrations.logging import LoggingIntegration
+from sentry_sdk.integrations.redis import RedisIntegration
{% endif -%}
from .base import * # noqa
@@ -22,8 +22,6 @@ ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS", default=["{{ cookiecutter.domai
# DATABASES
# ------------------------------------------------------------------------------
-DATABASES["default"] = env.db("DATABASE_URL") # noqa F405
-DATABASES["default"]["ATOMIC_REQUESTS"] = True # noqa F405
DATABASES["default"]["CONN_MAX_AGE"] = env.int("CONN_MAX_AGE", default=60) # noqa F405
# CACHES
@@ -35,7 +33,7 @@ CACHES = {
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
# Mimicing memcache behavior.
- # http://niwinz.github.io/django-redis/latest/#_memcached_exceptions_behavior
+ # https://github.com/jazzband/django-redis#memcached-exceptions-behavior
"IGNORE_EXCEPTIONS": True,
},
}
@@ -87,13 +85,23 @@ _AWS_EXPIRY = 60 * 60 * 24 * 7
AWS_S3_OBJECT_PARAMETERS = {
"CacheControl": f"max-age={_AWS_EXPIRY}, s-maxage={_AWS_EXPIRY}, must-revalidate"
}
-# https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings
-AWS_DEFAULT_ACL = None
+# https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings
+AWS_S3_MAX_MEMORY_SIZE = env.int(
+ "DJANGO_AWS_S3_MAX_MEMORY_SIZE",
+ default=100_000_000, # 100MB
+)
# https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings
AWS_S3_REGION_NAME = env("DJANGO_AWS_S3_REGION_NAME", default=None)
+# https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#cloudfront
+AWS_S3_CUSTOM_DOMAIN = env("DJANGO_AWS_S3_CUSTOM_DOMAIN", default=None)
+aws_s3_domain = AWS_S3_CUSTOM_DOMAIN or f"{AWS_STORAGE_BUCKET_NAME}.s3.amazonaws.com"
{% elif cookiecutter.cloud_provider == 'GCP' %}
GS_BUCKET_NAME = env("DJANGO_GCP_STORAGE_BUCKET_NAME")
GS_DEFAULT_ACL = "publicRead"
+{% elif cookiecutter.cloud_provider == 'Azure' %}
+AZURE_ACCOUNT_KEY = env("DJANGO_AZURE_ACCOUNT_KEY")
+AZURE_ACCOUNT_NAME = env("DJANGO_AZURE_ACCOUNT_NAME")
+AZURE_CONTAINER = env("DJANGO_AZURE_CONTAINER_NAME")
{% endif -%}
{% if cookiecutter.cloud_provider != 'None' or cookiecutter.use_whitenoise == 'y' -%}
@@ -103,78 +111,44 @@ GS_DEFAULT_ACL = "publicRead"
{% if cookiecutter.use_whitenoise == 'y' -%}
STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
{% elif cookiecutter.cloud_provider == 'AWS' -%}
-STATICFILES_STORAGE = "config.settings.production.StaticRootS3Boto3Storage"
+STATICFILES_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.StaticRootS3Boto3Storage"
COLLECTFAST_STRATEGY = "collectfast.strategies.boto3.Boto3Strategy"
-STATIC_URL = f"https://{AWS_STORAGE_BUCKET_NAME}.s3.amazonaws.com/static/"
+STATIC_URL = f"https://{aws_s3_domain}/static/"
{% elif cookiecutter.cloud_provider == 'GCP' -%}
-STATICFILES_STORAGE = "config.settings.production.StaticRootGoogleCloudStorage"
+STATICFILES_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.StaticRootGoogleCloudStorage"
COLLECTFAST_STRATEGY = "collectfast.strategies.gcloud.GoogleCloudStrategy"
STATIC_URL = f"https://storage.googleapis.com/{GS_BUCKET_NAME}/static/"
+{% elif cookiecutter.cloud_provider == 'Azure' -%}
+STATICFILES_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.StaticRootAzureStorage"
+STATIC_URL = f"https://{AZURE_ACCOUNT_NAME}.blob.core.windows.net/static/"
{% endif -%}
# MEDIA
# ------------------------------------------------------------------------------
{%- if cookiecutter.cloud_provider == 'AWS' %}
-# region http://stackoverflow.com/questions/10390244/
-# Full-fledge class: https://stackoverflow.com/a/18046120/104731
-from storages.backends.s3boto3 import S3Boto3Storage # noqa E402
-
-
-class StaticRootS3Boto3Storage(S3Boto3Storage):
- location = "static"
- default_acl = "public-read"
-
-
-class MediaRootS3Boto3Storage(S3Boto3Storage):
- location = "media"
- file_overwrite = False
-
-
-# endregion
-DEFAULT_FILE_STORAGE = "config.settings.production.MediaRootS3Boto3Storage"
-MEDIA_URL = f"https://{AWS_STORAGE_BUCKET_NAME}.s3.amazonaws.com/media/"
+DEFAULT_FILE_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.MediaRootS3Boto3Storage"
+MEDIA_URL = f"https://{aws_s3_domain}/media/"
{%- elif cookiecutter.cloud_provider == 'GCP' %}
-from storages.backends.gcloud import GoogleCloudStorage # noqa E402
-
-
-class StaticRootGoogleCloudStorage(GoogleCloudStorage):
- location = "static"
- default_acl = "publicRead"
-
-
-class MediaRootGoogleCloudStorage(GoogleCloudStorage):
- location = "media"
- file_overwrite = False
-
-
-DEFAULT_FILE_STORAGE = "config.settings.production.MediaRootGoogleCloudStorage"
+DEFAULT_FILE_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.MediaRootGoogleCloudStorage"
MEDIA_URL = f"https://storage.googleapis.com/{GS_BUCKET_NAME}/media/"
+{%- elif cookiecutter.cloud_provider == 'Azure' %}
+DEFAULT_FILE_STORAGE = "{{cookiecutter.project_slug}}.utils.storages.MediaRootAzureStorage"
+MEDIA_URL = f"https://{AZURE_ACCOUNT_NAME}.blob.core.windows.net/media/"
{%- endif %}
-# TEMPLATES
-# ------------------------------------------------------------------------------
-# https://docs.djangoproject.com/en/dev/ref/settings/#templates
-TEMPLATES[-1]["OPTIONS"]["loaders"] = [ # type: ignore[index] # noqa F405
- (
- "django.template.loaders.cached.Loader",
- [
- "django.template.loaders.filesystem.Loader",
- "django.template.loaders.app_directories.Loader",
- ],
- )
-]
-
# EMAIL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#default-from-email
DEFAULT_FROM_EMAIL = env(
- "DJANGO_DEFAULT_FROM_EMAIL", default="{{cookiecutter.project_name}} "
+ "DJANGO_DEFAULT_FROM_EMAIL",
+ default="{{cookiecutter.project_name}} ",
)
# https://docs.djangoproject.com/en/dev/ref/settings/#server-email
SERVER_EMAIL = env("DJANGO_SERVER_EMAIL", default=DEFAULT_FROM_EMAIL)
# https://docs.djangoproject.com/en/dev/ref/settings/#email-subject-prefix
EMAIL_SUBJECT_PREFIX = env(
- "DJANGO_EMAIL_SUBJECT_PREFIX", default="[{{cookiecutter.project_name}}]"
+ "DJANGO_EMAIL_SUBJECT_PREFIX",
+ default="[{{cookiecutter.project_name}}]",
)
# ADMIN
@@ -182,27 +156,104 @@ EMAIL_SUBJECT_PREFIX = env(
# Django Admin URL regex.
ADMIN_URL = env("DJANGO_ADMIN_URL")
-# Anymail (Mailgun)
+# Anymail
# ------------------------------------------------------------------------------
# https://anymail.readthedocs.io/en/stable/installation/#installing-anymail
INSTALLED_APPS += ["anymail"] # noqa F405
-EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend"
+# https://docs.djangoproject.com/en/dev/ref/settings/#email-backend
# https://anymail.readthedocs.io/en/stable/installation/#anymail-settings-reference
+{%- if cookiecutter.mail_service == 'Mailgun' %}
+# https://anymail.readthedocs.io/en/stable/esps/mailgun/
+EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend"
ANYMAIL = {
"MAILGUN_API_KEY": env("MAILGUN_API_KEY"),
"MAILGUN_SENDER_DOMAIN": env("MAILGUN_DOMAIN"),
"MAILGUN_API_URL": env("MAILGUN_API_URL", default="https://api.mailgun.net/v3"),
}
+{%- elif cookiecutter.mail_service == 'Amazon SES' %}
+# https://anymail.readthedocs.io/en/stable/esps/amazon_ses/
+EMAIL_BACKEND = "anymail.backends.amazon_ses.EmailBackend"
+ANYMAIL = {}
+{%- elif cookiecutter.mail_service == 'Mailjet' %}
+# https://anymail.readthedocs.io/en/stable/esps/mailjet/
+EMAIL_BACKEND = "anymail.backends.mailjet.EmailBackend"
+ANYMAIL = {
+ "MAILJET_API_KEY": env("MAILJET_API_KEY"),
+ "MAILJET_SECRET_KEY": env("MAILJET_SECRET_KEY"),
+}
+{%- elif cookiecutter.mail_service == 'Mandrill' %}
+# https://anymail.readthedocs.io/en/stable/esps/mandrill/
+EMAIL_BACKEND = "anymail.backends.mandrill.EmailBackend"
+ANYMAIL = {
+ "MANDRILL_API_KEY": env("MANDRILL_API_KEY"),
+ "MANDRILL_API_URL": env(
+ "MANDRILL_API_URL", default="https://mandrillapp.com/api/1.0"
+ ),
+}
+{%- elif cookiecutter.mail_service == 'Postmark' %}
+# https://anymail.readthedocs.io/en/stable/esps/postmark/
+EMAIL_BACKEND = "anymail.backends.postmark.EmailBackend"
+ANYMAIL = {
+ "POSTMARK_SERVER_TOKEN": env("POSTMARK_SERVER_TOKEN"),
+ "POSTMARK_API_URL": env("POSTMARK_API_URL", default="https://api.postmarkapp.com/"),
+}
+{%- elif cookiecutter.mail_service == 'Sendgrid' %}
+# https://anymail.readthedocs.io/en/stable/esps/sendgrid/
+EMAIL_BACKEND = "anymail.backends.sendgrid.EmailBackend"
+ANYMAIL = {
+ "SENDGRID_API_KEY": env("SENDGRID_API_KEY"),
+ "SENDGRID_API_URL": env("SENDGRID_API_URL", default="https://api.sendgrid.com/v3/"),
+}
+{%- elif cookiecutter.mail_service == 'SendinBlue' %}
+# https://anymail.readthedocs.io/en/stable/esps/sendinblue/
+EMAIL_BACKEND = "anymail.backends.sendinblue.EmailBackend"
+ANYMAIL = {
+ "SENDINBLUE_API_KEY": env("SENDINBLUE_API_KEY"),
+ "SENDINBLUE_API_URL": env(
+ "SENDINBLUE_API_URL", default="https://api.sendinblue.com/v3/"
+ ),
+}
+{%- elif cookiecutter.mail_service == 'SparkPost' %}
+# https://anymail.readthedocs.io/en/stable/esps/sparkpost/
+EMAIL_BACKEND = "anymail.backends.sparkpost.EmailBackend"
+ANYMAIL = {
+ "SPARKPOST_API_KEY": env("SPARKPOST_API_KEY"),
+ "SPARKPOST_API_URL": env(
+ "SPARKPOST_API_URL", default="https://api.sparkpost.com/api/v1"
+ ),
+}
+{%- elif cookiecutter.mail_service == 'Other SMTP' %}
+# https://anymail.readthedocs.io/en/stable/esps
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
+ANYMAIL = {}
+{%- endif %}
-{% if cookiecutter.use_compressor == 'y' -%}
+{% if cookiecutter.frontend_pipeline == 'Django Compressor' -%}
# django-compressor
# ------------------------------------------------------------------------------
# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_ENABLED
COMPRESS_ENABLED = env.bool("COMPRESS_ENABLED", default=True)
+{%- if cookiecutter.cloud_provider == 'None' %}
# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_STORAGE
-COMPRESS_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
+COMPRESS_STORAGE = "compressor.storage.GzipCompressorFileStorage"
+{%- elif cookiecutter.cloud_provider in ('AWS', 'GCP', 'Azure') and cookiecutter.use_whitenoise == 'n' %}
+# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_STORAGE
+COMPRESS_STORAGE = STATICFILES_STORAGE
+{%- endif %}
# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_URL
COMPRESS_URL = STATIC_URL{% if cookiecutter.use_whitenoise == 'y' or cookiecutter.cloud_provider == 'None' %} # noqa F405{% endif %}
+{%- if cookiecutter.use_whitenoise == 'y' %}
+# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_OFFLINE
+COMPRESS_OFFLINE = True # Offline compression is required when using Whitenoise
+{%- endif %}
+# https://django-compressor.readthedocs.io/en/latest/settings/#django.conf.settings.COMPRESS_FILTERS
+COMPRESS_FILTERS = {
+ "css": [
+ "compressor.filters.css_default.CssAbsoluteFilter",
+ "compressor.filters.cssmin.rCSSMinFilter",
+ ],
+ "js": ["compressor.filters.jsmin.JSMinFilter"],
+}
{% endif %}
{%- if cookiecutter.use_whitenoise == 'n' -%}
# Collectfast
@@ -300,13 +351,32 @@ sentry_logging = LoggingIntegration(
)
{%- if cookiecutter.use_celery == 'y' %}
+integrations = [
+ sentry_logging,
+ DjangoIntegration(),
+ CeleryIntegration(),
+ RedisIntegration(),
+]
+{% else %}
+integrations = [sentry_logging, DjangoIntegration(), RedisIntegration()]
+{% endif -%}
+
sentry_sdk.init(
dsn=SENTRY_DSN,
- integrations=[sentry_logging, DjangoIntegration(), CeleryIntegration()],
+ integrations=integrations,
+ environment=env("SENTRY_ENVIRONMENT", default="production"),
+ traces_sample_rate=env.float("SENTRY_TRACES_SAMPLE_RATE", default=0.0),
)
-{% else %}
-sentry_sdk.init(dsn=SENTRY_DSN, integrations=[sentry_logging, DjangoIntegration()])
-{% endif -%}
{% endif %}
+{% if cookiecutter.use_drf == "y" -%}
+
+# django-rest-framework
+# -------------------------------------------------------------------------------
+# Tools that generate code samples can use SERVERS to point to the correct domain
+SPECTACULAR_SETTINGS["SERVERS"] = [ # noqa F405
+ {"url": "https://{{ cookiecutter.domain_name }}", "description": "Production server"}
+]
+
+{%- endif %}
# Your stuff...
# ------------------------------------------------------------------------------
diff --git a/{{cookiecutter.project_slug}}/config/settings/test.py b/{{cookiecutter.project_slug}}/config/settings/test.py
index 667bb20d8..198b5aa5d 100644
--- a/{{cookiecutter.project_slug}}/config/settings/test.py
+++ b/{{cookiecutter.project_slug}}/config/settings/test.py
@@ -15,37 +15,19 @@ SECRET_KEY = env(
# https://docs.djangoproject.com/en/dev/ref/settings/#test-runner
TEST_RUNNER = "django.test.runner.DiscoverRunner"
-# CACHES
-# ------------------------------------------------------------------------------
-# https://docs.djangoproject.com/en/dev/ref/settings/#caches
-CACHES = {
- "default": {
- "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
- "LOCATION": "",
- }
-}
-
# PASSWORDS
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#password-hashers
PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
-# TEMPLATES
-# ------------------------------------------------------------------------------
-TEMPLATES[-1]["OPTIONS"]["loaders"] = [ # type: ignore[index] # noqa F405
- (
- "django.template.loaders.cached.Loader",
- [
- "django.template.loaders.filesystem.Loader",
- "django.template.loaders.app_directories.Loader",
- ],
- )
-]
-
# EMAIL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/dev/ref/settings/#email-backend
EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"
+# DEBUGGING FOR TEMPLATES
+# ------------------------------------------------------------------------------
+TEMPLATES[0]["OPTIONS"]["debug"] = True # type: ignore # noqa F405
+
# Your stuff...
# ------------------------------------------------------------------------------
diff --git a/{{cookiecutter.project_slug}}/config/urls.py b/{{cookiecutter.project_slug}}/config/urls.py
index 382bf8951..ab42cc103 100644
--- a/{{cookiecutter.project_slug}}/config/urls.py
+++ b/{{cookiecutter.project_slug}}/config/urls.py
@@ -1,10 +1,14 @@
from django.conf import settings
-from django.urls import include, path
from django.conf.urls.static import static
from django.contrib import admin
-from django.views.generic import TemplateView
+{%- if cookiecutter.use_async == 'y' %}
+from django.contrib.staticfiles.urls import staticfiles_urlpatterns
+{%- endif %}
+from django.urls import include, path
from django.views import defaults as default_views
-{% if cookiecutter.use_drf == 'y' -%}
+from django.views.generic import TemplateView
+{%- if cookiecutter.use_drf == 'y' %}
+from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
from rest_framework.authtoken.views import obtain_auth_token
{%- endif %}
@@ -20,13 +24,24 @@ urlpatterns = [
path("accounts/", include("allauth.urls")),
# Your stuff: custom urls includes go here
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
-{% if cookiecutter.use_drf == 'y' -%}
+{%- if cookiecutter.use_async == 'y' %}
+if settings.DEBUG:
+ # Static file serving when using Gunicorn + Uvicorn for local web socket development
+ urlpatterns += staticfiles_urlpatterns()
+{%- endif %}
+{% if cookiecutter.use_drf == 'y' %}
# API URLS
urlpatterns += [
# API base url
path("api/", include("config.api_router")),
# DRF auth token
path("auth-token/", obtain_auth_token),
+ path("api/schema/", SpectacularAPIView.as_view(), name="api-schema"),
+ path(
+ "api/docs/",
+ SpectacularSwaggerView.as_view(url_name="api-schema"),
+ name="api-docs",
+ ),
]
{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/config/websocket.py b/{{cookiecutter.project_slug}}/config/websocket.py
new file mode 100644
index 000000000..81adfbc66
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/config/websocket.py
@@ -0,0 +1,13 @@
+async def websocket_application(scope, receive, send):
+ while True:
+ event = await receive()
+
+ if event["type"] == "websocket.connect":
+ await send({"type": "websocket.accept"})
+
+ if event["type"] == "websocket.disconnect":
+ break
+
+ if event["type"] == "websocket.receive":
+ if event["text"] == "ping":
+ await send({"type": "websocket.send", "text": "pong!"})
diff --git a/{{cookiecutter.project_slug}}/config/wsgi.py b/{{cookiecutter.project_slug}}/config/wsgi.py
index 1899a30ca..3fd809ef3 100644
--- a/{{cookiecutter.project_slug}}/config/wsgi.py
+++ b/{{cookiecutter.project_slug}}/config/wsgi.py
@@ -15,15 +15,14 @@ framework.
"""
import os
import sys
+from pathlib import Path
from django.core.wsgi import get_wsgi_application
# This allows easy placement of apps within the interior
# {{ cookiecutter.project_slug }} directory.
-app_path = os.path.abspath(
- os.path.join(os.path.dirname(os.path.abspath(__file__)), os.pardir)
-)
-sys.path.append(os.path.join(app_path, "{{ cookiecutter.project_slug }}"))
+BASE_DIR = Path(__file__).resolve(strict=True).parent.parent
+sys.path.append(str(BASE_DIR / "{{ cookiecutter.project_slug }}"))
# We defer to a DJANGO_SETTINGS_MODULE already in the environment. This breaks
# if running multiple sites in the same mod_wsgi process. To fix this, use
# mod_wsgi daemon mode with each site in its own daemon process, or use
diff --git a/{{cookiecutter.project_slug}}/docs/Makefile b/{{cookiecutter.project_slug}}/docs/Makefile
index d4bb2cbb9..cf080e476 100644
--- a/{{cookiecutter.project_slug}}/docs/Makefile
+++ b/{{cookiecutter.project_slug}}/docs/Makefile
@@ -6,15 +6,31 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
-BUILDDIR = _build
+BUILDDIR = ./_build
+{%- if cookiecutter.use_docker == 'y' %}
+APP = /app
+{%- else %}
+APP = ../{{cookiecutter.project_slug}}
+{% endif %}
+
+.PHONY: help livehtml apidocs Makefile
# Put it first so that "make" without argument is like "make help".
help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
-.PHONY: help Makefile
+# Build, watch and serve docs with live reload
+livehtml:
+ sphinx-autobuild -b html
+ {%- if cookiecutter.use_docker == 'y' %} --host 0.0.0.0
+ {%- else %} --open-browser
+ {%- endif %} --port 9000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html
+
+# Outputs rst files from django application code
+apidocs:
+ sphinx-apidoc -o $(SOURCEDIR)/api $(APP)
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
diff --git a/{{cookiecutter.project_slug}}/docs/conf.py b/{{cookiecutter.project_slug}}/docs/conf.py
index bfde1e3a6..c640e1c63 100644
--- a/{{cookiecutter.project_slug}}/docs/conf.py
+++ b/{{cookiecutter.project_slug}}/docs/conf.py
@@ -9,15 +9,27 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+
import os
import sys
+import django
-# import django
-# sys.path.insert(0, os.path.abspath('..'))
-# os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
-# django.setup()
-
+if os.getenv("READTHEDOCS", default=False) == "True":
+ sys.path.insert(0, os.path.abspath(".."))
+ os.environ["DJANGO_READ_DOT_ENV_FILE"] = "True"
+ os.environ["USE_DOCKER"] = "no"
+else:
+{%- if cookiecutter.use_docker == 'y' %}
+ sys.path.insert(0, os.path.abspath("/app"))
+{%- else %}
+ sys.path.insert(0, os.path.abspath(".."))
+{%- endif %}
+os.environ["DATABASE_URL"] = "sqlite:///readthedocs.db"
+{%- if cookiecutter.use_celery == 'y' %}
+os.environ["CELERY_BROKER_URL"] = os.getenv("REDIS_URL", "redis://redis:6379")
+{%- endif %}
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
+django.setup()
# -- Project information -----------------------------------------------------
@@ -31,17 +43,19 @@ author = "{{ cookiecutter.author_name }}"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = []
+extensions = [
+ "sphinx.ext.autodoc",
+ "sphinx.ext.napoleon",
+]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+# templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
@@ -52,4 +66,4 @@ html_theme = "alabaster"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
diff --git a/{{cookiecutter.project_slug}}/docs/howto.rst b/{{cookiecutter.project_slug}}/docs/howto.rst
new file mode 100644
index 000000000..7f2d26a1e
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/docs/howto.rst
@@ -0,0 +1,45 @@
+How To - Project Documentation
+======================================================================
+
+Get Started
+----------------------------------------------------------------------
+
+Documentation can be written as rst files in `{{cookiecutter.project_slug}}/docs`.
+
+{% if cookiecutter.use_docker == 'n' %}
+To build and serve docs, use the command::
+
+ make livehtml
+
+from inside the `{{cookiecutter.project_slug}}/docs` directory.
+{% else %}
+To build and serve docs, use the commands::
+
+ docker-compose -f local.yml up docs
+
+{% endif %}
+
+Changes to files in `docs/_source` will be picked up and reloaded automatically.
+
+`Sphinx `_ is the tool used to build documentation.
+
+Docstrings to Documentation
+----------------------------------------------------------------------
+
+The sphinx extension `apidoc `_ is used to automatically document code using signatures and docstrings.
+
+Numpy or Google style docstrings will be picked up from project files and available for documentation. See the `Napoleon `_ extension for details.
+
+For an in-use example, see the `page source <_sources/users.rst.txt>`_ for :ref:`users`.
+
+To compile all docstrings automatically into documentation source files, use the command:
+ ::
+
+ make apidocs
+
+{% if cookiecutter.use_docker == 'y' %}
+This can be done in the docker container:
+ ::
+
+ docker run --rm docs make apidocs
+{% endif -%}
diff --git a/{{cookiecutter.project_slug}}/docs/index.rst b/{{cookiecutter.project_slug}}/docs/index.rst
index b107a9e5c..cb4cbaeda 100644
--- a/{{cookiecutter.project_slug}}/docs/index.rst
+++ b/{{cookiecutter.project_slug}}/docs/index.rst
@@ -10,7 +10,9 @@ Welcome to {{ cookiecutter.project_name }}'s documentation!
:maxdepth: 2
:caption: Contents:
- pycharm/configuration
+ howto{% if cookiecutter.use_pycharm == 'y' %}
+ pycharm/configuration{% endif %}
+ users
diff --git a/{{cookiecutter.project_slug}}/docs/make.bat b/{{cookiecutter.project_slug}}/docs/make.bat
index 922152e96..6cd1129f0 100644
--- a/{{cookiecutter.project_slug}}/docs/make.bat
+++ b/{{cookiecutter.project_slug}}/docs/make.bat
@@ -4,11 +4,13 @@ pushd %~dp0
REM Command file for Sphinx documentation
+
if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
+ set SPHINXBUILD=sphinx-build -c .
)
-set SOURCEDIR=.
+set SOURCEDIR=_source
set BUILDDIR=_build
+set APP=..\{{cookiecutter.project_slug}}
if "%1" == "" goto help
@@ -20,16 +22,25 @@ if errorlevel 9009 (
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
+ echo.Install sphinx-autobuild for live serving.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+%SPHINXBUILD% -b %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
+:livehtml
+sphinx-autobuild -b html --open-browser -p 9000 --watch %APP% -c . %SOURCEDIR% %BUILDDIR%/html
+GOTO :EOF
+
+:apidocs
+sphinx-apidoc -o %SOURCEDIR%/api %APP%
+GOTO :EOF
+
:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+%SPHINXBUILD% -b help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst b/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst
index 1c20d023f..d8e769167 100644
--- a/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst
@@ -14,7 +14,7 @@ This repository comes with already prepared "Run/Debug Configurations" for docke
.. image:: images/2.png
-But as you can see, at the beginning there is something wrong with them. They have red X on django icon, and they cannot be used, without configuring remote python interpteter. To do that, you have to go to *Settings > Build, Execution, Deployment* first.
+But as you can see, at the beginning there is something wrong with them. They have red X on django icon, and they cannot be used, without configuring remote python interpreter. To do that, you have to go to *Settings > Build, Execution, Deployment* first.
Next, you have to add new remote python interpreter, based on already tested deployment settings. Go to *Settings > Project > Project Interpreter*. Click on the cog icon, and click *Add Remote*.
diff --git a/{{cookiecutter.project_slug}}/docs/users.rst b/{{cookiecutter.project_slug}}/docs/users.rst
new file mode 100644
index 000000000..6cf645562
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/docs/users.rst
@@ -0,0 +1,15 @@
+ .. _users:
+
+Users
+======================================================================
+
+Starting a new project, it’s highly recommended to set up a custom user model,
+even if the default User model is sufficient for you.
+
+This model behaves identically to the default user model,
+but you’ll be able to customize it in the future if the need arises.
+
+.. automodule:: {{cookiecutter.project_slug}}.users.models
+ :members:
+ :noindex:
+
diff --git a/{{cookiecutter.project_slug}}/gulpfile.js b/{{cookiecutter.project_slug}}/gulpfile.js
index 3c28a7359..fa3636eab 100644
--- a/{{cookiecutter.project_slug}}/gulpfile.js
+++ b/{{cookiecutter.project_slug}}/gulpfile.js
@@ -9,9 +9,8 @@ const pjson = require('./package.json')
// Plugins
const autoprefixer = require('autoprefixer')
const browserSync = require('browser-sync').create()
-{% if cookiecutter.custom_bootstrap_compilation == 'y' %}
const concat = require('gulp-concat')
-{% endif %}
+const tildeImporter = require('node-sass-tilde-importer');
const cssnano = require ('cssnano')
const imagemin = require('gulp-imagemin')
const pixrem = require('pixrem')
@@ -19,7 +18,7 @@ const plumber = require('gulp-plumber')
const postcss = require('gulp-postcss')
const reload = browserSync.reload
const rename = require('gulp-rename')
-const sass = require('gulp-sass')
+const sass = require('gulp-sass')(require('sass'))
const spawn = require('child_process').spawn
const uglify = require('gulp-uglify-es').default
@@ -29,14 +28,10 @@ function pathsConfig(appName) {
const vendorsRoot = 'node_modules'
return {
- {% if cookiecutter.custom_bootstrap_compilation == 'y' %}
- bootstrapSass: `${vendorsRoot}/bootstrap/scss`,
vendorsJs: [
- `${vendorsRoot}/jquery/dist/jquery.slim.js`,
- `${vendorsRoot}/popper.js/dist/umd/popper.js`,
+ `${vendorsRoot}/@popperjs/core/dist/umd/popper.js`,
`${vendorsRoot}/bootstrap/dist/js/bootstrap.js`,
],
- {% endif %}
app: this.app,
templates: `${this.app}/templates`,
css: `${this.app}/static/css`,
@@ -47,7 +42,7 @@ function pathsConfig(appName) {
}
}
-var paths = pathsConfig()
+const paths = pathsConfig()
////////////////////////////////
// Tasks
@@ -55,21 +50,19 @@ var paths = pathsConfig()
// Styles autoprefixing and minification
function styles() {
- var processCss = [
+ const processCss = [
autoprefixer(), // adds vendor prefixes
pixrem(), // add fallbacks for rem units
]
- var minifyCss = [
+ const minifyCss = [
cssnano({ preset: 'default' }) // minify result
]
return src(`${paths.sass}/project.scss`)
.pipe(sass({
+ importer: tildeImporter,
includePaths: [
- {% if cookiecutter.custom_bootstrap_compilation == 'y' %}
- paths.bootstrapSass,
- {% endif %}
paths.sass
]
}).on('error', sass.logError))
@@ -90,18 +83,16 @@ function scripts() {
.pipe(dest(paths.js))
}
-{% if cookiecutter.custom_bootstrap_compilation == 'y' %}
// Vendor Javascript minification
function vendorScripts() {
- return src(paths.vendorsJs)
+ return src(paths.vendorsJs, { sourcemaps: true })
.pipe(concat('vendors.js'))
.pipe(dest(paths.js))
.pipe(plumber()) // Checks for errors
.pipe(uglify()) // Minifies the js
.pipe(rename({ suffix: '.min' }))
- .pipe(dest(paths.js))
+ .pipe(dest(paths.js, { sourcemaps: '.' }))
}
-{% endif %}
// Image compression
function imgCompression() {
@@ -110,64 +101,83 @@ function imgCompression() {
.pipe(dest(paths.images))
}
+{%- if cookiecutter.use_async == 'y' -%}
+// Run django server
+function asyncRunServer() {
+ const cmd = spawn('gunicorn', [
+ 'config.asgi', '-k', 'uvicorn.workers.UvicornWorker', '--reload'
+ ], {stdio: 'inherit'}
+ )
+ cmd.on('close', function(code) {
+ console.log('gunicorn exited with code ' + code)
+ })
+}
+{%- else %}
// Run django server
function runServer(cb) {
- var cmd = spawn('python', ['manage.py', 'runserver'], {stdio: 'inherit'})
+ const cmd = spawn('python', ['manage.py', 'runserver'], {stdio: 'inherit'})
cmd.on('close', function(code) {
console.log('runServer exited with code ' + code)
cb(code)
})
}
+{%- endif %}
// Browser sync server for live reload
function initBrowserSync() {
- browserSync.init(
- [
- `${paths.css}/*.css`,
- `${paths.js}/*.js`,
- `${paths.templates}/*.html`
- ], {
- // https://www.browsersync.io/docs/options/#option-proxy
+ browserSync.init(
+ [
+ `${paths.css}/*.css`,
+ `${paths.js}/*.js`,
+ `${paths.templates}/*.html`
+ ], {
+ {%- if cookiecutter.use_docker == 'y' %}
+ // https://www.browsersync.io/docs/options/#option-open
+ // Disable as it doesn't work from inside a container
+ open: false,
+ {%- endif %}
+ // https://www.browsersync.io/docs/options/#option-proxy
+ proxy: {
{%- if cookiecutter.use_docker == 'n' %}
- proxy: 'localhost:8000'
- {% else %}
- proxy: {
- target: 'django:8000',
- proxyReq: [
- function(proxyReq, req) {
- // Assign proxy "host" header same as current request at Browsersync server
- proxyReq.setHeader('Host', req.headers.host)
- }
- ]
- },
- // https://www.browsersync.io/docs/options/#option-open
- // Disable as it doesn't work from inside a container
- open: false
+ target: '127.0.0.1:8000',
+ {%- else %}
+ target: 'django:8000',
{%- endif %}
+ proxyReq: [
+ function(proxyReq, req) {
+ // Assign proxy "host" header same as current request at Browsersync server
+ proxyReq.setHeader('Host', req.headers.host)
+ }
+ ]
}
- )
+ }
+ )
}
// Watch
function watchPaths() {
- watch(`${paths.sass}/*.scss`, styles)
- watch(`${paths.templates}/**/*.html`).on("change", reload)
- watch([`${paths.js}/*.js`, `!${paths.js}/*.min.js`], scripts).on("change", reload)
+ watch(`${paths.sass}/*.scss`{% if cookiecutter.windows == 'y' %}, { usePolling: true }{% endif %}, styles)
+ watch(`${paths.templates}/**/*.html`{% if cookiecutter.windows == 'y' %}, { usePolling: true }{% endif %}).on("change", reload)
+ watch([`${paths.js}/*.js`, `!${paths.js}/*.min.js`]{% if cookiecutter.windows == 'y' %}, { usePolling: true }{% endif %}, scripts).on("change", reload)
}
// Generate all assets
const generateAssets = parallel(
styles,
scripts,
- {% if cookiecutter.custom_bootstrap_compilation == 'y' %}vendorScripts,{% endif %}
+ vendorScripts,
imgCompression
)
// Set up dev environment
const dev = parallel(
{%- if cookiecutter.use_docker == 'n' %}
+ {%- if cookiecutter.use_async == 'y' %}
+ asyncRunServer,
+ {%- else %}
runServer,
{%- endif %}
+ {%- endif %}
initBrowserSync,
watchPaths
)
diff --git a/{{cookiecutter.project_slug}}/local.yml b/{{cookiecutter.project_slug}}/local.yml
index 60f8f9228..66ca3b0ef 100644
--- a/{{cookiecutter.project_slug}}/local.yml
+++ b/{{cookiecutter.project_slug}}/local.yml
@@ -1,8 +1,8 @@
version: '3'
volumes:
- local_postgres_data: {}
- local_postgres_data_backups: {}
+ {{ cookiecutter.project_slug }}_local_postgres_data: {}
+ {{ cookiecutter.project_slug }}_local_postgres_data_backups: {}
services:
django:{% if cookiecutter.use_celery == 'y' %} &django{% endif %}
@@ -10,13 +10,17 @@ services:
context: .
dockerfile: ./compose/local/django/Dockerfile
image: {{ cookiecutter.project_slug }}_local_django
+ container_name: {{ cookiecutter.project_slug }}_local_django
depends_on:
- postgres
+ {%- if cookiecutter.use_celery == 'y' %}
+ - redis
+ {%- endif %}
{%- if cookiecutter.use_mailhog == 'y' %}
- mailhog
{%- endif %}
volumes:
- - .:/app
+ - .:/app:z
env_file:
- ./.envs/.local/.django
- ./.envs/.local/.postgres
@@ -29,15 +33,33 @@ services:
context: .
dockerfile: ./compose/production/postgres/Dockerfile
image: {{ cookiecutter.project_slug }}_production_postgres
+ container_name: {{ cookiecutter.project_slug }}_local_postgres
volumes:
- - local_postgres_data:/var/lib/postgresql/data
- - local_postgres_data_backups:/backups
+ - {{ cookiecutter.project_slug }}_local_postgres_data:/var/lib/postgresql/data
+ - {{ cookiecutter.project_slug }}_local_postgres_data_backups:/backups
env_file:
- ./.envs/.local/.postgres
+
+ docs:
+ image: {{ cookiecutter.project_slug }}_local_docs
+ container_name: {{ cookiecutter.project_slug }}_local_docs
+ build:
+ context: .
+ dockerfile: ./compose/local/docs/Dockerfile
+ env_file:
+ - ./.envs/.local/.django
+ volumes:
+ - ./docs:/docs:z
+ - ./config:/app/config:z
+ - ./{{ cookiecutter.project_slug }}:/app/{{ cookiecutter.project_slug }}:z
+ ports:
+ - "9000:9000"
+ command: /start-docs
{%- if cookiecutter.use_mailhog == 'y' %}
mailhog:
image: mailhog/mailhog:v1.0.0
+ container_name: {{ cookiecutter.project_slug }}_local_mailhog
ports:
- "8025:8025"
@@ -45,15 +67,17 @@ services:
{%- if cookiecutter.use_celery == 'y' %}
redis:
- image: redis:5.0
+ image: redis:6
+ container_name: {{ cookiecutter.project_slug }}_local_redis
celeryworker:
<<: *django
image: {{ cookiecutter.project_slug }}_local_celeryworker
+ container_name: {{ cookiecutter.project_slug }}_local_celeryworker
depends_on:
- redis
- postgres
- {% if cookiecutter.use_mailhog == 'y' -%}
+ {%- if cookiecutter.use_mailhog == 'y' %}
- mailhog
{%- endif %}
ports: []
@@ -62,10 +86,11 @@ services:
celerybeat:
<<: *django
image: {{ cookiecutter.project_slug }}_local_celerybeat
+ container_name: {{ cookiecutter.project_slug }}_local_celerybeat
depends_on:
- redis
- postgres
- {% if cookiecutter.use_mailhog == 'y' -%}
+ {%- if cookiecutter.use_mailhog == 'y' %}
- mailhog
{%- endif %}
ports: []
@@ -74,28 +99,32 @@ services:
flower:
<<: *django
image: {{ cookiecutter.project_slug }}_local_flower
+ container_name: {{ cookiecutter.project_slug }}_local_flower
ports:
- "5555:5555"
command: /start-flower
{%- endif %}
- {%- if cookiecutter.js_task_runner == 'Gulp' %}
+ {%- if cookiecutter.frontend_pipeline in ['Gulp', 'Webpack'] %}
node:
build:
context: .
dockerfile: ./compose/local/node/Dockerfile
image: {{ cookiecutter.project_slug }}_local_node
+ container_name: {{ cookiecutter.project_slug }}_local_node
depends_on:
- django
volumes:
- - .:/app
+ - .:/app:z
# http://jdlm.info/articles/2016/03/06/lessons-building-node-app-docker.html
- /app/node_modules
command: npm run dev
ports:
- "3000:3000"
+ {%- if cookiecutter.frontend_pipeline == 'Gulp' %}
# Expose browsersync UI: https://www.browsersync.io/docs/options/#option-ui
- "3001:3001"
+ {%- endif %}
{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/manage.py b/{{cookiecutter.project_slug}}/manage.py
index 7e9c99e04..c44cc826d 100755
--- a/{{cookiecutter.project_slug}}/manage.py
+++ b/{{cookiecutter.project_slug}}/manage.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python
import os
import sys
+from pathlib import Path
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
@@ -24,7 +25,7 @@ if __name__ == "__main__":
# This allows easy placement of apps within the interior
# {{ cookiecutter.project_slug }} directory.
- current_path = os.path.dirname(os.path.abspath(__file__))
- sys.path.append(os.path.join(current_path, "{{ cookiecutter.project_slug }}"))
+ current_path = Path(__file__).parent.resolve()
+ sys.path.append(str(current_path / "{{ cookiecutter.project_slug }}"))
execute_from_command_line(sys.argv)
diff --git a/{{cookiecutter.project_slug}}/merge_production_dotenvs_in_dotenv.py b/{{cookiecutter.project_slug}}/merge_production_dotenvs_in_dotenv.py
index 4e70e2adb..35139fb2e 100644
--- a/{{cookiecutter.project_slug}}/merge_production_dotenvs_in_dotenv.py
+++ b/{{cookiecutter.project_slug}}/merge_production_dotenvs_in_dotenv.py
@@ -1,66 +1,26 @@
import os
-from typing import Sequence
+from collections.abc import Sequence
+from pathlib import Path
-import pytest
-
-ROOT_DIR_PATH = os.path.dirname(os.path.realpath(__file__))
-PRODUCTION_DOTENVS_DIR_PATH = os.path.join(ROOT_DIR_PATH, ".envs", ".production")
-PRODUCTION_DOTENV_FILE_PATHS = [
- os.path.join(PRODUCTION_DOTENVS_DIR_PATH, ".django"),
- os.path.join(PRODUCTION_DOTENVS_DIR_PATH, ".postgres"),
+BASE_DIR = Path(__file__).parent.resolve()
+PRODUCTION_DOTENVS_DIR = BASE_DIR / ".envs" / ".production"
+PRODUCTION_DOTENV_FILES = [
+ PRODUCTION_DOTENVS_DIR / ".django",
+ PRODUCTION_DOTENVS_DIR / ".postgres",
]
-DOTENV_FILE_PATH = os.path.join(ROOT_DIR_PATH, ".env")
+DOTENV_FILE = BASE_DIR / ".env"
def merge(
- output_file_path: str, merged_file_paths: Sequence[str], append_linesep: bool = True
+ output_file: Path,
+ files_to_merge: Sequence[Path],
) -> None:
- with open(output_file_path, "w") as output_file:
- for merged_file_path in merged_file_paths:
- with open(merged_file_path, "r") as merged_file:
- merged_file_content = merged_file.read()
- output_file.write(merged_file_content)
- if append_linesep:
- output_file.write(os.linesep)
-
-
-def main():
- merge(DOTENV_FILE_PATH, PRODUCTION_DOTENV_FILE_PATHS)
-
-
-@pytest.mark.parametrize("merged_file_count", range(3))
-@pytest.mark.parametrize("append_linesep", [True, False])
-def test_merge(tmpdir_factory, merged_file_count: int, append_linesep: bool):
- tmp_dir_path = str(tmpdir_factory.getbasetemp())
-
- output_file_path = os.path.join(tmp_dir_path, ".env")
-
- expected_output_file_content = ""
- merged_file_paths = []
- for i in range(merged_file_count):
- merged_file_ord = i + 1
-
- merged_filename = ".service{}".format(merged_file_ord)
- merged_file_path = os.path.join(tmp_dir_path, merged_filename)
-
- merged_file_content = merged_filename * merged_file_ord
-
- with open(merged_file_path, "w+") as file:
- file.write(merged_file_content)
-
- expected_output_file_content += merged_file_content
- if append_linesep:
- expected_output_file_content += os.linesep
-
- merged_file_paths.append(merged_file_path)
-
- merge(output_file_path, merged_file_paths, append_linesep)
-
- with open(output_file_path, "r") as output_file:
- actual_output_file_content = output_file.read()
-
- assert actual_output_file_content == expected_output_file_content
+ merged_content = ""
+ for merge_file in files_to_merge:
+ merged_content += merge_file.read_text()
+ merged_content += os.linesep
+ output_file.write_text(merged_content)
if __name__ == "__main__":
- main()
+ merge(DOTENV_FILE, PRODUCTION_DOTENV_FILES)
diff --git a/{{cookiecutter.project_slug}}/package.json b/{{cookiecutter.project_slug}}/package.json
index 6edf2e114..8137aa51b 100644
--- a/{{cookiecutter.project_slug}}/package.json
+++ b/{{cookiecutter.project_slug}}/package.json
@@ -1,38 +1,50 @@
{
"name": "{{cookiecutter.project_slug}}",
"version": "{{ cookiecutter.version }}",
- "dependencies": {},
"devDependencies": {
- {% if cookiecutter.js_task_runner == 'Gulp' -%}
- {% if cookiecutter.custom_bootstrap_compilation == 'y' -%}
- "bootstrap": "4.3.1",
+ "@babel/core": "^7.16.5",
+ "@babel/preset-env": "^7.16.5",
+ "@popperjs/core": "^2.10.2",
+ "autoprefixer": "^10.4.0",
+ "babel-loader": "^8.2.3",
+ "bootstrap": "^5.1.3",
+ "browser-sync": "^2.27.7",
+ "css-loader": "^6.5.1",
"gulp-concat": "^2.6.1",
- "jquery": "3.3.1",
- "popper.js": "1.14.3",
- {% endif -%}
- "autoprefixer": "^9.4.7",
- "browser-sync": "^2.14.0",
- "cssnano": "^4.1.10",
- "gulp": "^4.0.0",
- "gulp-imagemin": "^5.0.3",
+ "concurrently": "^7.0.0",
+ "cssnano": "^5.0.11",
+ "gulp": "^4.0.2",
+ "gulp-imagemin": "^7.1.0",
"gulp-plumber": "^1.2.1",
- "gulp-postcss": "^8.0.0",
- "gulp-rename": "^1.2.2",
- "gulp-sass": "^4.0.2",
- "gulp-uglify-es": "^1.0.4",
- "pixrem": "^5.0.0"
- {%- endif %}
+ "gulp-postcss": "^9.0.1",
+ "gulp-rename": "^2.0.0",
+ "gulp-sass": "^5.0.0",
+ "gulp-uglify-es": "^3.0.0",
+ "mini-css-extract-plugin": "^2.4.5",
+ "node-sass-tilde-importer": "^1.0.2",
+ "pixrem": "^5.0.0",
+ "postcss": "^8.3.11",
+ "postcss-loader": "^6.2.1",
+ "postcss-preset-env": "^7.0.2",
+ "sass": "^1.43.4",
+ "sass-loader": "^12.4.0",
+ "webpack": "^5.65.0",
+ "webpack-bundle-tracker": "^1.4.0",
+ "webpack-cli": "^4.9.1",
+ "webpack-dev-server": "^4.6.0",
+ "webpack-merge": "^5.8.0"
},
"engines": {
- "node": ">=8"
+ "node": "16"
},
"browserslist": [
"last 2 versions"
],
+ "babel": {
+ "presets": ["@babel/preset-env"]
+ },
"scripts": {
- {% if cookiecutter.js_task_runner == 'Gulp' -%}
- "dev": "gulp",
- "build": "gulp generate-assets"
- {%- endif %}
+ "dev": "",
+ "build": ""
}
}
diff --git a/{{cookiecutter.project_slug}}/production.yml b/{{cookiecutter.project_slug}}/production.yml
index 6de3c7f8d..df7e49064 100644
--- a/{{cookiecutter.project_slug}}/production.yml
+++ b/{{cookiecutter.project_slug}}/production.yml
@@ -13,6 +13,19 @@ services:
build:
context: .
dockerfile: ./compose/production/django/Dockerfile
+ {%- if cookiecutter.frontend_pipeline == 'Webpack' and cookiecutter.use_whitenoise == 'n' %}
+ args:
+ # These variable can be defined in an .env file in the root of the repo
+ {%- if cookiecutter.cloud_provider == 'AWS' %}
+ DJANGO_AWS_STORAGE_BUCKET_NAME: ${DJANGO_AWS_STORAGE_BUCKET_NAME}
+ DJANGO_AWS_S3_CUSTOM_DOMAIN: ${DJANGO_AWS_S3_CUSTOM_DOMAIN}
+ {%- elif cookiecutter.cloud_provider == 'GCP' %}
+ DJANGO_GCP_STORAGE_BUCKET_NAME: ${DJANGO_GCP_STORAGE_BUCKET_NAME}
+ {%- elif cookiecutter.cloud_provider == 'Azure' %}
+ DJANGO_AZURE_ACCOUNT_NAME: ${DJANGO_AZURE_ACCOUNT_NAME}
+ {%- endif %}
+ {%- endif %}
+
image: {{ cookiecutter.project_slug }}_production_django
{%- if cookiecutter.cloud_provider == 'nginx' %}
volumes:
@@ -49,9 +62,12 @@ services:
ports:
- "0.0.0.0:80:80"
- "0.0.0.0:443:443"
+ {%- if cookiecutter.use_celery == 'y' %}
+ - "0.0.0.0:5555:5555"
+ {%- endif %}
redis:
- image: redis:5.0
+ image: redis:6
{%- if cookiecutter.use_celery == 'y' %}
celeryworker:
@@ -67,13 +83,10 @@ services:
flower:
<<: *django
image: {{ cookiecutter.project_slug }}_production_flower
- ports:
- - "5555:5555"
command: /start-flower
-
{%- endif %}
+ {%- if cookiecutter.cloud_provider == 'AWS' %}
- {% if cookiecutter.cloud_provider == 'AWS' %}
awscli:
build:
context: .
@@ -81,7 +94,7 @@ services:
env_file:
- ./.envs/.production/.django
volumes:
- - production_postgres_data_backups:/backups
+ - production_postgres_data_backups:/backups:z
{%- endif %}
{%- if cookiecutter.cloud_provider == 'nginx' %}
nginx:
diff --git a/{{cookiecutter.project_slug}}/pytest.ini b/{{cookiecutter.project_slug}}/pytest.ini
index e3b2248d9..969c7921e 100644
--- a/{{cookiecutter.project_slug}}/pytest.ini
+++ b/{{cookiecutter.project_slug}}/pytest.ini
@@ -1,6 +1,6 @@
[pytest]
addopts = --ds=config.settings.test --reuse-db
python_files = tests.py test_*.py
-{%- if cookiecutter.js_task_runner != 'None' %}
+{%- if cookiecutter.frontend_pipeline == 'Gulp' %}
norecursedirs = node_modules
{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/requirements/base.txt b/{{cookiecutter.project_slug}}/requirements/base.txt
index 31a6a32b6..46c1e79fc 100644
--- a/{{cookiecutter.project_slug}}/requirements/base.txt
+++ b/{{cookiecutter.project_slug}}/requirements/base.txt
@@ -1,33 +1,51 @@
-pytz==2019.3 # https://github.com/stub42/pytz
-python-slugify==4.0.0 # https://github.com/un33k/python-slugify
-Pillow==7.0.0 # https://github.com/python-pillow/Pillow
-{%- if cookiecutter.use_compressor == "y" %}
-rcssmin==1.0.6{% if cookiecutter.windows == 'y' and cookiecutter.use_docker == 'n' %} --install-option="--without-c-extensions"{% endif %} # https://github.com/ndparker/rcssmin
+pytz==2022.7.1 # https://github.com/stub42/pytz
+python-slugify==7.0.0 # https://github.com/un33k/python-slugify
+Pillow==9.4.0 # https://github.com/python-pillow/Pillow
+{%- if cookiecutter.frontend_pipeline == 'Django Compressor' %}
+{%- if cookiecutter.windows == 'y' and cookiecutter.use_docker == 'n' %}
+rcssmin==1.1.0 --install-option="--without-c-extensions" # https://github.com/ndparker/rcssmin
+{%- else %}
+rcssmin==1.1.1 # https://github.com/ndparker/rcssmin
{%- endif %}
-argon2-cffi==19.2.0 # https://github.com/hynek/argon2_cffi
+{%- endif %}
+argon2-cffi==21.3.0 # https://github.com/hynek/argon2_cffi
{%- if cookiecutter.use_whitenoise == 'y' %}
-whitenoise==5.0.1 # https://github.com/evansd/whitenoise
+whitenoise==6.3.0 # https://github.com/evansd/whitenoise
+{%- endif %}
+redis==4.4.2 # https://github.com/redis/redis-py
+{%- if cookiecutter.use_docker == "y" or cookiecutter.windows == "n" %}
+hiredis==2.1.1 # https://github.com/redis/hiredis-py
{%- endif %}
-redis==3.4.1 # https://github.com/andymccurdy/redis-py
{%- if cookiecutter.use_celery == "y" %}
-celery==4.4.0 # pyup: < 5.0 # https://github.com/celery/celery
-django-celery-beat==1.6.0 # https://github.com/celery/django-celery-beat
+celery==5.2.7 # pyup: < 6.0 # https://github.com/celery/celery
+django-celery-beat==2.4.0 # https://github.com/celery/django-celery-beat
{%- if cookiecutter.use_docker == 'y' %}
-flower==0.9.3 # https://github.com/mher/flower
+flower==1.2.0 # https://github.com/mher/flower
{%- endif %}
{%- endif %}
+{%- if cookiecutter.use_async == 'y' %}
+uvicorn[standard]==0.20.0 # https://github.com/encode/uvicorn
+{%- endif %}
# Django
# ------------------------------------------------------------------------------
-django==2.2.10 # pyup: < 3.0 # https://www.djangoproject.com/
-django-environ==0.4.5 # https://github.com/joke2k/django-environ
-django-model-utils==4.0.0 # https://github.com/jazzband/django-model-utils
-django-allauth==0.41.0 # https://github.com/pennersr/django-allauth
-django-crispy-forms==1.8.1 # https://github.com/django-crispy-forms/django-crispy-forms
-{%- if cookiecutter.use_compressor == "y" %}
-django-compressor==2.4 # https://github.com/django-compressor/django-compressor
+django==4.0.8 # pyup: < 4.1 # https://www.djangoproject.com/
+django-environ==0.9.0 # https://github.com/joke2k/django-environ
+django-model-utils==4.3.1 # https://github.com/jazzband/django-model-utils
+django-allauth==0.52.0 # https://github.com/pennersr/django-allauth
+django-crispy-forms==1.14.0 # https://github.com/django-crispy-forms/django-crispy-forms
+crispy-bootstrap5==0.7 # https://github.com/django-crispy-forms/crispy-bootstrap5
+{%- if cookiecutter.frontend_pipeline == 'Django Compressor' %}
+django-compressor==4.3.1 # https://github.com/django-compressor/django-compressor
{%- endif %}
-django-redis==4.11.0 # https://github.com/niwinz/django-redis
-
+django-redis==5.2.0 # https://github.com/jazzband/django-redis
+{%- if cookiecutter.use_drf == 'y' %}
# Django REST Framework
-djangorestframework==3.11.0 # https://github.com/encode/django-rest-framework
+djangorestframework==3.14.0 # https://github.com/encode/django-rest-framework
+django-cors-headers==3.13.0 # https://github.com/adamchainz/django-cors-headers
+# DRF-spectacular for api documentation
+drf-spectacular==0.25.1 # https://github.com/tfranzel/drf-spectacular
+{%- endif %}
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+django-webpack-loader==1.8.0 # https://github.com/django-webpack/django-webpack-loader
+{%- endif %}
diff --git a/{{cookiecutter.project_slug}}/requirements/local.txt b/{{cookiecutter.project_slug}}/requirements/local.txt
index e2f2b5815..ef0342a32 100644
--- a/{{cookiecutter.project_slug}}/requirements/local.txt
+++ b/{{cookiecutter.project_slug}}/requirements/local.txt
@@ -1,37 +1,48 @@
--r ./base.txt
+-r base.txt
-Werkzeug==1.0.0 # https://github.com/pallets/werkzeug
-ipdb==0.12.3 # https://github.com/gotcha/ipdb
-Sphinx==2.4.2 # https://github.com/sphinx-doc/sphinx
+Werkzeug[watchdog]==2.2.2 # https://github.com/pallets/werkzeug
+ipdb==0.13.11 # https://github.com/gotcha/ipdb
{%- if cookiecutter.use_docker == 'y' %}
-psycopg2==2.8.4 --no-binary psycopg2 # https://github.com/psycopg/psycopg2
+psycopg2==2.9.5 # https://github.com/psycopg/psycopg2
{%- else %}
-psycopg2-binary==2.8.4 # https://github.com/psycopg/psycopg2
+psycopg2-binary==2.9.5 # https://github.com/psycopg/psycopg2
+{%- endif %}
+{%- if cookiecutter.use_async == 'y' or cookiecutter.use_celery == 'y' %}
+watchfiles==0.18.1 # https://github.com/samuelcolvin/watchfiles
{%- endif %}
# Testing
# ------------------------------------------------------------------------------
-mypy==0.761 # https://github.com/python/mypy
-django-stubs==1.4.0 # https://github.com/typeddjango/django-stubs
-pytest==5.3.5 # https://github.com/pytest-dev/pytest
-pytest-sugar==0.9.2 # https://github.com/Frozenball/pytest-sugar
+mypy==0.982 # https://github.com/python/mypy
+django-stubs==1.14.0 # https://github.com/typeddjango/django-stubs
+pytest==7.2.1 # https://github.com/pytest-dev/pytest
+pytest-sugar==0.9.6 # https://github.com/Frozenball/pytest-sugar
+{%- if cookiecutter.use_drf == "y" %}
+djangorestframework-stubs==1.8.0 # https://github.com/typeddjango/djangorestframework-stubs
+{%- endif %}
+
+# Documentation
+# ------------------------------------------------------------------------------
+sphinx==5.3.0 # https://github.com/sphinx-doc/sphinx
+sphinx-autobuild==2021.3.14 # https://github.com/GaretJax/sphinx-autobuild
# Code quality
# ------------------------------------------------------------------------------
-flake8==3.7.9 # https://github.com/PyCQA/flake8
-coverage==5.0.3 # https://github.com/nedbat/coveragepy
-black==19.10b0 # https://github.com/ambv/black
-pylint-django==2.0.13 # https://github.com/PyCQA/pylint-django
+flake8==6.0.0 # https://github.com/PyCQA/flake8
+flake8-isort==6.0.0 # https://github.com/gforcada/flake8-isort
+coverage==7.1.0 # https://github.com/nedbat/coveragepy
+black==22.12.0 # https://github.com/psf/black
+pylint-django==2.5.3 # https://github.com/PyCQA/pylint-django
{%- if cookiecutter.use_celery == 'y' %}
pylint-celery==0.3 # https://github.com/PyCQA/pylint-celery
{%- endif %}
-pre-commit==2.1.0 # https://github.com/pre-commit/pre-commit
+pre-commit==3.0.1 # https://github.com/pre-commit/pre-commit
# Django
# ------------------------------------------------------------------------------
-factory-boy==2.12.0 # https://github.com/FactoryBoy/factory_boy
+factory-boy==3.2.1 # https://github.com/FactoryBoy/factory_boy
-django-debug-toolbar==2.2 # https://github.com/jazzband/django-debug-toolbar
-django-extensions==2.2.8 # https://github.com/django-extensions/django-extensions
-django-coverage-plugin==1.8.0 # https://github.com/nedbat/django_coverage_plugin
-pytest-django==3.8.0 # https://github.com/pytest-dev/pytest-django
+django-debug-toolbar==3.8.1 # https://github.com/jazzband/django-debug-toolbar
+django-extensions==3.2.1 # https://github.com/django-extensions/django-extensions
+django-coverage-plugin==3.0.0 # https://github.com/nedbat/django_coverage_plugin
+pytest-django==4.5.2 # https://github.com/pytest-dev/pytest-django
diff --git a/{{cookiecutter.project_slug}}/requirements/production.txt b/{{cookiecutter.project_slug}}/requirements/production.txt
index 974ae1e61..6936adffd 100644
--- a/{{cookiecutter.project_slug}}/requirements/production.txt
+++ b/{{cookiecutter.project_slug}}/requirements/production.txt
@@ -1,21 +1,44 @@
# PRECAUTION: avoid production dependencies that aren't in development
--r ./base.txt
+-r base.txt
-gunicorn==20.0.4 # https://github.com/benoitc/gunicorn
-psycopg2==2.8.4 --no-binary psycopg2 # https://github.com/psycopg/psycopg2
+gunicorn==20.1.0 # https://github.com/benoitc/gunicorn
+psycopg2==2.9.5 # https://github.com/psycopg/psycopg2
{%- if cookiecutter.use_whitenoise == 'n' %}
-Collectfast==1.3.2 # https://github.com/antonagestam/collectfast
+Collectfast==2.2.0 # https://github.com/antonagestam/collectfast
{%- endif %}
{%- if cookiecutter.use_sentry == "y" %}
-sentry-sdk==0.14.1 # https://github.com/getsentry/sentry-python
+sentry-sdk==1.14.0 # https://github.com/getsentry/sentry-python
+{%- endif %}
+{%- if cookiecutter.use_docker == "n" and cookiecutter.windows == "y" %}
+hiredis==2.1.1 # https://github.com/redis/hiredis-py
{%- endif %}
# Django
# ------------------------------------------------------------------------------
{%- if cookiecutter.cloud_provider == 'AWS' %}
-django-storages[boto3]==1.9.1 # https://github.com/jschneier/django-storages
+django-storages[boto3]==1.13.2 # https://github.com/jschneier/django-storages
{%- elif cookiecutter.cloud_provider == 'GCP' %}
-django-storages[google]==1.9.1 # https://github.com/jschneier/django-storages
+django-storages[google]==1.13.2 # https://github.com/jschneier/django-storages
+{%- elif cookiecutter.cloud_provider == 'Azure' %}
+django-storages[azure]==1.13.2 # https://github.com/jschneier/django-storages
+{%- endif %}
+{%- if cookiecutter.mail_service == 'Mailgun' %}
+django-anymail[mailgun]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Amazon SES' %}
+django-anymail[amazon_ses]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Mailjet' %}
+django-anymail[mailjet]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Mandrill' %}
+django-anymail[mandrill]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Postmark' %}
+django-anymail[postmark]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Sendgrid' %}
+django-anymail[sendgrid]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'SendinBlue' %}
+django-anymail[sendinblue]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'SparkPost' %}
+django-anymail[sparkpost]==9.0 # https://github.com/anymail/django-anymail
+{%- elif cookiecutter.mail_service == 'Other SMTP' %}
+django-anymail==9.0 # https://github.com/anymail/django-anymail
{%- endif %}
-django-anymail[mailgun]==7.0.0 # https://github.com/anymail/django-anymail
diff --git a/{{cookiecutter.project_slug}}/runtime.txt b/{{cookiecutter.project_slug}}/runtime.txt
index 6919bf9ed..69b0ccfc8 100644
--- a/{{cookiecutter.project_slug}}/runtime.txt
+++ b/{{cookiecutter.project_slug}}/runtime.txt
@@ -1 +1 @@
-python-3.7.6
+python-3.10.8
diff --git a/{{cookiecutter.project_slug}}/setup.cfg b/{{cookiecutter.project_slug}}/setup.cfg
index 5f7d9b655..7ee60215a 100644
--- a/{{cookiecutter.project_slug}}/setup.cfg
+++ b/{{cookiecutter.project_slug}}/setup.cfg
@@ -1,19 +1,30 @@
[flake8]
max-line-length = 120
-exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules
+exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules,venv,.venv
[pycodestyle]
max-line-length = 120
-exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules
+exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules,venv,.venv
+
+[isort]
+line_length = 88
+known_first_party = {{cookiecutter.project_slug}},config
+multi_line_output = 3
+default_section = THIRDPARTY
+skip = venv/
+skip_glob = **/migrations/*.py
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
[mypy]
-python_version = 3.7
+python_version = 3.10
check_untyped_defs = True
ignore_missing_imports = True
warn_unused_ignores = True
warn_redundant_casts = True
warn_unused_configs = True
-plugins = mypy_django_plugin.main
+plugins = mypy_django_plugin.main{% if cookiecutter.use_drf == "y" %}, mypy_drf_plugin.main{% endif %}
[mypy.plugins.django-stubs]
django_settings_module = config.settings.test
@@ -21,3 +32,9 @@ django_settings_module = config.settings.test
[mypy-*.migrations.*]
# Django migrations should not produce any errors:
ignore_errors = True
+
+[coverage:run]
+include = {{cookiecutter.project_slug}}/**
+omit = *migrations*, *tests*
+plugins =
+ django_coverage_plugin
diff --git a/{{cookiecutter.project_slug}}/tests/test_merge_production_dotenvs_in_dotenv.py b/{{cookiecutter.project_slug}}/tests/test_merge_production_dotenvs_in_dotenv.py
new file mode 100644
index 000000000..c0e68f60a
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/tests/test_merge_production_dotenvs_in_dotenv.py
@@ -0,0 +1,34 @@
+from pathlib import Path
+
+import pytest
+
+from merge_production_dotenvs_in_dotenv import merge
+
+
+@pytest.mark.parametrize(
+ ("input_contents", "expected_output"),
+ [
+ ([], ""),
+ ([""], "\n"),
+ (["JANE=doe"], "JANE=doe\n"),
+ (["SEP=true", "AR=ator"], "SEP=true\nAR=ator\n"),
+ (["A=0", "B=1", "C=2"], "A=0\nB=1\nC=2\n"),
+ (["X=x\n", "Y=y", "Z=z\n"], "X=x\n\nY=y\nZ=z\n\n"),
+ ],
+)
+def test_merge(
+ tmp_path: Path,
+ input_contents: list[str],
+ expected_output: str,
+):
+ output_file = tmp_path / ".env"
+
+ files_to_merge = []
+ for num, input_content in enumerate(input_contents, start=1):
+ merge_file = tmp_path / f".service{num}"
+ merge_file.write_text(input_content)
+ files_to_merge.append(merge_file)
+
+ merge(output_file, files_to_merge)
+
+ assert output_file.read_text() == expected_output
diff --git a/{{cookiecutter.project_slug}}/utility/install_python_dependencies.sh b/{{cookiecutter.project_slug}}/utility/install_python_dependencies.sh
index 517934841..e09ebf6f8 100755
--- a/{{cookiecutter.project_slug}}/utility/install_python_dependencies.sh
+++ b/{{cookiecutter.project_slug}}/utility/install_python_dependencies.sh
@@ -33,9 +33,8 @@ if [ -z "$VIRTUAL_ENV" ]; then
echo >&2 -e "\n"
exit 1;
else
-
pip install -r $PROJECT_DIR/requirements/local.txt
- {% if cookiecutter.use_heroku == "y" -%}
+ {%- if cookiecutter.use_heroku == "y" -%}
pip install -r $PROJECT_DIR/requirements.txt
{%- endif %}
fi
diff --git a/{{cookiecutter.project_slug}}/utility/requirements-bullseye.apt b/{{cookiecutter.project_slug}}/utility/requirements-bullseye.apt
new file mode 100644
index 000000000..60f602873
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/utility/requirements-bullseye.apt
@@ -0,0 +1,23 @@
+##basic build dependencies of various Django apps for Debian Bullseye 11.x
+#build-essential metapackage install: make, gcc, g++,
+build-essential
+#required to translate
+gettext
+python3-dev
+
+##shared dependencies of:
+##Pillow, pylibmc
+zlib1g-dev
+
+##Postgresql and psycopg2 dependencies
+libpq-dev
+
+##Pillow dependencies
+libtiff5-dev
+libjpeg62-turbo-dev
+libfreetype6-dev
+liblcms2-dev
+libwebp-dev
+
+##django-extensions
+libgraphviz-dev
diff --git a/{{cookiecutter.project_slug}}/utility/requirements-focal.apt b/{{cookiecutter.project_slug}}/utility/requirements-focal.apt
new file mode 100644
index 000000000..fe6f21e46
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/utility/requirements-focal.apt
@@ -0,0 +1,23 @@
+##basic build dependencies of various Django apps for Ubuntu Focal 20.04
+#build-essential metapackage install: make, gcc, g++,
+build-essential
+#required to translate
+gettext
+python3-dev
+
+##shared dependencies of:
+##Pillow, pylibmc
+zlib1g-dev
+
+##Postgresql and psycopg2 dependencies
+libpq-dev
+
+##Pillow dependencies
+libtiff5-dev
+libjpeg8-dev
+libfreetype6-dev
+liblcms2-dev
+libwebp-dev
+
+##django-extensions
+graphviz-dev
diff --git a/{{cookiecutter.project_slug}}/utility/requirements-jammy.apt b/{{cookiecutter.project_slug}}/utility/requirements-jammy.apt
new file mode 100644
index 000000000..63d1587e6
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/utility/requirements-jammy.apt
@@ -0,0 +1,23 @@
+##basic build dependencies of various Django apps for Ubuntu Jammy 22.04
+#build-essential metapackage install: make, gcc, g++,
+build-essential
+#required to translate
+gettext
+python3-dev
+
+##shared dependencies of:
+##Pillow, pylibmc
+zlib1g-dev
+
+##Postgresql and psycopg2 dependencies
+libpq-dev
+
+##Pillow dependencies
+libtiff5-dev
+libjpeg8-dev
+libfreetype6-dev
+liblcms2-dev
+libwebp-dev
+
+##django-extensions
+graphviz-dev
diff --git a/{{cookiecutter.project_slug}}/webpack/common.config.js b/{{cookiecutter.project_slug}}/webpack/common.config.js
new file mode 100644
index 000000000..41efb1c77
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/webpack/common.config.js
@@ -0,0 +1,55 @@
+const path = require('path');
+const BundleTracker = require('webpack-bundle-tracker');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+
+module.exports = {
+ target: "web",
+ context: path.join(__dirname, '../'),
+ entry: {
+ 'project': path.resolve(__dirname, '../{{cookiecutter.project_slug}}/static/js/project'),
+ 'vendors': path.resolve(__dirname, '../{{cookiecutter.project_slug}}/static/js/vendors'),
+ },
+ output: {
+ path: path.resolve(__dirname, '../{{cookiecutter.project_slug}}/static/webpack_bundles/'),
+ publicPath: '/static/webpack_bundles/',
+ filename: 'js/[name]-[fullhash].js',
+ chunkFilename: 'js/[name]-[hash].js',
+ },
+ plugins: [
+ new BundleTracker({filename: path.resolve(__dirname, '../webpack-stats.json')}),
+ new MiniCssExtractPlugin({ filename: 'css/[name].[contenthash].css' }),
+ ],
+ module: {
+ rules: [
+ // we pass the output from babel loader to react-hot loader
+ {
+ test: /\.js$/,
+ loader: 'babel-loader',
+ },
+ {
+ test: /\.s?css$/i,
+ use: [
+ MiniCssExtractPlugin.loader,
+ 'css-loader',
+ {
+ loader: 'postcss-loader',
+ options: {
+ postcssOptions: {
+ plugins: [
+ 'postcss-preset-env',
+ 'autoprefixer',
+ 'pixrem',
+ ],
+ },
+ },
+ },
+ 'sass-loader',
+ ],
+ },
+ ],
+ },
+ resolve: {
+ modules: ['node_modules'],
+ extensions: ['.js', '.jsx'],
+ },
+};
diff --git a/{{cookiecutter.project_slug}}/webpack/dev.config.js b/{{cookiecutter.project_slug}}/webpack/dev.config.js
new file mode 100644
index 000000000..c2f14abb1
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/webpack/dev.config.js
@@ -0,0 +1,20 @@
+const { merge } = require('webpack-merge');
+const commonConfig = require('./common.config');
+
+module.exports = merge(commonConfig, {
+ mode: 'development',
+ devtool: 'inline-source-map',
+ devServer: {
+ port: 3000,
+ proxy: {
+ {%- if cookiecutter.use_docker == 'n' %}
+ '/': 'http://0.0.0.0:8000',
+ {%- else %}
+ '/': 'http://django:8000',
+ {%- endif %}
+ },
+ // We need hot=false (Disable HMR) to set liveReload=true
+ hot: false,
+ liveReload: true,
+ },
+});
diff --git a/{{cookiecutter.project_slug}}/webpack/prod.config.js b/{{cookiecutter.project_slug}}/webpack/prod.config.js
new file mode 100644
index 000000000..b9c2186e5
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/webpack/prod.config.js
@@ -0,0 +1,28 @@
+const { merge } = require('webpack-merge');
+const commonConfig = require('./common.config');
+
+// This variable should mirror the one from config/settings/production.py
+{%- if cookiecutter.use_whitenoise == 'n' %}
+{%- if cookiecutter.cloud_provider == 'AWS' %}
+const s3BucketName = process.env.DJANGO_AWS_STORAGE_BUCKET_NAME;
+const awsS3Domain = process.env.DJANGO_AWS_S3_CUSTOM_DOMAIN ?
+ process.env.DJANGO_AWS_S3_CUSTOM_DOMAIN
+ : `${s3BucketName}.s3.amazonaws.com`;
+const staticUrl = `https://${awsS3Domain}/static/`;
+{%- elif cookiecutter.cloud_provider == 'GCP' %}
+const staticUrl = `https://storage.googleapis.com/${process.env.DJANGO_GCP_STORAGE_BUCKET_NAME}/static/`;
+{%- elif cookiecutter.cloud_provider == 'Azure' %}
+const staticUrl = `https://${process.env.DJANGO_AZURE_ACCOUNT_NAME}.blob.core.windows.net/static/`;
+{%- endif %}
+{%- else %}
+const staticUrl = '/static/';
+{%- endif %}
+
+module.exports = merge(commonConfig, {
+ mode: 'production',
+ devtool: 'source-map',
+ bail: true,
+ output: {
+ publicPath: `${staticUrl}webpack_bundles/`,
+ },
+});
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
index b4056707a..fb6532709 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
@@ -1,7 +1,5 @@
__version__ = "{{ cookiecutter.version }}"
__version_info__ = tuple(
- [
- int(num) if num.isdigit() else num
- for num in __version__.replace("-", ".", 1).split(".")
- ]
+ int(num) if num.isdigit() else num
+ for num in __version__.replace("-", ".", 1).split(".")
)
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/conftest.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/conftest.py
index 8cd51d7fe..7095a4714 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/conftest.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/conftest.py
@@ -1,5 +1,4 @@
import pytest
-from django.test import RequestFactory
from {{ cookiecutter.project_slug }}.users.models import User
from {{ cookiecutter.project_slug }}.users.tests.factories import UserFactory
@@ -11,10 +10,5 @@ def media_storage(settings, tmpdir):
@pytest.fixture
-def user() -> User:
+def user(db) -> User:
return UserFactory()
-
-
-@pytest.fixture
-def request_factory() -> RequestFactory:
- return RequestFactory()
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0003_set_site_domain_and_name.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0003_set_site_domain_and_name.py
index 8f4a8f997..080c734bb 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0003_set_site_domain_and_name.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0003_set_site_domain_and_name.py
@@ -7,23 +7,52 @@ from django.conf import settings
from django.db import migrations
+def _update_or_create_site_with_sequence(site_model, connection, domain, name):
+ """Update or create the site with default ID and keep the DB sequence in sync."""
+ site, created = site_model.objects.update_or_create(
+ id=settings.SITE_ID,
+ defaults={
+ "domain": domain,
+ "name": name,
+ },
+ )
+ if created:
+ # We provided the ID explicitly when creating the Site entry, therefore the DB
+ # sequence to auto-generate them wasn't used and is now out of sync. If we
+ # don't do anything, we'll get a unique constraint violation the next time a
+ # site is created.
+ # To avoid this, we need to manually update DB sequence and make sure it's
+ # greater than the maximum value.
+ max_id = site_model.objects.order_by('-id').first().id
+ with connection.cursor() as cursor:
+ cursor.execute("SELECT last_value from django_site_id_seq")
+ (current_id,) = cursor.fetchone()
+ if current_id <= max_id:
+ cursor.execute(
+ "alter sequence django_site_id_seq restart with %s",
+ [max_id + 1],
+ )
+
+
def update_site_forward(apps, schema_editor):
"""Set site domain and name."""
Site = apps.get_model("sites", "Site")
- Site.objects.update_or_create(
- id=settings.SITE_ID,
- defaults={
- "domain": "{{cookiecutter.domain_name}}",
- "name": "{{cookiecutter.project_name}}",
- },
+ _update_or_create_site_with_sequence(
+ Site,
+ schema_editor.connection,
+ "{{cookiecutter.domain_name}}",
+ "{{cookiecutter.project_name}}",
)
def update_site_backward(apps, schema_editor):
"""Revert site domain and name to default."""
Site = apps.get_model("sites", "Site")
- Site.objects.update_or_create(
- id=settings.SITE_ID, defaults={"domain": "example.com", "name": "example.com"}
+ _update_or_create_site_with_sequence(
+ Site,
+ schema_editor.connection,
+ "example.com",
+ "example.com",
)
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0004_alter_options_ordering_domain.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0004_alter_options_ordering_domain.py
new file mode 100644
index 000000000..f7118ca81
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/contrib/sites/migrations/0004_alter_options_ordering_domain.py
@@ -0,0 +1,21 @@
+# Generated by Django 3.1.7 on 2021-02-04 14:49
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("sites", "0003_set_site_domain_and_name"),
+ ]
+
+ operations = [
+ migrations.AlterModelOptions(
+ name="site",
+ options={
+ "ordering": ["domain"],
+ "verbose_name": "site",
+ "verbose_name_plural": "sites",
+ },
+ ),
+ ]
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/project.js b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/project.js
index d26d23b9b..62770f1c9 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/project.js
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/project.js
@@ -1 +1,5 @@
+{%- if cookiecutter.frontend_pipeline == 'Webpack' %}
+import '../sass/project.scss';
+{%- endif %}
+
/* Project specific Javascript goes here. */
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/vendors.js b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/vendors.js
new file mode 100644
index 000000000..093840f87
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/js/vendors.js
@@ -0,0 +1,2 @@
+import '@popperjs/core';
+import 'bootstrap';
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/sass/project.scss b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/sass/project.scss
index 9fbf1b746..c9511e720 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/sass/project.scss
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/static/sass/project.scss
@@ -1,8 +1,5 @@
-{% if cookiecutter.custom_bootstrap_compilation == 'y' %}
@import "custom_bootstrap_vars";
-@import "bootstrap";
-{% endif %}
-
+@import "~bootstrap/scss/bootstrap";
// project specific CSS goes here
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/templates/403.html b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/templates/403.html
index c02bd4e9e..4c4745f7d 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/templates/403.html
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/templates/403.html
@@ -5,5 +5,6 @@
{% block content %}
Forbidden (403)
-
CSRF verification failed. Request aborted.
-{% endblock content %}{% endraw %}
+
{% if exception %}{{ exception }}{% else %}You're not allowed to access this page.{% endif %}
{% trans 'The following e-mail addresses are associated with your account:' %}
+
{% translate 'The following e-mail addresses are associated with your account:' %}
{% else %}
-
{% trans 'Warning:'%} {% trans "You currently do not have any e-mail address set up. You should really add an e-mail address so you can receive notifications, reset your password, etc." %}
+
{% translate 'Warning:'%} {% translate "You currently do not have any e-mail address set up. You should really add an e-mail address so you can receive notifications, reset your password, etc." %}
{% if confirmation %}
{% user_display confirmation.email_address.user as user_display %}
-
{% blocktrans with confirmation.email_address.email as email %}Please confirm that {{ email }} is an e-mail address for user {{ user_display }}.{% endblocktrans %}
+
{% blocktranslate with confirmation.email_address.email as email %}Please confirm that {{ email }} is an e-mail address for user {{ user_display }}.{% endblocktranslate %}
{% else %}
{% url 'account_email' as email_url %}
-
{% get_providers as socialaccount_providers %}
{% if socialaccount_providers %}
-
{% blocktrans with site.name as site_name %}Please sign in with one
-of your existing third party accounts. Or, sign up
-for a {{ site_name }} account and sign in below:{% endblocktrans %}
+
+ {% translate "Please sign in with one of your existing third party accounts:" %}
+ {% if ACCOUNT_ALLOW_REGISTRATION %}
+ {% blocktranslate trimmed %}
+ Or, sign up
+ for a {{ site_name }} account and sign in below:
+ {% endblocktranslate %}
+ {% endif %}
+
-
+
-
- {% include "socialaccount/snippets/provider_list.html" with process="login" %}
-
+
+ {% include "socialaccount/snippets/provider_list.html" with process="login" %}
+
-
{% trans 'or' %}
+
{% translate "or" %}
-
+
-{% include "socialaccount/snippets/login_extra.html" %}
+ {% include "socialaccount/snippets/login_extra.html" %}
{% else %}
-
{% blocktrans %}If you have not created an account yet, then please
-sign up first.{% endblocktrans %}
+ {% if ACCOUNT_ALLOW_REGISTRATION %}
+
+ {% blocktranslate trimmed %}
+ If you have not created an account yet, then please
+ sign up first.
+ {% endblocktranslate %}
+
{% if token_fail %}
{% url 'account_reset_password' as passwd_reset_url %}
-
{% blocktrans %}The password reset link was invalid, possibly because it has already been used. Please request a new password reset.{% endblocktrans %}
+
{% blocktranslate %}The password reset link was invalid, possibly because it has already been used. Please request a new password reset.{% endblocktranslate %}
{% blocktrans %}We have sent an e-mail to you for verification. Follow the link provided to finalize the signup process. Please contact us if you do not receive it within a few minutes.{% endblocktrans %}
+
{% blocktranslate %}We have sent an e-mail to you for verification. Follow the link provided to finalize the signup process. Please contact us if you do not receive it within a few minutes.{% endblocktranslate %}
{% blocktrans %}This part of the site requires us to verify that
+
{% blocktranslate %}This part of the site requires us to verify that
you are who you claim to be. For this purpose, we require that you
-verify ownership of your e-mail address. {% endblocktrans %}
+verify ownership of your e-mail address. {% endblocktranslate %}
-
{% blocktrans %}We have sent an e-mail to you for
+
{% blocktranslate %}We have sent an e-mail to you for
verification. Please click on the link inside this e-mail. Please
-contact us if you do not receive it within a few minutes.{% endblocktrans %}
+
+