Go to file
Shubhankar d82776e0fd
Flag -c v1 is slightly confusing in branch v2 (#264)
2022-03-11 10:25:13 -08:00
docs Update index.md (#249) 2021-06-22 17:23:22 -07:00
hooks V1 tag and deprecation (#240) 2021-03-19 22:33:34 -07:00
tests Fixed failing tests on Windows (#216) 2020-05-26 10:16:03 -07:00
{{ cookiecutter.repo_name }} Tox reference (#211) 2020-04-22 22:14:31 -07:00
.gitattributes Start to flesh out READMEs 2015-10-30 15:47:00 -04:00
.gitignore Expand Setup Tests (#131) 2018-07-28 10:31:14 -04:00
LICENSE Add LICENSE 2016-07-12 11:46:44 -04:00
README.md Flag -c v1 is slightly confusing in branch v2 (#264) 2022-03-11 10:25:13 -08:00
cookiecutter.json Make python3 the default interpreter (#113) 2018-04-19 09:00:41 -07:00
requirements.txt Basic sanity-check tests 2017-01-28 23:01:56 -05:00

README.md

Cookiecutter Data Science

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

Project homepage

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 (installs v2 by default), run:


cookiecutter https://github.com/drivendata/cookiecutter-data-science  # use flag -c v1 for version1

asciicast

New version of Cookiecutter Data Science


Cookiecutter data science is moving to v2 soon, which will entail using the command ccds ... rather than cookiecutter .... The cookiecutter command will continue to work, and this version of the template will still be available. To use the legacy template, you will need to explicitly use -c v1 to select it. Please update any scripts/automation you have to append the -c v1 option (as above), which is available now.

The resulting directory structure


The directory structure of your new project looks like this:

├── LICENSE
├── Makefile           <- Makefile with commands like `make data` or `make train`
├── README.md          <- The top-level README for developers using this project.
├── data
│   ├── external       <- Data from third party sources.
│   ├── interim        <- Intermediate data that has been transformed.
│   ├── processed      <- The final, canonical data sets for modeling.
│   └── raw            <- The original, immutable data dump.
│
├── docs               <- A default Sphinx project; see sphinx-doc.org for details
│
├── models             <- Trained and serialized models, model predictions, or model summaries
│
├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
│                         the creator's initials, and a short `-` delimited description, e.g.
│                         `1.0-jqp-initial-data-exploration`.
│
├── references         <- Data dictionaries, manuals, and all other explanatory materials.
│
├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures        <- Generated graphics and figures to be used in reporting
│
├── requirements.txt   <- The requirements file for reproducing the analysis environment, e.g.
│                         generated with `pip freeze > requirements.txt`
│
├── setup.py           <- makes project pip installable (pip install -e .) so src can be imported
├── src                <- Source code for use in this project.
│   ├── __init__.py    <- Makes src a Python module
│   │
│   ├── data           <- Scripts to download or generate data
│   │   └── make_dataset.py
│   │
│   ├── features       <- Scripts to turn raw data into features for modeling
│   │   └── build_features.py
│   │
│   ├── models         <- Scripts to train models and then use trained models to make
│   │   │                 predictions
│   │   ├── predict_model.py
│   │   └── train_model.py
│   │
│   └── visualization  <- Scripts to create exploratory and results oriented visualizations
│       └── visualize.py
│
└── tox.ini            <- tox file with settings for running tox; see tox.readthedocs.io

Contributing

We welcome contributions! See the docs for guidelines.

Installing development requirements


pip install -r requirements.txt

Running the tests


py.test tests