Python Project Template

This is a cookiecutter template for a typical Python project following modern packaging conventions.

Table of Contents

• Python Project Template
  • Features
  • Usage
  • Adding CI files
  • Create repository structure for a machine learning project

Features

• Poetry for dependency management
• Docker for development.
• Github actions for CI.
• VSCode as IDE.

Usage

Install cookiecutter using

$ pip install cookiecutter

and generate a project:

$ cookiecutter gh:hsteinshiromoto/template.py -f

Cookiecutter will ask you for some basic info (your name, project name, python package name, etc.) and generate a base Python project for you.

Adding CI files

To add CI files to your project, run the following command:

$ make ci

Create repository structure for a machine learning project

To create a repository structure for a machine learning project, run the following command:

$ make structure r=machine_learning