Cookiecutter for STATWORX Python Projects

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work following the STATWORX coding standards. This project was forked from cookiecutter-data-science.

Requirements to use the cookiecutter template:

---

• Zsh
• Homebrew
• xcode-select
• Cookiecutter

Run the following two commands in the shell to install the requirements:

$  xcode-select --install
$  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/STATWORX/intern-cookiecutter-python-project/master/install.sh )"

To start a new project, run:

---

$ cookiecutter https://github.com/STATWORX/intern-cookiecutter-python-project

Tools

---

The tools that are installed with the Cookiecutter template are:

• Poetry - Package Manager
• Direnv - Shell Environment Manager
• Pyenv - Python Version Manager
• Pre-Commit - Git Pre Commit Hooks
• Flake8 - Linter
• Pytest - Testing
• Black - Formatting
• MyPy - Static Typing
• Isort - Import Sorter
• MkDocs - Documentatoin
• (Optional) Hydra - Orchestration
• (Optional) DVC - Data Versioning