https://github.com/habedi/template-python-project

A template for data science and machine learning projects in Python
https://github.com/habedi/template-python-project

data-science machine-learning project-template python software-development template-repository

Last synced: 8 months ago
JSON representation

A template for data science and machine learning projects in Python

• Host: GitHub
• URL: https://github.com/habedi/template-python-project
• Owner: habedi
• License: mit
• Created: 2024-02-17T03:24:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-18T16:30:07.000Z (8 months ago)
• Last Synced: 2025-02-18T17:32:17.596Z (8 months ago)
• Topics: data-science, machine-learning, project-template, python, software-development, template-repository
• Language: Makefile
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# A Template Repository for Data Science Projects

[![Tests](https://github.com/habedi/template-python-project/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/template-python-project/actions/workflows/tests.yml)

[![Python Version](https://img.shields.io/badge/Python-%3E=3.10-blue)](https://github.com/habedi/template-python-project)

[![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/habedi/template-python-project/blob/main/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](https://python-poetry.org/)

  or [uv](https://github.com/astral-sh/uv).

- Extra configuration files for various tasks like linting, formatting, and testing.

---

## Structure

```plaintext

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](LICENSE).