History

Daniel Markstedt da02eccb2e Improve logic for the get_logs() method. Add rascsi-ctrlboard service. (#714 )		2022-02-28 09:49:48 -08:00
..
common	Improve logic for the get_logs() method. Add rascsi-ctrlboard service. (#714 )	2022-02-28 09:49:48 -08:00
ctrlboard	Initial version of the Control Board UI (#687 )	2022-02-25 21:03:36 +01:00
loopback_test	clean squashed restructuring branch. #455	2022-01-09 20:22:19 +01:00
oled	Create SysCmds common class, and refactor Python codebase (#697 )	2022-02-26 21:46:35 -08:00
web	Improve logic for the get_logs() method. Add rascsi-ctrlboard service. (#714 )	2022-02-28 09:49:48 -08:00
.pylintrc	Create SysCmds common class, and refactor Python codebase (#697 )	2022-02-26 21:46:35 -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