A Project Template With Python

File Structure

.
├── LICENSE
├── Makefile          # commands
├── README.md
├── requirements.txt  # package information
├── setup.cfg         # configurations for formatting & linting & unit-test
├── src               # source code location
└── test
    └── utest         # unit tests location

Commands

$ make env      # create anaconda environment
$ make setup    # initial setup for the project
$ make format   # format python scripts
$ make lint     # lint python scripts
$ make utest    # run unit tests
$ make cov      # open coverage report (after `make utest`)

Configurations

setup.cfg states all configurations for formatting & linting & unit-test.

Verifications

• per commit: pre-commit hook runs formatting and linting.
• per pull-request: GitHub Actions check formatting, linting, and unit-test results.

Recommended Repository Settings

Restriction on multi-commit pushes

Settings -> General -> Merge botton -> Allow squash merging ONLY

Branch Protection Rules

Settings -> Branches -> Branch protection rules -> Add rule

• Branch name pattern: main
• Require a pull request before merging & Require approvals
• Require status checks to pass before merging & Require branches to be up to date before merging
• Include administrators