Data-Science-Project-Template

A simple full-fledged template for data science projects in Python.

Project name needs a short and sweet introduction.

Project name also does this really cool thing that doesn't fit into the short and sweet intro, so you feel the urge to write something more here.

---

Project Milestones

• Init repository
• Prep data
• EDA
• ???
• Findings

Summary of Findings

• Something something.
• ???

Instructions to Reproduce Findings

Set up Python & Notebook Environment

• With Anaconda

conda create -n projectname python=3.8 jupyter
conda activate projectname
python -m ipykernel install --user --name projectname
jupyter notebook

Install Project Requirements

• Clone this repository:

cd where_you_want_to/put_your_project
git clone https://github.com/author/thisrepository/
cd thisrepository

• Install standard requirements

python -m pip install -e .

• Or standard + development requirements

python -m pip install -e .[dev]

• Or standard + test requirements

python -m pip install -e .[test]

Run Notebooks in order from 00 to 99

Authors

• Author1 Name
• Author2 Name

References and Notes that explain this template but don't need to be featured in an actual project repo

Notes for template users

TBA

References

• Altair Viz
• Chromebook Datascience
• Introduction to Data Science