ants-hub/README

48 lines
1.2 KiB
Plaintext

ANTS-Hub
========
Hub pour servir une base de rende-vous CNI/Passeport au service centralisé de prise de rendez-vous de l'ANTS (https://rendez-vous-api.france-identite.fr/docs).
Local server
------------
To run a pre-configured local instances, do:
tox -e runserver
Login/password are admin/admin.
Tests
-----
Unit tests are written using py.test, and its pytest-django support library. To run them use tox.
tox
Code Style
----------
black is used to format the code, using thoses parameters:
black --target-version py37 --skip-string-normalization --line-length 110
isort is used to format the imports, using those parameters:
isort --profile black --line-length 110
pyupgrade is used to automatically upgrade syntax, using those parameters:
pyupgrade --keep-percent-format --py37-plus
djhtml is used to automatically indent html files, using those parameters:
djhtml --tabwidth 2
django-upgrade is used to automatically upgrade Django syntax, using those parameters:
django-upgrade --target-version 2.2
There is .pre-commit-config.yaml to use pre-commit to automatically run these tools
before commits. (execute `pre-commit install` to install the git hook.)