README.md

Python Project Template

Add your files here

Attention

The test and linting action will check for coverage minimum of 50%.

The COVERAGE.md file is automatically generated.

Makefile

Ready to work

make updatepip (install needed packages)

Make sure pipenv is installed before run this command.

pip install --user pipenv

Running $ pipenv lock then $ pipenv sync.
Locking [dev-packages] dependencies…
Locking [packages] dependencies…
Updated Pipfile.lock (18d334)!
Installing dependencies from Pipfile.lock (18d334)…
  🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 23/23 — 00:00:07

make test (run unit tests)

python -m unittest
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

make coverage (run unit tests and generates COVERAGE.md)

bash .github/scripts/generate_coverage.sh
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK
Wrote XML report to coverage.xml

make requirements (updates requirements.txt)

pipreqs --force
INFO: Successfully saved requirements file in /home/guionardo/dev/github.com/guionardo/python-template/requirements.txt