aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3e7e13cef9cb25cf04b6c883dcc71c969db51417 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Qt Flake8 Bot

This bot executes flake8 checks on python files in all pyside/ repos.

### Exclusions

Excluded rules:
- E115: Expected an indented block (comment) [E115](https://www.flake8rules.com/rules/E115.html)
- E265: Block comment should start with '# ' [E265](https://www.flake8rules.com/rules/E265.html)
- W503: Line break occurred before a binary operator
    [W503](https://www.flake8rules.com/rules/W503.html)
- E902: An IOError occurred attempting to read from the source file
    [E902](https://www.flake8rules.com/rules/E902.html)

Excluded file patterns:
- rc_*.py
- *_rc.py
- ui_*.py

## Installation
To install this script as a service
1. Modify the included systemd template with a suitable gerrit `GERRIT_USERNAME`
    and `GERRIT_PASSWORD`.
2. Copy the service file to the systemd directory of your choice such as `/etc/systemd/system/`.
3. Reload the daemon with `systemctl daemon-reload`.
4. Start the service.

## Prerequsites
1. The included systemd service file assumes you have `pipenv` installed for the `qt` user.
2. You must manually install required packaged into the pipenv, as the service does not do this
    automatically.