Cookiecutter Django Api

screenshot of Cookiecutter Django Api
django

Django API boilerplate

Overview

The Django API boilerplate provides a convenient starting point for developing Django API projects. It includes a range of helpful features, such as a Docker Compose local setup, Celery with Flower configuration, make-commands for project management, a GitLab CI pipeline, testing with py.test and django-dynamic-fixture, lint and type checking with auto formatting, built-in API documentation and JWT-authentication. The boilerplate also includes the ability to generate an actual database graph and is pre-configured with django-debug-toolbar and django-silk.

Features

  • Docker Compose local setup: Provides a minimal docker-image and a local development environment setup using Docker Compose.
  • Celery with Flower configuration included: Easily configure and use Celery and Flower for task scheduling and monitoring.
  • Convenient make-commands: Streamline project management tasks with pre-defined make-commands.
  • Fast testing Gitlab CI pipeline by default: Includes a default GitLab CI pipeline configuration for fast and efficient testing.
  • Testing with py.test and django-dynamic-fixture: Simplify testing by using py.test and django-dynamic-fixture.
  • Checking lint, types, and complexity with auto formatting: Ensures code quality by running lint, type, and complexity checks with auto formatting.
  • Built-in API doc and JWT-auth by default: Comes pre-configured with built-in API documentation and JWT-authentication.
  • Ability to generate actual db graph: Generates a database graph for easy visualization and understanding of the database structure.
  • django-debug-toolbar and django-silk configured: Includes pre-configured debugging tools for easier development and troubleshooting.

Summary

The Django API boilerplate provides a comprehensive starting point for Django API projects. With its range of features such as Docker Compose setup, Celery configuration, convenient make-commands, and pre-configured testing and debugging tools, developers can quickly set up a robust and efficient project structure. The boilerplate also includes installation instructions and references to other related projects for further inspiration and improvement.

django
Django

Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. It follows the model-view-controller (MVC) architectural pattern, providing an extensive set of built-in tools and conventions to streamline the creation of robust and scalable web applications.

docker
Docker

A website that uses Docker for containerization to streamline development, testing, and deployment workflows. This includes features such as containerization of dependencies, automated builds and deployments, and container orchestration to ensure scalability and availability.