https://github.com/tarsil/cookiecutter-django

Cookiecutter Django + PostGres + Docker + DramatiQ
https://github.com/tarsil/cookiecutter-django

async asyncio django djangorestframework dramatiq python python3

Last synced: 12 days ago
JSON representation

Cookiecutter Django + PostGres + Docker + DramatiQ

• Host: GitHub
• URL: https://github.com/tarsil/cookiecutter-django
• Owner: tarsil
• License: mit
• Created: 2017-12-20T15:46:47.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T21:05:46.000Z (6 months ago)
• Last Synced: 2024-10-19T10:25:55.803Z (25 days ago)
• Topics: async, asyncio, django, djangorestframework, dramatiq, python, python3
• Language: Python
• Homepage:
• Size: 859 KB
• Stars: 26
• Watchers: 3
• Forks: 15
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cookiecutter Django with PostGres + Docker + DramatiQ and optional APScheduler

![CI](https://github.com/tarsil/cookiecutter-django/actions/workflows/main.yml/badge.svg)

This is a cookiecutter application that aims to help people speeding up the development process.

We use [django-guardian](https://django-guardian.readthedocs.io/en/stable/) for user permissions

if not using external services (Auth0, Google...) as we see it fit and easy to use

as well as simple to manipulate complex object permissions.

## Table of Contents

- [Introduction](#introduction)

- [Requirements](#requirements)

- [Cookiecutter](#cookiecutter)

- [Task Manager](#task-manager)

- [Install the Template](#install-the-template)

---

## Introduction

Every time a new django project needs to be set, a lot of settings and configurations need to be

also set and this cookiecutter offers a lot of boilerplating including:

1. Login

2. Task Manager with Dramatiq

3. Django Rest Framework

4. Redis

5. RabbitMQ

6. PGBouncer for database accesses

7. [django-guardian](https://django-guardian.readthedocs.io/en/stable/)

8. MongoDB as Optional

All of this using docker.

## Requirements

To use this cookiecutter you should have at least.

1. [Docker](https://www.docker.com/products)

2. Python 3.8

3. Any virtual environment at your choice

## Cookiecutter

1. Cookiecutter - More details how to use and install [here](https://cookiecutter.readthedocs.io/en/latest/)

## Task Manager

This project implements [dramatiq](https://dramatiq.io/)

The project also contains inside the `development/settings.py` a `DRAMATIQ_BROKER` specially

designed for developement. For users used to `CELERY_TASK_ALWAYS_EAGER=True`, this broker

has a similar behaviour. Special thanks to @dnmellen for providing an alternative.

## Install the template

1. `cookiecutter https://github.com/tarsil/cookiecutter-django` and follow the instructions.

   **When giving a name to your project, avoid dashes by using underscores instead.**