Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-11-22 16:33:17 +00:00
Code Issues Projects Releases Wiki Activity
dd40d7156a
RASCSI/python/README.md
Daniel Markstedt 9302955416
Add concrete instructions on how to contribute code. (#797) 
* Add concrete instructions on how to contribute code.

* Document the Python interpreter support policy

* Clarify contribution guidelines
2022-08-25 19:57:44 -05:00

1.2 KiB
Raw Blame History

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