a cookiecutter project structure template This template is used to standarise the project structure of the data science team to ensure reproducibility, consistency and a systematic workflow that could assist newer team members get up and running as soon as possible. This structure was designed with a smaller team in mind working on small to medium size projects. The template is a guide to a consistant structure that is only minimally modified to mold to unique projects.
- cookiecutter
- LSA_DS_project_template
install cookiecutter
pip install cookiecutter
get template
either copy LSA_DS_project_template.zip file to local pc or copy path to template
- template location:
- github path: https://github.com/Wahe3bru/DSprojectTemplate.git
installation
open terminal / command prompt
change to your projects directory, then run cookiecutter followed by the path to template.
$ cd work/projects
$ cookiecutter path/to/LSA_DS_project_template.zip
# or using github url
$ cookiecutter https://github.com/Wahe3bru/DSprojectTemplate.git You will have to answer a few prompted questions.
Some will have acceptable defaults (press enter to keep the default) but most will be answered by you about the project.
project_name: default="test_project",
directory_name: will default to the project name provided,
project_code: default="LSA-DS-{project_name}",
description: "Enter a short description of the project.",
project_lead: default="Waheeb Agherdien",
lead_email: default="Waheeb.Agherdien@gmail.com"
├───data
│ ├───00-raw
│ ├───01-interim
│ └───02-processed
├───docs
│ ├───admin
│ │ └───Contact_info.docx
│ ├───project_documentation
│ │ └───Team-DoL.docx
│ ├───reference_material
│ │ └───Data-dictionary.txt
│ └───reports
│ │ └───initial_findings.ppt
├───notebooks
│ ├───01-WA-EDA.ipynb
│ ├───02-TC-EDA.ipynb
│ └───03-WA-process_features.ipynb
└───src
│ ├───01-TC-get_data.py
│ └───02-WA-process_data.ipynb
└───Readme.md