A logical, reasonably standardized but flexible project structure for doing and sharing data science work.
Important Note
This template is an opinionated blend of two established Data Science Cookiecutter templates, who have done an amazing work:
It is highly recommended to read through the documentation of these two projects
- Dynaconf: Manage configuration
- MkDocs: Slick project documentation. With search functionality. Using a material theme.
- Poetry: Dependency management - setup guide, comparison with pip and conda
- ruff: An extremely fast Python linter and code formatter, all in one, replaces: Black, isort, Flake8
- SQLFluff: A SQL linter and auto-formatter for Humans
Since this is a cross-project utility application, we recommend installing it with pipx. Installation command options (further installation options in the cookiecutter docs ):
pipx install cookiecutter
Create a project based on the template:
cookiecutter https://github.com/fabianbergermann/data-science-template