pull/1/head
Vincent Adolphe 2021-04-20 23:45:35 +02:00
révision a23674bb8b
37 fichiers modifiés avec 2558 ajouts et 0 suppressions

0
.gitignore externe Normal file
Voir le fichier

7
CONTRIBUTORS.txt Normal file
Voir le fichier

@ -0,0 +1,7 @@
Ce template est développé au sein de Cliss XXI par :
- Ahmed Abdallah
- Jérôme Lebleu
- Vincent Adolphe
Il a également reçu l'aide de :
- François Decq

661
LICENSE Normal file

Fichier diff supprimé car celui-ci est trop grand Voir la Diff

51
README.md Normal file
Voir le fichier

@ -0,0 +1,51 @@
cookiecutter-django
===================
Un modèle [cookiecutter][] pour démarrer rapidement un nouveau *projet*
[Django][] à Cliss XXI.
[cookiecutter]: https://github.com/audreyr/cookiecutter/
[Django]: https://www.djangoproject.com/
## Fonctionnalités
Il est fortement inspiré de [cookiecutter-django][], ainsi qu'un peu de
[cookiecutter-simple-django][].
Les fonctionnalités principales sont les suivantes :
* définition de 2 environnements spécifiques, `production` et `development`,
avec leurs dépendances (dans `requirements/`) et configuration (dans
`<projet>/settings/`) spécifiques, en partageant une base commune ;
* utilisation des variables d'environnement pour configurer l'application ;
* possibilité de modifier et/ou étendre les *static* et les *templates*
localement, en dehors du dépôt ;
* embarquement de tout le code propre à l'application dans `<projet>/`, afin
de permettre par la suite d'en faire un paquet Python, installable sur le
système et mutualisable ;
* utilisation d'un `Makefile` pour faciliter le déploiement et d'autres
tâches récurrentes.
[cookiecutter-django]: https://github.com/pydanny/cookiecutter-django
[cookiecutter-simple-django]: https://github.com/marcofucci/cookiecutter-simple-django
## Utilisation
Il vous faudra tout d'abord installer `cookiecutter` sur votre système. Pour
ce faire, vu que le paquet dans Debian Jessie n'est pas très récent, vous
pouvez l'installer via [pip][].
$ cd <workspace>
$ virtualenv ./venv
$ source venv/bin/activate
$ pip install cookiecutter
Enfin, pour générer une nouvelle application depuis ce modèle, utilisez la
commande suivante :
$ cookiecutter https://forge.cliss21.org/cliss21/cookiecutter-django.git
Une série de questions vous seront posées afin d'ajuster l'application
générée à vos besoins.
[pip]: https://pypi.python.org/pypi/cookiecutter

16
TODO.md Normal file
Voir le fichier

@ -0,0 +1,16 @@
TODO
====
* compléter les paramètres en production, en commençant par vérifier la
[documentation](https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/) :
- définir une variable `LOGGING`,
- ajuster les variables en lien avec le HTTPS,
- optimiser la mise en cache,
- ...
* créer un `Makefile` avec plusieurs cibles : install, upgrade, clean, ...
Pour plus tard :
* permettre la création d'application multilingue, en :
- demandant le `LANGUAGE_CODE` à la génération,
- ajustant le template de base en fonction,
- créant les répertoires nécessaires.

9
cookiecutter.json Normal file
Voir le fichier

@ -0,0 +1,9 @@
{
"customer_name" : "Nom usager",
"project_slug": "creme_center_{{ cookiecutter.customer_name.lower()|replace(' ', '_')|replace('-', '_') }}",
"project_url": "https://forge.cliss21.org/cliss21/{{ cookiecutter.project_slug }}",
"author_name": "Cliss XXI",
"email": "tech@cliss21.com",
"description": "Une courte description du projet.",
"version": "0.1.0"
}

28
hooks/pre_gen_project.py Normal file
Voir le fichier

@ -0,0 +1,28 @@
import re
import sys
from keyword import iskeyword
TERMINATOR = "\x1b[0m"
ERROR = "\x1b[1;31mERROR: "
def die(message, retcode=1):
print('{ERROR}{}{TERMINATOR}'.format(message, **globals()))
sys.exit(retcode)
def isidentifier(value):
"""Determines if string is valid Python identifier.
Cookiecutter is run with Python 2 until Debian Buster, so we must have a
compatible check instead of the nice `isidentifier` method...
"""
return (
re.match(r'[_a-zA-Z][_a-zA-Z0-9]*$', value) is not None
and not iskeyword(value)
)
if not isidentifier('{{ cookiecutter.project_slug }}'):
die("'{{ cookiecutter.project_slug }}' project slug is not a valid "
"Python identifier.")

Voir le fichier

@ -0,0 +1,26 @@
# http://editorconfig.org
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.{py,rst,ini}]
indent_style = space
indent_size = 4
[*.py]
line_length = 80
[*.{html,css,scss,js,json,yml}]
indent_style = space
indent_size = 2
[*.md]
trim_trailing_whitespace = false
[Makefile]
indent_style = tab

Voir le fichier

@ -0,0 +1,3 @@
center_pilote/static/** -diff
assets/img/** -diff
assets/fonts/** -diff

Voir le fichier

@ -0,0 +1,40 @@
# Editors
*~
*.sw[po]
# Python
*.py[cod]
__pycache__
# Virtual environment
.env
venv
# Logs
logs
*.log
pip-log.txt
# Unit test / coverage reports
.coverage
.tox
nosetests.xml
htmlcov
# Translations
*.mo
*.pot
# Builds
center_pilote/static/
docs/build/
# Databases
sqlite.db
# Local configuration
config.env
# Local overrides and variable content
local/
var/

Voir le fichier

@ -0,0 +1,8 @@
# Changelog
All notable changes to {{ cookiecutter.project_slug }} will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]
### Added

Voir le fichier

@ -0,0 +1 @@
This software is developped by {{ cookiecutter.author_name }}.

Fichier diff supprimé car celui-ci est trop grand Voir la Diff

Voir le fichier

@ -0,0 +1,14 @@
recursive-include center_pilote *.js
recursive-include center_pilote *.css
recursive-include center_pilote *.woff
recursive-include center_pilote *.woff2
recursive-include center_pilote *.ttf
recursive-include center_pilote *.png
recursive-include center_pilote *.jpg
recursive-include center_pilote *.svg
recursive-include center_pilote *.ico
recursive-include center_pilote *.po
recursive-include center_pilote *.mo
recursive-include center_pilote *.txt
recursive-include center_pilote *.html
recursive-include center_pilote *.xml

Voir le fichier

@ -0,0 +1,151 @@
# -*- mode: makefile-gmake -*-
## Définition des variables
# Le nom de l'exécutable Python à utiliser ou son chemin absolu
# (ex. : python ou python3).
PYTHON_EXE := python3
# S'il faut utiliser un environnement virtuel (y ou n).
USE_VENV := y
# Configuration de l'environnement virtuel.
VENV_DIR := venv
VENV_OPT := --system-site-packages
# Définis les chemins et options des exécutables.
PYTHON_EXE_BASENAME := $(shell basename $(PYTHON_EXE))
VENV_PYTHON := --python=$(PYTHON_EXE_BASENAME)
ifeq ($(USE_VENV), y)
PYTHON := $(VENV_DIR)/bin/$(PYTHON_EXE_BASENAME)
PIP := $(VENV_DIR)/bin/pip
else
PYTHON := $(shell which $(PYTHON_EXE))
PIP := $(shell which pip)
endif
# Détermine l'environnement à utiliser.
ifndef ENV
ifdef DJANGO_SETTINGS_MODULE
ENV = $(shell echo $(DJANGO_SETTINGS_MODULE) | cut -d. -f3)
else
DEFAULT_ENV := production
ENV = $(shell \
sed -n '/^ENV/s/[^=]*=\(.*\)/\1/p' config.env 2> /dev/null \
| tail -n 1 | grep -Ee '^..*' || echo "$(DEFAULT_ENV)")
endif
endif
# Définis EDITOR pour l'édition interactive.
ifndef EDITOR
ifdef VISUAL
EDITOR := $(VISUAL)
else
EDITOR := vi
endif
endif
# Définition des cibles -------------------------------------------------------
.PHONY: clean-pyc clean-build clean-static clear-venv help check check-config
.DEFAULT_GOAL := help
# Commentaire d'une cible : #-> interne ##-> aide production+dev ###-> aide dev
help: ## affiche cette aide
ifeq ($(ENV), production)
@perl -nle'print $& if m{^[a-zA-Z_-]+:[^#]*?## .*$$}' $(MAKEFILE_LIST) \
| sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'
else
@perl -nle'print $& if m{^[a-zA-Z_-]+:[^#]*?###? .*$$}' $(MAKEFILE_LIST) \
| sort | awk 'BEGIN {FS = ":.*?###? "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'
endif
clean: clean-build clean-pyc clean-static ## nettoie tous les fichiers temporaires
clean-build: ### nettoie les fichiers de construction du paquet
rm -rf build/
rm -rf dist/
rm -rf *.egg-info
clean-pyc: ### nettoie les fichiers temporaires python
find center_pilote/ \
\( -name '*.pyc' -o -name '*.pyo' -o -name '*~' \) -exec rm -f {} +
clean-static: ### nettoie les fichiers "static" collectés
rm -rf var/static
init: create-venv config.env ## initialise l'environnement et l'application
@$(MAKE) --no-print-directory update
config.env:
cp config.env.example config.env
chmod go-rwx config.env
$(EDITOR) config.env
update: check-config install-deps migrate static populate ## mets à jour l'application et ses dépendances
touch center_pilote/wsgi.py
check: check-config ## vérifie la configuration de l'instance
$(PYTHON) manage.py check
check-config:
@find . -maxdepth 1 -name config.env -perm /o+rwx -exec false {} + || \
{ echo "\033[31mErreur :\033[0m les permissions de config.env ne sont pas bonnes, \
vous devriez au moins faire : chmod o-rwx config.env"; false; }
install-deps: ## installe les dépendances de l'application
$(PIP) install --upgrade --requirement requirements/$(ENV).txt
migrate: ## mets à jour le schéma de la base de données
$(PYTHON) manage.py migrate
static: ## collecte les fichiers statiques
@echo "Collecte des fichiers statiques..."
$(PYTHON) manage.py generatemedia
populate: ## peuple la base de donnee
$(PYTHON) manage.py creme_populate
## Cibles liées à l'environnement virtuel
create-venv: $(PYTHON)
$(PYTHON):
ifeq ($(USE_VENV), y)
virtualenv $(VENV_OPT) $(VENV_PYTHON) $(VENV_DIR)
else
@echo "\033[31mErreur !\033[0m Impossible de trouver l'exécutable Python $(PYTHON)"
@exit 1
endif
clear-venv: ## supprime l'environnement virtuel
-rm -rf $(VENV_DIR)
## Cibles pour le développement
serve: ### démarre un serveur local pour l'application
$(PYTHON) manage.py runserver
test: ### lance les tests de l'application
$(PYTHON) -m pytest --cov --cov-report=term:skip-covered
test-wip: #### lance les tests marqués 'wip'
$(PYTHON) -m pytest -vv -m 'wip' --pdb
test-failed: #### lance les tests qui ont échoué
$(PYTHON) -m pytest --lf
coverage: test ### vérifie la couverture de code
$(PYTHON) -m coverage html
@echo open htmlcov/index.html
lint: ### vérifie la syntaxe du code Python
@$(PYTHON) -m flake8 center_pilote || \
{ echo "\033[31mErreur !\033[0m Veuillez corriger la syntaxe avec : make format"; false; }
format: ### formate le code Python
$(PYTHON) -m isort center_pilote
$(PYTHON) -m black center_pilote
shell: ### lance un shell Python dans l'environnement
ifeq ($(ENV), production)
$(PYTHON) manage.py shell
else
$(PYTHON) manage.py shell_plus
endif

Voir le fichier

@ -0,0 +1,154 @@
# {{ cookiecutter.project_slug }}
{{ cookiecutter.description }}
**Table of content**
- [Give a try](#give-a-try)
- [Installation](#installation)
- [Deployment](#deployment)
- [Structure](#structure)
- [Development](#development)
## Give a try
On a Debian-based host - running at least Debian Stretch:
```shell
$ sudo apt install python3 virtualenv git make
$ git clone {{ cookiecutter.project_url }}
$ cd {{ cookiecutter.project_slug }}/
$ make init
# A configuration file will be created interactively; you can uncomment:
# ENV=development
$ make serve
```
Then visit [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your web browser.
## Installation
### Requirements
On a Debian-based host - running at least Debian Stretch, you will need the
following packages:
- `python3`
- `virtualenv`
- `make`
- `git` (recommended for getting the source)
- `python3-mysqldb` (optional, in case of a MySQL / MariaDB database)
- `python3-psycopg2` (optional, in case of a PostgreSQL database)
### Quick start
It assumes that you already have the application source code locally - the best
way is by cloning this repository - and that you are in this folder.
1. Define your local configuration in a file named `config.env`, which can be
copied from `config.env.example` and edited to suits your needs.
Depending on your environment, you will have to create your database and the
user at first.
2. Run `make init`.
Note that if there is no `config.env` file, it will be created interactively.
That's it! Your environment is now initialized with the application installed.
To update it, once the source code is checked out, simply run `make update`.
You can also check that your application is well configured by running
`make check`.
## Deployment
### Web application
Here is an example deployment using NGINX - as the Web server - and uWSGI - as
the application server.
#### uWSGI
The uWSGI configuration doesn't require a special configuration, except that we
are using Python 3 and a virtual environment. Note that if you serve the
application on a sub-location, you will have to add `route-run = fixpathinfo:`
to your uWSGI configuration (available since [v2.0.11][1]).
[1]: https://uwsgi-docs.readthedocs.io/en/latest/Changelog-2.0.11.html#fixpathinfo-routing-action
#### NGINX
In the `server` block of your NGINX configuration, add the following blocks and
set the path to your application instance and to the uWSGI socket:
```nginx
location / {
include uwsgi_params;
uwsgi_pass unix:<uwsgi_socket_path>;
}
location /media {
alias <app_instance_path>/var/media;
}
location /static {
alias <app_instance_path>/var/static;
# Optional: don't log access to assets
access_log off;
}
location = /favicon.ico {
alias <app_instance_path>/var/static/favicon/favicon.ico;
# Optional: don't log access to the favicon
access_log off;
}
```
## Structure
### Overview
All the application files - e.g. Django code including settings, templates and
statics - are located into `{{ cookiecutter.project_slug }}/`.
Two environments are defined - either for requirements and settings:
- `development`: for local application development and testing. It uses a
SQLite3 database and enable debugging by default, add some useful settings
and applications for development purpose - i.e. the `django-debug-toolbar`.
- `production`: for production. It checks that configuration is set and
correct, try to optimize performances and enforce some settings - i.e. HTTPS
related ones.
### Local changes
You can override and extend statics and templates locally. This can be useful
if you have to change the logo for a specific instance for example. For that,
just put your files under the `local/static/` and `local/templates/` folders.
Regarding the statics, do not forget to collect them after that. Note also that
the `local/` folder is ignored by *git*.
### Variable content
All the variable content - e.g. user-uploaded media, collected statics - are
stored inside the `var/` folder. It is also ignored by *git* as it's specific
to each application installation.
So, you will have to configure your Web server to serve the `var/media/` and
`var/static/` folders, which should point to `/media/` and `/static/`,
respectively.
## Development
The easiest way to deploy a development environment is by using the `Makefile`.
Before running `make init`, ensure that you have either set `ENV=development`
in the `config.env` file or have this environment variable. Note that you can
still change this variable later and run `make init` again.
There is some additional rules when developing, which are mainly wrappers for
`manage.py`. You can list all of them by running `make help`. Here are the main ones:
- `make serve`: run a development server
- `make test`: test the whole application
- `make lint`: check the Python code syntax
## License
{{ cookiecutter.project_slug }} is developed by {{ cookiecutter.author_name }} and licensed under the
[AGPLv3+](LICENSE).

Voir le fichier

@ -0,0 +1 @@
__version__ = '{{ cookiecutter.version }}'

Voir le fichier

@ -0,0 +1 @@
default_app_config = 'center_pilote.pilote_extended.apps.PiloteExtendedConfig'

Voir le fichier

@ -0,0 +1,6 @@
from django.apps import AppConfig
class PiloteExtendedConfig(AppConfig):
name = 'center_pilote.pilote_extended'
verbose_name = "Pilote Extented"

Voir le fichier

@ -0,0 +1,24 @@
import environ
"""The default environment to use."""
DEFAULT_ENVIRONMENT = 'production'
"""The environment variables of the app instance."""
env = environ.Env()
"""Path to the package root - e.g. Django project."""
root_dir = environ.Path(__file__) - 2
"""Path to the base directory of the app instance."""
base_dir = env.path('BASE_DIR', default=str(root_dir - 1))
# Load config.env, OS environment variables will take precedence
env.read_env(str(base_dir.path('config.env')))
"""The Django settings module's name to use."""
DJANGO_SETTINGS_MODULE = env(
'DJANGO_SETTINGS_MODULE',
default='center_pilote.settings.{}'.format(
env('ENV', default=DEFAULT_ENVIRONMENT)
),
)

Voir le fichier

@ -0,0 +1,205 @@
"""
Django settings for {{ cookiecutter.project_slug }} project.
For more information on this file, see
https://docs.djangoproject.com/en/stable/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/stable/ref/settings/
"""
from creme.settings import * # NOQA
import os.path
from email.utils import getaddresses
from . import base_dir, env, root_dir
# ENVIRONMENT VARIABLES AND PATHS
# ------------------------------------------------------------------------------
# Local directory used for static and templates overrides
local_dir = base_dir.path('local')
# Directory for variable stuffs, i.e. user-uploaded media
var_dir = base_dir.path('var')
if not os.path.isdir(var_dir()):
os.mkdir(var_dir(), mode=0o755)
# Location on which the application is served
APP_LOCATION = env('APP_LOCATION', default='/')
# GENERAL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#debug
DEBUG = env.bool('DJANGO_DEBUG', default=True)
# Local time zone for this installation
TIME_ZONE = 'Europe/Paris'
# https://docs.djangoproject.com/en/stable/ref/settings/#language-code
LANGUAGE_CODE = 'fr'
# https://docs.djangoproject.com/en/dev/ref/settings/#site-id
SITE_ID = 1
# https://docs.djangoproject.com/en/stable/ref/settings/#use-i18n
USE_I18N = True
# https://docs.djangoproject.com/en/stable/ref/settings/#use-l10n
USE_L10N = True
# https://docs.djangoproject.com/en/stable/ref/settings/#use-tz
USE_TZ = True
# DATABASES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#databases
# https://django-environ.readthedocs.io/en/stable/#supported-types
DATABASES = {
'default': env.db(
'DJANGO_DATABASE_URL',
default='sqlite:///{}'.format(base_dir('sqlite.db')),
)
}
# URLS
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#root-urlconf
# ROOT_URLCONF already defined by creme
# https://docs.djangoproject.com/en/stable/ref/settings/#wsgi-application
WSGI_APPLICATION = 'center_pilote.wsgi.application'
# APP CONFIGURATION
# ------------------------------------------------------------------------------
# INSTALLED_DJANGO_APPS already defined by creme
# Project applications
LOCAL_APPS = ['django_fieldbustier', 'center_pilote.pilote_extended']
INSTALLED_CREME_APPS = [
# CREME CORE APPS
'creme.creme_core',
'creme.creme_config',
'creme.documents',
'creme.activities', # Extra features if 'assistants' is installed.
'creme.persons',
# CREME OPTIONAL APPS (can be safely commented)
'creme.assistants',
'creme.graphs',
'creme.reports',
'creme.products',
'creme.recurrents',
'creme.billing', # Need 'products'
'creme.opportunities', # Need 'products'. Extra features if 'billing' is installed.
'creme.commercial', # Need 'opportunities'
'creme.events', # Need 'opportunities'
'creme.crudity',
'creme.emails', # Extra features if 'crudity' is installed.
# 'creme.sms', # Work In Progress
'creme.projects',
'creme.tickets',
# 'creme.cti',
'creme.vcfs',
# 'creme.polls', # Need 'commercial'
# 'creme.mobile',
'creme.geolocation',
]
# https://docs.djangoproject.com/en/stable/ref/settings/#installed-apps
INSTALLED_APPS = INSTALLED_DJANGO_APPS + LOCAL_APPS + INSTALLED_CREME_APPS
# PASSWORDS
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#password-hashers
PASSWORD_HASHERS = [
# https://docs.djangoproject.com/en/stable/topics/auth/passwords/#using-argon2-with-django
# 'django.contrib.auth.hashers.Argon2PasswordHasher',
'django.contrib.auth.hashers.PBKDF2PasswordHasher',
'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
'django.contrib.auth.hashers.BCryptSHA256PasswordHasher',
'django.contrib.auth.hashers.BCryptPasswordHasher',
]
# https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation
# AUTH_PASSWORD_VALIDATORS # already defined by creme
# MIDDLEWARE
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#middleware
# MIDDLEWARE # already defined by creme
# STATIC
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#static-files
STATIC_ROOT = var_dir('static')
# https://docs.djangoproject.com/en/stable/ref/settings/#static-url
STATIC_URL = os.path.join(APP_LOCATION, 'static/')
# https://docs.djangoproject.com/en/stable/ref/settings/#staticfiles-dirs
STATICFILES_DIRS = [root_dir('static')]
if os.path.isdir(local_dir('static')):
STATICFILES_DIRS.insert(0, local_dir('static'))
# https://docs.djangoproject.com/en/stable/ref/contrib/staticfiles/#staticfiles-finders
STATICFILES_FINDERS = [
'django.contrib.staticfiles.finders.FileSystemFinder',
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
]
# MEDIA
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#media-root
# MEDIA_ROOT = var_dir('media') # already defined by creme
# https://docs.djangoproject.com/en/stable/ref/settings/#media-url
# MEDIA_URL = os.path.join(APP_LOCATION, 'media/') # already defined by creme
GENERATED_MEDIA_DIR = var_dir('static/')
# https://docs.djangoproject.com/en/stable/ref/settings/#file-upload-directory-permissions
FILE_UPLOAD_DIRECTORY_PERMISSIONS = 0o755
# https://docs.djangoproject.com/en/stable/ref/settings/#file-upload-permissions
FILE_UPLOAD_PERMISSIONS = 0o644
# TEMPLATES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#templates
# TEMPLATES # already defined by creme
TEMPLATES[0]['DIRS'].insert(0, root_dir('templates'))
if os.path.isdir(local_dir('templates')):
TEMPLATES[0]['DIRS'].insert(0, local_dir('templates'))
# FIXTURES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#fixture-dirs
FIXTURE_DIRS = [root_dir('fixtures')]
# EMAIL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/topics/email/#email-backends
# https://django-environ.readthedocs.io/en/stable/#supported-types
vars().update(env.email_url('DJANGO_EMAIL_URL', default='smtp://localhost:25'))
DEFAULT_FROM_EMAIL = env('DEFAULT_FROM_EMAIL', default='webmaster@localhost')
# Use the same email address for error messages
SERVER_EMAIL = DEFAULT_FROM_EMAIL
# ADMIN
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#admins
ADMINS = getaddresses([env('ADMINS', default='{{ cookiecutter.author_name }} <{{ cookiecutter.email }}>')])
# https://docs.djangoproject.com/en/stable/ref/settings/#managers
MANAGERS = ADMINS
# SESSIONS AND COOKIES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#session-cookie-path
SESSION_COOKIE_PATH = APP_LOCATION
# https://docs.djangoproject.com/en/stable/ref/settings/#csrf-cookie-path
CSRF_COOKIE_PATH = APP_LOCATION
# ------------------------------------------------------------------------------
# APPLICATION AND 3RD PARTY LIBRARY SETTINGS
# ------------------------------------------------------------------------------

Voir le fichier

@ -0,0 +1,45 @@
"""
Development settings.
- use Console backend for emails sending by default
- add the django-debug-toolbar
"""
from .base import * # noqa
from .base import INSTALLED_APPS, MIDDLEWARE, env
# GENERAL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#secret-key
SECRET_KEY = env('DJANGO_SECRET_KEY', default='CHANGEME!!!')
# https://docs.djangoproject.com/en/stable/ref/settings/#allowed-hosts
ALLOWED_HOSTS = env.list(
'DJANGO_ALLOWED_HOSTS', default=['localhost', '0.0.0.0', '127.0.0.1']
)
# EMAIL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/topics/email/#email-backends
# https://django-environ.readthedocs.io/en/stable/#supported-types
vars().update(env.email_url('DJANGO_EMAIL_URL', default='consolemail://'))
# ------------------------------------------------------------------------------
# APPLICATION AND 3RD PARTY LIBRARY SETTINGS
# ------------------------------------------------------------------------------
# DJANGO DEBUG TOOLBAR
# ------------------------------------------------------------------------------
# https://django-debug-toolbar.readthedocs.io/en/stable/installation.html
if env.bool('DJANGO_DEBUG_TOOLBAR', default=False):
MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']
INSTALLED_APPS += ['debug_toolbar']
INTERNAL_IPS = ['127.0.0.1']
DEBUG_TOOLBAR_CONFIG = {
'DISABLE_PANELS': ['debug_toolbar.panels.redirects.RedirectsPanel'],
'SHOW_TEMPLATE_CONTEXT': True,
}
# DJANGO EXTENSIONS
# ------------------------------------------------------------------------------
# https://django-extensions.readthedocs.io/en/stable/index.html
INSTALLED_APPS += ['django_extensions']

Voir le fichier

@ -0,0 +1,106 @@
"""
Production settings.
- validate the configuration
- disable debug mode
- load secret key from environment variables
- set other production configurations
"""
import os
from django.core.exceptions import ImproperlyConfigured
from .base import * # noqa
from .base import TEMPLATES, env, var_dir
# CONFIGURATION VALIDATION
# ------------------------------------------------------------------------------
# Ensure that the database configuration has been set
if not env('DJANGO_DATABASE_URL', default=None):
raise ImproperlyConfigured(
"No database configuration has been set, you should check "
"the value of your DATABASE_URL environment variable."
)
# Ensure that the default email address has been set
if not env('DEFAULT_FROM_EMAIL', default=None):
raise ImproperlyConfigured(
"No default email address has been set, you should check "
"the value of your DEFAULT_FROM_EMAIL environment variable."
)
# GENERAL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#debug
DEBUG = False
# https://docs.djangoproject.com/en/stable/ref/settings/#secret-key
SECRET_KEY = env('DJANGO_SECRET_KEY')
# https://docs.djangoproject.com/en/stable/ref/settings/#allowed-hosts
ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=[])
# TEMPLATES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#templates
TEMPLATES[0]['OPTIONS']['debug'] = DEBUG
TEMPLATES[0]['OPTIONS']['loaders'] = [
(
'django.template.loaders.cached.Loader',
[
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
],
)
]
# LOGGING
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/topics/logging/
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'verbose': {
'format': '%(asctime)s - %(levelname)s - %(module)s: %(message)s'
}
},
'handlers': {
'mail_admins': {
'level': 'ERROR',
'class': 'django.utils.log.AdminEmailHandler',
},
'file': {
'level': 'DEBUG',
'class': 'logging.handlers.TimedRotatingFileHandler',
'filename': var_dir('log/{{ cookiecutter.project_slug }}.log'),
'formatter': 'verbose',
'when': 'midnight',
'interval': 1,
'backupCount': 30,
},
},
'loggers': {
'django': {
'level': 'WARNING',
'handlers': ['file'],
'propagate': True,
},
'django.request': {
'level': 'WARNING',
'handlers': ['file', 'mail_admins'],
'propagate': True,
},
'center_pilote': {
'level': 'INFO',
'handlers': ['file', 'mail_admins'],
'propagate': True,
},
},
}
if not os.path.isdir(var_dir('log')):
os.mkdir(var_dir('log'), mode=0o750)
# ------------------------------------------------------------------------------
# APPLICATION AND 3RD PARTY LIBRARY SETTINGS
# ------------------------------------------------------------------------------

Voir le fichier

@ -0,0 +1,54 @@
"""
With these settings, tests run faster.
"""
from .base import * # noqa
from .base import TEMPLATES, env
# GENERAL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#debug
DEBUG = False
# https://docs.djangoproject.com/en/stable/ref/settings/#secret-key
SECRET_KEY = env('DJANGO_SECRET_KEY', default='CHANGEME!!!')
# https://docs.djangoproject.com/en/stable/ref/settings/#test-runner
TEST_RUNNER = 'django.test.runner.DiscoverRunner'
# CACHES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#caches
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': '',
}
}
# PASSWORDS
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#password-hashers
PASSWORD_HASHERS = ['django.contrib.auth.hashers.MD5PasswordHasher']
# TEMPLATES
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#templates
TEMPLATES[0]['OPTIONS']['debug'] = DEBUG
TEMPLATES[0]['OPTIONS']['loaders'] = [
(
'django.template.loaders.cached.Loader',
[
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
],
)
]
# EMAIL
# ------------------------------------------------------------------------------
# https://docs.djangoproject.com/en/stable/ref/settings/#email-backend
EMAIL_BACKEND = 'django.core.mail.backends.locmem.EmailBackend'
# https://docs.djangoproject.com/en/stable/ref/settings/#email-host
EMAIL_HOST = 'localhost'
# https://docs.djangoproject.com/en/stable/ref/settings/#email-port
EMAIL_PORT = 1025

Voir le fichier

@ -0,0 +1,21 @@
"""
WSGI config for {{ cookiecutter.project_slug }} project.
This module contains the WSGI application used by Django's development server
and any production WSGI deployments. It should expose a module-level variable
named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
this application via the ``WSGI_APPLICATION`` setting.
"""
import os
from django.core.wsgi import get_wsgi_application
from center_pilote.settings import DJANGO_SETTINGS_MODULE
# Set the default settings module to use.
os.environ.setdefault('DJANGO_SETTINGS_MODULE', DJANGO_SETTINGS_MODULE)
# This application object is used by any WSGI server configured to use this
# file. This includes Django's development server, if the WSGI_APPLICATION
# setting points here.
application = get_wsgi_application()

Voir le fichier

@ -0,0 +1,105 @@
###########################################################
# #
# Edit the following configuration to suits your needs. #
# #
###########################################################
###############################################################################
# MAINS SETTINGS
###############################################################################
# Environment to use within the application.
#
# The environment is used to load the proper settings for your application
# instance. There is two ways for defining it, with the following precedence:
# - DJANGO_SETTINGS_MODULE: the Python path to the settings module to use. It
# allows you to define and use your own settings module. Use it with care!
# Note: the module name will be used as the environment.
# - ENV: the environment to use, which is one of 'production' or 'development'.
#
# Default is the 'production' environment.
#ENV=production
#ENV=development
# The secret key used to provide cryptographic signing.
#
# It should be set to a unique, unpredictable value. On a GNU/Linux system, you
# could generate a new one with:
#
# $ head -c50 /dev/urandom | base64
#
# /!\ Required in production.
#DJANGO_SECRET_KEY=CHANGEME!!!
# A coma-separated string representing the host/domain names that this
# application instance can serve.
#
# /!\ Required in production.
#DJANGO_ALLOWED_HOSTS=example.org,
###############################################################################
# DATABASE SETTINGS
###############################################################################
# Database configuration, as an URI.
#
# In production, the recommended database backend for better performances is
# PostgreSQL - or MySQL if you prefer.
#
# Default is a SQLite database in development only.
#
# /!\ Required in production.
#DJANGO_DATABASE_URL=postgres://user:password@127.0.0.1:5432/{{ cookiecutter.project_slug }}
#DJANGO_DATABASE_URL=mysql://user:password@127.0.0.1:3306/{{ cookiecutter.project_slug }}
###############################################################################
# EMAILS SETTINGS
###############################################################################
# Email configuration for sending messages, as an URI.
#
# In production, you should either use a local SMTP server or a relay one. The
# URI will be in that case of the form:
#
# PROTOCOL://[USER:PASSWORD@]HOST[:PORT]
#
# PROTOCOL can be smtp, smtp+ssl or smtp+tls. Note that special characters
# in USER and PASSWORD - e.g. @ - must be escaped. It can be achieve with:
#
# $ python3 -c 'from urllib.parse import quote as q;print(q("USER")+":"+q("PASSWORD"))'
#
# Default is the local SMTP server in production and the console in development.
#DJANGO_EMAIL_URL=smtp://localhost:25
# Default email address to use for various automated correspondence.
#
# /!\ Required in production.
#DEFAULT_FROM_EMAIL=webmaster@example.org
# A comma separated list of all the people who get production error
# notifications, following rfc2822 format
#ADMINS='{{ cookiecutter.author_name }} <{{ cookiecutter.email }}>'
###############################################################################
# MISC SETTINGS
###############################################################################
# URL prefix on which the application is served.
#
# This is used to generate the static and media URLs, but also links to the
# application which require an absolute URL.
#
# Default is '/', e.g. at the domain root.
#APP_LOCATION=/
# Base directory of the app instance, where the local and var folders are
# located.
#
# Default is the current directory.
#BASE_DIR=
# Turn on/off debug mode.
#
# Note that it's always disabled in production.
#DJANGO_DEBUG=off
#DJANGO_DEBUG_TOOLBAR=on

Voir le fichier

@ -0,0 +1,27 @@
#!/usr/bin/env python
import os
import sys
from center_pilote.settings import DJANGO_SETTINGS_MODULE
if __name__ == "__main__":
# Set the default settings module to use.
os.environ.setdefault('DJANGO_SETTINGS_MODULE', DJANGO_SETTINGS_MODULE)
try:
from django.core.management import execute_from_command_line
except ImportError:
# The above import may fail for some other reason. Ensure that the
# issue is really that Django is missing to avoid masking other
# exceptions on Python 2.
try:
import django # noqa
except ImportError:
raise ImportError(
"Couldn't import Django. Are you sure it's installed and "
"available on your PYTHONPATH environment variable? Did you "
"forget to activate a virtual environment?"
)
raise
execute_from_command_line(sys.argv)

Voir le fichier

@ -0,0 +1,25 @@
[tool.black]
line-length = 79
skip-string-normalization = true
exclude = '''
/(
\.git
| venv
| local
| var
| migrations
| node_modules
| assets
)/
| urls(|_.+|/.+).py
'''
[tool.isort]
profile = 'black'
line_length = 80
known_django = 'django'
known_first_party = 'center_pilote'
sections = [
'FUTURE', 'STDLIB', 'DJANGO', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER'
]
skip_glob = '**/migrations/*.py'

Voir le fichier

@ -0,0 +1,3 @@
# This file is here because many Platforms as a Service look for
# requirements.txt in the root directory of a project.
-r requirements/production.txt

Voir le fichier

@ -0,0 +1,9 @@
# Django
# ------------------------------------------------------------------------------
django-environ ==0.4.5
# Creme CRM (include django)
# ------------------------------------------------------------------------------
-e git+https://github.com/HybirdCorp/creme_crm.git@2.2.1#egg=creme
django-fieldbustier

Voir le fichier

@ -0,0 +1,6 @@
-r test.txt
# Django
# ------------------------------------------------------------------------------
django-debug-toolbar
django-extensions

Voir le fichier

@ -0,0 +1,3 @@
-r base.txt
# PRECAUTION: avoid production dependencies that aren't in development.

Voir le fichier

@ -0,0 +1,15 @@
-r base.txt
# Testing
# ------------------------------------------------------------------------------
pytest
pytest-django
# Code quality
# ------------------------------------------------------------------------------
black
flake8 >=3.5.0
flake8-black
flake8-isort
isort >=5.0
pytest-cov

Voir le fichier

@ -0,0 +1,69 @@
[metadata]
name = {{ cookiecutter.project_slug }}
version = attr:{{ cookiecutter.project_slug }}.__version__
license = AGPL-3.0
license_file = LICENSE
author = hybird.org / Cliss XXI
author_email = {{ cookiecutter.email }}
url = {{ cookiecutter.project_url }}
description = {{ cookiecutter.description }}
long_description = file: README
keywords = CRM
classifiers =
Development Status :: 5 - Production/Stable
Environment :: Web Environment
Framework :: Django
Intended Audience :: Customer Service
Intended Audience :: Developers
Intended Audience :: End Users/Desktop
License :: OSI Approved :: GNU Affero General Public License v3
Natural Language :: French
Operating System :: OS Independent
Programming Language :: Python :: 3.6
Topic :: Office/Business
[options]
zip_safe = False
packages = find:
include_package_data = True
[tool:pytest]
addopts = --ds=center_pilote.settings.test
python_files = tests.py test_*.py
testpaths = center_pilote
markers =
wip: mark a test as a work in progress
[coverage:run]
branch = True
source =
center_pilote
omit =
center_pilote/*tests*,
center_pilote/*/migrations/*,
center_pilote/settings/*,
center_pilote/wsgi.py
[coverage:report]
exclude_lines =
pragma: no cover
if settings.DEBUG:
raise NotImplementedError
show_missing = True
[flake8]
exclude =
.git,
.tox,
venv,
*/migrations/*,
*/static/*,
assets,
build,
dist,
docs,
node_modules
per-file-ignores =
urls.py: BLK
max-line-length = 80

Voir le fichier

@ -0,0 +1,3 @@
from setuptool import setup
setup()