From 3d7428e76fb97f4f5b5fc53d101a8d4dc1d91fc1 Mon Sep 17 00:00:00 2001 From: Christian Aribaud Date: Sun, 25 Jun 2023 09:20:06 +0200 Subject: [PATCH] Adding info regarding python quality checking --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c162532..16a3653 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ If you need to do some global scaling / offset of all zooms in HTML (if for exam ## Setting up quality checking for JS - Regarding JS, quality checking is done using [eslint](https://eslint.org/). +Regarding JS, quality checking is done using [eslint](https://eslint.org/). The configuration file is `eslint/eslintrc.json`. @@ -110,6 +110,23 @@ To do so, assuming you are using linux, after installing docker, you can run fro You can now open `eslint_report.html` to see the result. +## Setting up quality checking for Python + +Regarding Python, quality checking is done using [prospector](https://prospector.landscape.io/en/master/) using [mypy](https://mypy.readthedocs.io/en/stable/) as an additional checker. +Auto-formating is done using [Black](https://pypi.org/project/black/) + +Dependencies are managed not using `pip` but [`pipenv`](https://pipenv.pypa.io/en/latest/). + +To setup prospector, you need to run: + ++ Only once, in melpomene's root folder: + + Install pipenv: `pip install pipenv` + + Install melpomene's root folder: `pipenv install --dev` ++ Every time to run the quality checking: + + `pipenv shell` + + `prospector -s veryhigh -w mypy --max-line-length 88 .` + + `black .` + # Credits Most examples and the documentation of Melpomene uses illustrations from David "Deevad" Revoy's "Pepper & Carrot" webcomic, which is published under CC-BY 4.0. Full licence [here](https://www.peppercarrot.com/en/license/index.html).