Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.85 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.85 KB
Raw

A Template Repository for Data Science Projects

Tests Python Version License

This is a simple and minimalistic 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 the hope that others find it useful. So, feel free to use it as a starting point for your projects.

Notable Features

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

Folder Structure

The repository is organized as follows:

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  # Project metadata and dependencies
├── LICENSE      # License information
└── README.md    # Project documentation

License

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