RASCSI/python
Daniel Markstedt 65c1b194c5
Manage Samba and Netatalk with Webmin (#1217)
* Display status of Samba/Netatalk/vsftp in the footer, with links to Webmin module

* Add option to install Webmin and the netatalk2 module
2023-09-24 09:30:54 -07:00
..
common Fix test failures in low-voltage PR (#1207) 2023-09-04 08:08:42 -07:00
ctrlboard Launch python client services only after network-online target (#1197) 2023-07-31 12:12:53 -07:00
oled Launch python client services only after network-online target (#1197) 2023-07-31 12:12:53 -07:00
web Manage Samba and Netatalk with Webmin (#1217) 2023-09-24 09:30:54 -07:00
__init__.py restructuring towards python client library #455 (#613) 2022-01-21 15:08:29 -08:00
.flake8 Rebrand project to PiSCSI (#1016) 2022-12-05 09:58:23 -08:00
.pylintrc Rebrand project to PiSCSI (#1016) 2022-12-05 09:58:23 -08:00
pyproject.toml Auto-format Python sources with black, fix all issues reported by flake8 (#1010) 2022-11-30 05:19:17 +00:00
README.md Rebrand project to PiSCSI (#1016) 2022-12-05 09:58:23 -08:00

PiSCSI Python Apps

This directory contains Python-based clients for PiSCSI 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