cookiecutter-django/{{cookiecutter.project_slug}}
Bruno Alla 69927387f8
Add type hint for UserFactory (#5312)
Since factory-boy 3.3.1, we can type annotate factories:

https://github.com/FactoryBoy/factory_boy/pull/1059

Setting that up for the only factory of the project
2024-08-21 10:35:20 +01:00
..
.devcontainer Rename docker compose files to include 'docker-compose' (#4995) 2024-05-13 18:18:56 +01:00
.envs Rename SendInBlue ESP to Brevo (#5094) 2024-05-27 14:46:12 +01:00
.github Rename docker compose files to include 'docker-compose' (#4995) 2024-05-13 18:18:56 +01:00
.idea Fix PyCharm Run Configurations After local.yml Rename (#5080) 2024-05-20 18:47:39 +01:00
{{cookiecutter.project_slug}} Add type hint for UserFactory (#5312) 2024-08-21 10:35:20 +01:00
bin Fix missing compilemessages step before deploying to prod (#4363) 2023-06-09 11:12:44 +01:00
compose Bump node from 20 to 22 (#5039) 2024-08-20 12:21:49 +02:00
config Migrate from Collectfast to Collestfasta (#5172) 2024-07-09 09:11:15 +01:00
docs Rename docker compose files to include 'docker-compose' (#4995) 2024-05-13 18:18:56 +01:00
locale Fix a typo in the option --all of the makemessages command (#5198) 2024-07-09 08:43:57 +01:00
requirements Update factory-boy from 3.3.0 to 3.3.1 2024-08-19 12:50:31 -03:00
tests Apply ruff to codebase 2024-02-13 11:59:55 +01:00
utility Update mentions of psycopg in comments (#4947) 2024-03-26 15:47:02 +00:00
webpack Bump webpack-dev-server to 5.0.2 (#4875) 2024-02-23 14:38:40 +00:00
.dockerignore Exclude env files from container image (add .envs/ to .dockerignore) (#4476) 2023-08-14 11:22:25 +01:00
.drone.yml Rename docker compose files to include 'docker-compose' (#4995) 2024-05-13 18:18:56 +01:00
.editorconfig Update indent for nginx config file (#4260) 2023-04-05 21:32:05 +01:00
.gitattributes Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitignore Replace Mailhog with Mailpit (#4551) 2023-09-06 20:41:01 +01:00
.gitlab-ci.yml Gitlab tags docker & python are removed from runner 2024-06-20 08:46:29 +02:00
.pre-commit-config.yaml Update ruff to 0.6.1 (#5303) 2024-08-17 19:17:11 +02:00
.readthedocs.yml Upgrade Python to version 3.12 2024-03-18 20:07:24 +01:00
.travis.yml Rename docker compose files to include 'docker-compose' (#4995) 2024-05-13 18:18:56 +01:00
CONTRIBUTORS.txt Revert "Added name to CONTRIBUTORS.txt" 2020-08-11 16:05:14 +01:00
COPYING Add GPLv3 licence support 2016-06-24 16:59:55 +02:00
docker-compose.docs.yml Remove obsolete version element from docker compose files (#5059) 2024-05-13 18:27:41 +01:00
docker-compose.local.yml Remove obsolete version element from docker compose files (#5059) 2024-05-13 18:27:41 +01:00
docker-compose.production.yml Remove obsolete version element from docker compose files (#5059) 2024-05-13 18:27:41 +01:00
gulpfile.js Replace deprecated uvicorn.workers with uvicorn-worker (#5110) 2024-06-08 14:56:02 +01:00
LICENSE Fix pre-commit hook issues 2021-04-07 20:57:04 +01:00
manage.py Apply ruff to codebase 2024-02-13 11:59:55 +01:00
merge_production_dotenvs_in_dotenv.py Apply ruff to codebase 2024-02-13 11:59:55 +01:00
package.json Bump sass-loader from 14.2.1 to 16.0.1 (#5309) 2024-08-20 12:24:04 +02:00
Procfile Replace deprecated uvicorn.workers with uvicorn-worker (#5110) 2024-06-08 14:56:02 +01:00
pyproject.toml Update ruff to 0.6.0 (#5300) 2024-08-15 16:36:59 +01:00
README.md Ruff as formatter & linter 2024-02-13 11:59:54 +01:00
requirements.txt Simplify post hook 2018-03-04 14:43:54 +03:00
runtime.txt Update Heroku Python runtime 2024-08-08 12:13:18 +01:00

{{cookiecutter.project_name}}

{{ cookiecutter.description }}

Built with Cookiecutter Django Ruff

{%- if cookiecutter.open_source_license != "Not open source" %}

License: {{cookiecutter.open_source_license}} {%- endif %}

Settings

Moved to settings.

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.

{%- if cookiecutter.use_celery == "y" %}

Celery

This app comes with Celery.

To run a celery worker:

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.

To run periodic tasks, you'll need to start the celery beat scheduler service. You can start it as a standalone process:

cd {{cookiecutter.project_slug}}
celery -A config.celery_app beat

or you can embed the beat service inside a worker with the -B option (not recommended for production use):

cd {{cookiecutter.project_slug}}
celery -A config.celery_app worker -B -l info

{%- endif %} {%- if cookiecutter.use_mailpit == "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 Mailpit with a web interface is available as docker container.

Container mailpit 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 Mailpit 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 Mailpit when generating the project a local SMTP server with a web interface will be available.

  1. Download the latest Mailpit release for your OS.

  2. Copy the binary file to the project root.

  3. Make it executable:

    $ chmod +x mailpit
    
  4. Spin up another terminal window and start it there:

    ./mailpit
    
  5. Check out http://127.0.0.1:8025/ to see how it goes.

Now you have your own mail server running locally, ready to receive whatever you send it.

{%- endif %}

{%- endif %} {%- if cookiecutter.use_sentry == "y" %}

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production. {%- endif %}

Deployment

The following details how to deploy this application. {%- if cookiecutter.use_heroku.lower() == "y" %}

Heroku

See detailed cookiecutter-django Heroku documentation.

{%- endif %} {%- if cookiecutter.use_docker.lower() == "y" %}

Docker

See detailed cookiecutter-django Docker documentation.

{%- 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, or get explanations on them in the Bootstrap docs.

Bootstrap's javascript as well as its dependencies are concatenated into a single file: static/js/vendors.js. {%- endif %}