RASCSI/python
Benjamin Zeiss bab1556a4a The protobuf proxy prototype didn't exist in the previous proxy branch for some reason. It's currently broken and needs to be rewritten to work with the python restructuring from the last release. So currently not a working version (but one that used to kinda work to some degree with some old version). 2022-02-18 00:40:55 +01:00
..
common Web UI and OLED: adding Support Devices (#666) 2022-02-15 13:06:27 +01:00
loopback_test clean squashed restructuring branch. #455 2022-01-09 20:22:19 +01:00
oled Web UI and OLED: adding Support Devices (#666) 2022-02-15 13:06:27 +01:00
proxy The protobuf proxy prototype didn't exist in the previous proxy branch for some reason. It's currently broken and needs to be rewritten to work with the python restructuring from the last release. So currently not a working version (but one that used to kinda work to some degree with some old version). 2022-02-18 00:40:55 +01:00
web Web UI and OLED: adding Support Devices (#666) 2022-02-15 13:06:27 +01:00
.pylintrc restructuring towards python client library #455 (#613) 2022-01-21 15:08:29 -08:00
README.md restructuring towards python client library #455 (#613) 2022-01-21 15:08:29 -08:00
__init__.py restructuring towards python client library #455 (#613) 2022-01-21 15:08:29 -08:00

README.md

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