Statworx Python Template

Copier template for Data Science projects using Kedro with Poetry as dependency manager. This template is tied to version 0.18.x of Kedro, as the API changes rapidly and newer versions could break the application.

Features

• Poetry setup, with pre-defined pyproject.toml
• Documentation built with MkDocs (Material theme and "autodoc" mkdocstrings plugin)
• Pre-configured tools for code formatting, quality analysis and testing:
  • black,
  • flake8 and plugins,
  • isort,
  • mypy,
• Python 3.8.x
• Makefile for convenience

Requirements

You need copier with version >=6.0.0a1 to create this project. This is a hard requirement as other versions will not work. It is recommended that you install the module with the following command.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/STATWORX/statworx-python-ds-template/master/install_copier.sh)"

Quick setup and usage

First make sure that the correct version of copier is installed on your system. Then run:

copier "https://github.com/STATWORX/statworx-python-ds-template.git" /path/to/your/new/project

Or even shorter:

copier "gh:STATWORX/statworx-python-ds-template" /path/to/your/new/project

Directory Structure

├── .cz.toml
│
├── .envrc
│
├── .github
├── .gitignore
│
├── .pre-commit-config.yaml
│
├── .python-version
│
├── CHANGELOG.md
│
├── Dockerfile
├── docker-compose.yml
├── .dockerignore
│
├── Makefile
│
├── README.md
│
├── mkdocs.yml
│
├── pyproject.toml
│
├── setup.cfg
│
├── conf
│
├── data
│   ├── 01_raw
│   ├── 02_intermediate
│   ├── 03_primary
│   ├── 04_feature
│   ├── 05_model_input
│   ├── 06_models
│   ├── 07_model_output
│   └── 08_reporting
│
├── docs
│   ├── logic
│   └── model
│
├── logs
│
├── notebooks
│
├── scripts
│
└── src
    ├── {{ project_name }}
    └── tests