travistheall / tools

basic tools

How to use project

Developed with

python3.9 --version
# Python 3.9.16

Environment set up

python3.9 -m venv venv
source ./venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
export PYTHONPATH="./src"

Format Imports

python -m isort src

Example output

Fixing ./src/tests/test_dictionary.py

Format Code

python -m black src

Example output

reformatted src/dictionary.py

All done! ✨ 🍰 ✨
1 file reformatted, 3 files left unchanged.

Run pylint

python -m pylint src

Example output

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

Run flake8

python -m flake8 src

Example output

src/dictionary.py:13:1: E302 expected 2 blank lines, found 0

Run tests

python -m coverage run -m unittest discover src

Example output

..................
----------------------------------------------------------------------
Ran 18 tests in 0.002s

OK

Display coverage report

python -m coverage report -m

Example output

Name                       Stmts   Miss  Cover   Missing
--------------------------------------------------------
src/dictionary.py                 30      0   100%
src/tests/__init__.py              0      0   100%
src/tests/test_dictionary.py      51      1    98%   135
--------------------------------------------------------
TOTAL                         81      1    99%

Package docs

• coverage
• pylint
• isort
• flake8
• black