Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 789 Bytes

README.md

File metadata and controls

26 lines (19 loc) · 789 Bytes

Data Science - Cookiecutter template

Opinionated cookiecutter template for data science projects.

Usage

As a prerequisite, you need to have pipx installed. Additionally, install pre-commit and poetry with pipx. Then simply execute following command:

cookiecutter https://github.com/JakobKlotz/ds-template.git

... which walks you through the set-up of your project. After the project structure creation, the virtual environment and pre-commit hooks are automatically installed.

Comes with...

  • poetry for package management
  • pytest for unit-testing
  • a pre-commit hook to format and lint code with ruff
  • a GitHub action to execute tests.