The HSG Data Science Project Template is a cookiecutter
template to configure data science project repositories.
It features/configures:
- a default
gitignore
file - a default
data/raw
folder tracked bygit-lfs
- line endings set to LF on check-in for text files (based on
git
heuristic for text file detection) pre-commit
checks including:- code formatting of
python
and.ipynb
files withblack
- code linting of
python
and.ipynb
files withpylint
- code formatting/checking for various configuration file types (e.g.,
.yaml
) - check of commit messages according to conventional commits specifications
- code formatting of
- configuration to run code formatting & linting with
gitlab
ci/cd pipelines
The template depends on the following software:
To setup a new project with the HSG data science template create the project repository in gitlab, run
cookiecutter https://github.com/HotSprings-GmbH/data-science-project-template
and fill out the needed information.
Checkout the repository, run
mamba env create -f environment.yaml
mamba activate data-science-project-template
pre-commit install
and start developing.
The projects created with this template are set up to run the formatting and linting checks configured
in pylint
for every new commit pushed to gitlab
. The CI/CD pipelines must be enabled within the gitlab repository settings (Settings -> General -> Visibility, project features, permissions
).
Licensed under the Apache License, Version 2.0 (the "License").