RASCSI/python
Daniel Markstedt 5172d167e7
Web UI: More file path sanitation, better network bridge warnings, each endpoint return one message (#932)
- Sanitize file paths with Path: for flat file structures, always extract Path().name, and for nested file structures either look for absolute paths, or someone trying to use ".." to traverse the dir strucutre.
- Reduce redundancy in network bridge detection method, and return somewhat more informative messages
- Make all endpoints return exactly one message
- Move some warning messages to logging
- Use tempfile for iso generation temp file handling
2022-10-23 19:05:29 -07:00
..
common Web UI: More file path sanitation, better network bridge warnings, each endpoint return one message (#932) 2022-10-23 19:05:29 -07:00
ctrlboard Bump protobuf from 3.19.3 to 3.19.5 in /python/ctrlboard (#858) 2022-09-25 10:49:53 -07:00
loopback_test
oled Bump protobuf from 3.19.1 to 3.19.5 in /python/oled (#857) 2022-09-25 10:47:33 -07:00
web Web UI: More file path sanitation, better network bridge warnings, each endpoint return one message (#932) 2022-10-23 19:05:29 -07:00
__init__.py restructuring towards python client library #455 (#613) 2022-01-21 15:08:29 -08:00
.pylintrc Create SysCmds common class, and refactor Python codebase (#697) 2022-02-26 21:46:35 -08:00
README.md Add concrete instructions on how to contribute code. (#797) 2022-08-25 19:57:44 -05:00

RaSCSI Reloaded Python Apps

This directory contains Python-based clients for RaSCSI Reloaded 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.

Supported Python interpreter

The policy in this project is to support the Python 3 interpreter that comes standard with the current stable, as well as previous stable release of Debian.

At the time of writing they are:

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