diff options
| author | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-14 01:47:59 -0400 |
|---|---|---|
| committer | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-14 01:47:59 -0400 |
| commit | 583589d3702ca2b392605cb2af9755cc93b6cb74 (patch) | |
| tree | 17c46c54012b3d005b883d86e85cf651e9f037ae | |
| parent | ed1732252a1a63e2da40395397156dffb5a55367 (diff) | |
| download | qolab-583589d3702ca2b392605cb2af9755cc93b6cb74.tar.gz qolab-583589d3702ca2b392605cb2af9755cc93b6cb74.zip | |
Expanded README with formatting and linting sections
| -rw-r--r-- | README.md | 38 |
1 files changed, 33 insertions, 5 deletions
@@ -1,18 +1,38 @@ # qolab -Collection of scripts to run experimental hardware with python. +Collection of function and classes to run experimental hardware with python. Started in April 2021 by Eugeniy E. Mikhailov -## Build instructions +## Developing -To build a python wheel package and put it in `./dist/` directory, run +### Formatting +Adhere to [black](https://pypi.org/project/black/) +formatting style and run modified files via `black`. +I.e. do `black fname` or even more extreme ~~~~~ -flit build +black . ~~~~~ +to reformat the whole project. + +### Linting + +I find [flake8](https://github.com/PyCQA/flake8/tree/main) +to be quite good linter. + +Make sure that you check for linting errors all the files +and review the messages. +Before committing and especially pushing, run +~~~~~ +flake8 --max-line-length=88 +~~~~~ +here we set maximum line length to `black` default, which +is a bit longer `python` recommended 79. + +### Test instructions -## Test instructions +Make sure that you run the test suite and no errors are triggered. ~~~~~ export PYTHONPATH=. @@ -21,3 +41,11 @@ python -m pytest Note that we cannot just run `pytest` since I see no way to set the module search path. +## Build instructions + +To build a python wheel package and put it in `./dist/` directory, run + +~~~~~ +flit build +~~~~~ + |