Data Science Project Template

A template repository for data science projects.

The file organisation is losely based on TDSP Project Structure and CookieCutter Data Science.

Using the template

This template requires Python 3 and cookiecutter.

1. Install cookiecutter.

   pip install cookiecutter jinja2_git

2. Create a new project:

   cookiecutter gh:sheikhomar/cookiecutter-data-science

3. Initialise a new Git repository:

   cd <NEW_PROJ_DIR>
   git init
   git add .
   git commit -m "Initial commit."
   git remote add origin <GIT_REMOTE_URL>
   git push -u origin master

4. Install pyenv and Poetry if not already installed:

   curl https://pyenv.run | bash
   pyenv install
   curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
   source $HOME/.poetry/env

5. Install dependencies:

   poetry install

6. Install the pre-commit Git hooks:

   poetry run pre-commit install