Python Project Template

This is a simple Python project template, with source files that build a single command-line tool.

venv is used to install dependencies and run the project.

PYTHONPATH is set up so that python source imports are found when the main program is run.

Running from CLI

$ proj/cli.py f1 30

Tests

pytest can be run from the unit tests are included.

The tests can be run from the vscode testing menu, or from a terminal.

pytest
============================= test session starts ==============================
platform linux -- Python 3.12.9, pytest-8.3.5, pluggy-1.5.0
rootdir: /workspaces/proj
configfile: pytest.ini
plugins: cov-6.0.0
collected 4 items                                                              

tests/test_cli.py ..                                                     [ 50%]
tests/test_module1.py .                                                  [ 75%]
tests/test_module2.py .                                                  [100%]

============================== 4 passed in 0.10s ===============================

Command-line arguments are exercised by test_cli.py:

• unittest.mock.patch simulates different command-line arguments (argparse.ArgumentParser.parse_args).
• patch('builtins.print') is mocks the print function to verify the output.

Code coverage and visual display

"Run test with Coverage" (using pytest-cov) can be used from the VS code test explorer menu. The popular Coverage Gutters extension shows the results visually. This is installed into the container.

CI with Github Actions

The tests are also run via Github Actions on checkin.