Template repository for Python projects.
- Rename
project
to the desired project name - Update the
$PROJECT
variable inMakefile
to match step 1 - Update
install_requires
insetup.py
with project dependencies - Add source code to the renamed
project
folder - Run
make venv
to install the project to a virtual environment - Run the script using
venv/bin/python
- Setup CI - a template CircleCI config is provided in
.circeci/config.yml
- Create
Makefile.config
- secrets or per-user configuration can go here. TemplateMakefile.config.example
is under version control, butMakefile.config
is in.gitignore
. Add$(CONFIG_FILE)
as a make dependencies for recipes that need vars fromMakefile.config
- Run
make help
to get a partial list of available make recipes - A pytest mark,
ci_skip
, is provided to mark tests that should be skipped during CI pipelines