Skip to content

Commit dc6b9ff

Browse files
committed
Document how to run lint in README
Signed-off-by: Arthur Diniz <arthurbdiniz@gmail.com>
1 parent 1327cf3 commit dc6b9ff

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ deactivate
144144
pip3 install --editable .
145145
```
146146

147-
#### Run tests
147+
#### Run tests and lint
148148
First make sure to install the test dependencies:
149149
```
150150
pip3 install -r requirements-test.txt
@@ -155,6 +155,11 @@ To run the test suite:
155155
pytest -v tests/
156156
```
157157

158+
To run the lint check:
159+
```bash
160+
flake8 . --count --max-complexity=10 --max-line-length=127 --statistics --exclude env
161+
```
162+
158163
#### Manualy generate binary
159164
```bash
160165
pyinstaller --clean --hidden-import one.__main__ cli.py --onefile --noconsole -n one

0 commit comments

Comments
 (0)