Skip to content

A template for data science and machine learning projects in Python

License

Notifications You must be signed in to change notification settings

habedi/template-python-project

Repository files navigation

A Template Repository for Data Science Projects

Tests Python Version License

This is a template repository for starting new data science and machine learning projects in Python.

I created this template to help me speed up the setup process for my projects and to have a consistent structure across all my personal and professional projects. I'm sharing it here in case it might be useful to others as well.


Features

  • A predefined file and folder layout that should be suitable for most data science workflows.
  • Easy dependency and environment management with Poetry or uv.
  • Extra configuration files for various tasks like linting, formatting, and testing.

Structure

template-python-project/
├── bin/         # Scripts and command-line tools
├── data/        # Raw and processed datasets
├── notebooks/   # Jupyter notebooks for exploration, analysis, and prototyping
├── src/         # Source code for the project
├── models/      # ML models and related files
├── tests/       # Unit tests and test files
├── pyproject.toml  # Poetry configuration file
├── LICENSE      # License information
├── README.md    # Project documentation
└── Makefile     # Makefile for managing common tasks like linting and testing

License

The files in this repository are licensed under the MIT License.