It is a command-line utility helps developer to create a cookiecutter project template. For now, I start with a very simple template that I am planing to add features when more is needed on the go. The project is available, here.

cookie_cutter.sh is a bash script which will generate a new directory and some basic sub-folders and files.

How to run the script

First, please clone or download the cookie_cutter repository.

Then, move the cookie_cutter.sh file to the location in which you want to create your data science project.

If you moved cookie_cutter.sh already, now to generate a new data science project template, run the bash script called cookie_cutter.sh on your terminal:

$ bash cookie_cutter.sh

After you run the line above, it will ask you to specify your project name.

Please, write you project name but please do NOT use white space!!

(If you do leave white space, the script will generate one folder for each word, and only the first word will have the project template sub-folders.)

Project’s directory structure

Running the bash script in this repository will generate a new directory where you move your cookie_cutter.sh with the following data structure:

├── LICENSE.md     # MIT license
├── README.md      
├── CITATION.md      
├── doc/           # documentation
├── data/          # data sets directory
├──results/        # computational output directory
│   ├── figures        # figures and plots
│   └── tables         # tables
├── src/           # source code
├── bin/           # compiled scripts
└── from_joe/      # other important things for project        

LICENSE, CITATION, README markdown files are created in the root directory.

LICENSE.md initialize a MIT License for your project. You can modify or delete it afterwards.

Initially, README.md will have the information of project name, project owner and date created.

Now, you are ready to go! :)