Skip to content

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.

License

Notifications You must be signed in to change notification settings

iagopinal/cookiecutter-ds

 
 

Repository files navigation

Cookiecutter DS

A minimal, yet powerful, project structure for doing and sharing data science work.

Requirements to use the cookiecutter template:


  • Python 2.7 or 3.5+
  • Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
$ pip install cookiecutter

or

$ conda config --add channels conda-forge
$ conda install cookiecutter

To start a new project, run:


cookiecutter https://github.com/iagopinal/cookiecutter-ds

The resulting directory structure


The directory structure of your new project looks like this:

├── LICENSE
├── Makefile           <- Makefile
├── README.md          <- The top-level README for developers using this project
├── data               <- Data
├── docs               <- A default Sphinx project; see sphinx-doc.org for details
├── results            <- Results
│   └── figures        <- Graphics and figures
│   └── tables         <- Tables
├── src                <- Source code for use in this project

Installing development requirements


pip install -r requirements.txt

About

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Makefile 40.5%
  • Python 34.8%
  • R 24.7%