Découvrez les bonnes pratiques de cookiecutter-django

introduction

Cet article est le 7ème jour du Calendrier de l'Avent Django 2016.

Que faire ici

• cookiecutter-Introduction de django
• Apprenez des packages utiles
• Apprenez des services externes utiles
• Apprendre la structure des répertoires

Qu'est-ce que Cookiecutter

https://github.com/audreyr/cookiecutter

A command-line utility that creates projects from cookiecutters (project templates). E.g. Python package projects, jQuery plugin projects.

Outil CLI pour créer un modèle pour les projets Python

$ pip install cookiecutter
$ cookiecutter [repository]

Qu'est-ce que cookiecutter-django?

• Introduit dans Two Scoops of Django: Best Practices for Django 1.8
• À propos de ce livre, @aki_yok le 5ème jour a dit Best of Django book! - blog akiyoko
• Paquets Django: Cookiecutters et [Recherche sur GitHub](https://github.com/search?utf8=%E2%9C%93&q= Le plus populaire dans django + cookiecutter)

$ cookiecutter https://github.com/pydanny/cookiecutter-django

Options de configuration

Project Generation Options — Cookiecutter Django 2016.49.3 documentation

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 [[email protected]]: [email protected]
description [A short description of the project.]: A reddit clone.
domain_name [example.com]: myreddit.com
version [0.1.0]: 0.0.1
timezone [UTC]: America/Los_Angeles
use_whitenoise [y]: n
use_celery [n]: y
use_mailhog [n]: n
use_sentry_for_error_reporting [y]: y
use_opbeat [n]: y
use_pycharm [n]: y
windows [n]: n
use_python3 [y]: y
use_docker [y]: n
use_heroku [n]: y
use_compressor [n]: y
Select postgresql_version:
1 - 9.5
2 - 9.4
3 - 9.3
4 - 9.2
Choose from 1, 2, 3, 4 [1]: 1
Select js_task_runner:
1 - Gulp
2 - Grunt
3 - Webpack
4 - None
Choose from 1, 2, 3, 4 [1]: 1
use_lets_encrypt [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
use_elasticbeanstalk_experimental: n

Features

• For Django 1.10
• Renders Django projects with 100% starting test coverage
• Twitter Bootstrap v4.0.0 - alpha 4 (maintained Foundation fork also available)
• 12-Factor based settings via django-environ
• Optimized development and production settings
• Registration via django-allauth
• Comes with custom user model ready to go
• Grunt build for compass and livereload
• Send emails via Anymail (using Mailgun by default, but switchable)
• Media storage using Amazon S3
• Docker support using docker-compose for development and production
• Procfile for deploying to Heroku
• Instructions for deploying to PythonAnywhere
• Works with Python 2.7.x or 3.5.x
• Run tests with unittest or py.test
• Customizable PostgreSQL version
• Experimental support for Amazon Elastic Beanstalk

Optional Integrations

• Serve static files from Amazon S3 or Whitenoise
• Configuration for Celery
• Integration with MailHog for local email testing
• Integration with Sentry for error logging
• Integration with Opbeat for performance monitoring

Présentation du package

• Bootstrap
• Cadre frontal
• django-environ
• Gestion des variables d'environnement
• django-allauth
• Vérification du compte
• django-anymail
• Backend de messagerie pour chaque ESP

Service pouvant être lié

• WhiteNoise
• Livraison de fichier statique
• La valeur par défaut est Amazon S3
• Celery
• File d'attente des tâches
• MailHog
• Test du courrier
• Sentry
• Suivi des erreurs
• Opbeat
• Suivi des performances

Structure du répertoire

~
├── compose
│   ├── django
│   │   ├── Dockerfile
│   │   ├── Dockerfile-dev
│   │   ├── entrypoint.sh
│   │   ├── gunicorn.sh
│   │   └── start-dev.sh
│   ├── nginx
│   │   ├── Dockerfile
│   │   └── nginx.conf
│   └── postgres
│       ├── Dockerfile
│       ├── backup.sh
│       ├── list-backups.sh
│       └── restore.sh
~
├── config
│   ├── __init__.py
│   ├── settings
│   │   ├── __init__.py
│   │   ├── common.py
│   │   ├── local.py
│   │   ├── production.py
│   │   └── test.py
│   ├── urls.py
│   └── wsgi.py
~
├── requirements
│   ├── base.txt
│   ├── local.txt
│   ├── production.txt
│   └── test.txt

• Créer un répertoire compose pour docker-compose
• Stocker les fichiers pour chaque environnement dans le répertoire settings
• Stocker les fichiers pour chaque environnement dans le répertoire requirements

Je pense que ce domaine sera utile. Pour les autres configurations, créez réellement un projet et vérifiez-le.

en conclusion

J'ai brièvement expliqué à propos de cookiecutter-django. Je pense que vous obtiendrez des informations sur le développement avec Django, alors n'hésitez pas à y toucher!

Au fait, dans le développement Django, si vous cochez Awesome Django, vous trouverez quelque chose de nouveau.