mirror of
https://github.com/akuker/RASCSI.git
synced 2025-02-05 23:30:05 +00:00
d1a703418c
Refactor and clean up code to conform to SonarCloud static analysis, improve readability and semantics. - Add labels for each form input, and tweak placeholder text accordingly. - Move CSS styles to the stylesheet; minor tweaks for clarity and consistency - Use the legacy align=center attribute for centering paragraphs (backwards compatible) - Remove all instances of using tables for layout - Add header tags to all remaining tables, with scope parameters. - Add descriptions to each table - Move drive reference hyperlinks to the drive name column (addresses "same link text leads to different URL" code smell.) - Inject lang parameters to each html tag - Standardize on h2 tags as top header for each template - Add 'json' to config file UI elements, to communicate actual file name/format - Clean up indentation - Dropbox styling: Added a colored outline, added padding to more clearly communicate its function. Hid the (X) SVG that indicates failure, since failure is already communicated by the error text. Also, the SVG always obstructed the file name or error so was quite counter-productive.
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:
- Python 3.9.2 in Debian Bullseye
- Python 3.7.3 in Debian Buster
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