mirror of
https://github.com/akuker/RASCSI.git
synced 2024-06-02 11:41:34 +00:00
089dc302e5
* python client library clean branch for PR. #455 * removed superfluous file. #455 * removed one more superfluous file. #455 * README.md, .pylintrc and pylint based fixes. #455 * updated wrt. to the review comments. #455 * removed pylint documentation duplication. #455
32 lines
791 B
Markdown
32 lines
791 B
Markdown
# RaSCSI Python Apps
|
|
|
|
This directory contains Python-based clients for RaSCSI as well as common
|
|
packages that are shared among the clients.
|
|
|
|
The following paragraphs in this README contain instructions that are shared
|
|
among all Python apps.
|
|
|
|
### Static analysis with pylint
|
|
|
|
It is recommended to run pylint against new code to protect against bugs
|
|
and keep the code readable and maintainable.
|
|
The local pylint configuration lives in .pylintrc.
|
|
In order for pylint to recognize venv libraries, the pylint-venv package is required.
|
|
|
|
```
|
|
sudo apt install pylint3
|
|
sudo pip install pylint-venv
|
|
source venv/bin/activate
|
|
pylint3 python_source_file.py
|
|
```
|
|
|
|
Examples:
|
|
```
|
|
# check a single file
|
|
pylint web/src/web.py
|
|
|
|
# check the python modules
|
|
pylint common/src
|
|
pylint web/src
|
|
pylint oled/src
|
|
``` |