Added pipenv files to offer a consistent python environment, including quality. #20

Merged
caribaud merged 6 commits from issues/14 into release/1.0.0 2023-06-25 11:32:31 +02:00
2 changed files with 35 additions and 0 deletions
Showing only changes of commit 25cb269334 - Show all commits

3
.gitignore vendored
View File

@ -4,3 +4,6 @@ eslint_report.html
# Demo sources
demos/src_highres
demos/src_lowres
# Local dev environment settings
.vscode

View File

@ -127,6 +127,38 @@ To setup prospector, you need to run:
+ `prospector -s veryhigh -w mypy --max-line-length 88 .`
+ `black .`
For VSCode users, you can run those automatically in your IDE. Here is what your .vscode/settings.json file should include :
```json
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true,
"**/Thumbs.db": true,
"**/*.pyc": true,
"**/__pycache__": true
},
// Replace by your own venv python path
"python.defaultInterpreterPath": "~\\.virtualenvs\\melpomene-ajDJjHHp\\Scripts\\python.exe",
"python.formatting.provider": "black",
"[python]": {
"editor.formatOnType": true,
},
"python.linting.enabled": true,
"python.linting.prospectorEnabled": true,
"python.linting.prospectorArgs": [
"-s",
"veryhigh",
"-w",
"mypy",
"--max-line-length",
"88"
],
"editor.rulers": [
88
]
```
# 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).