Skip to content

Latest commit

 

History

History
48 lines (41 loc) · 2.11 KB

README.md

File metadata and controls

48 lines (41 loc) · 2.11 KB
Raw

Python 3 Boiler Plate

Simple Python boiler plate project. Main features:

  • Main application with parameter parsing and logger (via decorator).
  • Dynamic tests via unit tests and test coverage.
  • Static tests via pycodestyle, pyflakes, and pyline.
  • Requirements management.
  • Basic make, .gitignore and other configuration files.

Build Status Build Status Coverage Status Scrutinizer Code Quality

Examples

$ make
Some available commands:
 * run          - Run code.
 * test         - Run unit tests and test coverage.
 * doc          - Document code (pydoc).
 * clean        - Cleanup (e.g. pyc files).
 * code-style   - Check code style (pycodestyle).
 * code-lint    - Check code lints (pyflakes, pyline).
 * code-count   - Count code lines (cloc).
 * deps-install - Install dependencies (see requirements.txt).
 * deps-update  - Update dependencies (via pur).
 * feedback     - Create a GitHub issue.
$ make test
[D 180728 04:10:10 hello:23] <function print_message at 0x107867aa0>
Hello world!
[I 180728 04:10:10 hello:47] []
.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK
Name                  Stmts   Miss  Cover
-----------------------------------------
src/__init__.py           0      0   100%
src/hello.py             26      0   100%
tests/__init__.py         0      0   100%
tests/test_hello.py      12      0   100%
-----------------------------------------
TOTAL                    38      0   100%