mirror of https://github.com/akuker/RASCSI.git synced 2024-11-25 20:33:35 +00:00

History

n4al f96ade9149 Updating the README to reflect the new file system layout (#658 ) * Updating the README to reflect the new file system layout (and dependencies) * Compressing two environment variables into a single one * Adding named arguments Co-authored-by: Nemanja Lukic <nemanja.lukic@forgerock.com>		2022-02-11 16:29:48 -08:00
..
common	removed python typing for debian buster compatibility. (#632 )	2022-01-30 19:15:35 -08:00
loopback_test	clean squashed restructuring branch. #455	2022-01-09 20:22:19 +01:00
oled	Updating the README to reflect the new file system layout (#658 )	2022-02-11 16:29:48 -08:00
web	Create a mapping of human-readable and internationalized device names. Use this in the image file management UI instead of the internal acronyms. Also remove the hard-coded helptext for device types. (#655 )	2022-02-07 18:48:55 -06:00
__init__.py	restructuring towards python client library #455 (#613 )	2022-01-21 15:08:29 -08: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

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