This is a python template repository doing the following
-
Set up enviroment for development
a. .devcontainer: contains devcontainer (used CodeSpace python default), setting up the environment for development.
b. .gitignore: specifies types of files to ignore in the repo (used GitHub default).
c. requirements.txt: lists required packages for the project. -
Specify GitHub Actions and timing
d. Makefile: when pushed/ pulled to main branch, install packages, then lint, test, format python files in the branch. -
Provide example python function and test functions
e. main.py: main function.
f. test_main.py: test functions for main function. -
Provide an overview of the template
g. README.md: THIS FILE, explaining the purpose of the directory.
The template can be applied to automate quality control for any future projects.