RASCSI/python
Daniel Markstedt 029cf06c72
Web UI: Upload to tmp file name then rename if successful (#1272)
* Upload to tmp file name then rename if successful

* Move the dropzone.js operations back into web.py

* Move list_images() from file commands into piscsi commands (it was the only class method in that package that calls the protobuf interface)

* Remove now-redundant helptext
2023-10-31 14:54:04 -07:00
..
common Web UI: Upload to tmp file name then rename if successful (#1272) 2023-10-31 14:54:04 -07:00
ctrlboard Web UI: Upload to tmp file name then rename if successful (#1272) 2023-10-31 14:54:04 -07:00
oled Bump pillow from 9.3.0 to 10.0.1 in /python/oled (#1235) 2023-10-22 19:00:25 +09:00
web Web UI: Upload to tmp file name then rename if successful (#1272) 2023-10-31 14:54:04 -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 Stop supporting Python 3.7, start supporting 3.11 2023-10-30 08:46:06 +09:00
README.md Stop supporting Python 3.7, start supporting 3.11 2023-10-30 08:46:06 +09: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 and formatting

The CI workflow is set up to check code formatting with black, and linting with flake8. If non-conformant code is found, the CI job will fail.

Before checking in new code, install the development packages and run these two tools locally.

pip install -r web/requirements-dev.txt

Note that black only works correctly if you run it in the root of the python/ dir:

cd python
black .

Optionally: 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