Git Product home page Git Product logo

cookiecutter's Introduction

Cookie cutter

Cookie cutter provides a folder structure for sharing and developing data science work. This project is inspired by a similar project developed by Daniel Chen.

Folder structure

The cookie.sh script creates the following folder structure

root
|
|-- README
|-- LICENSE
|-- data
|   --
|-- bin
|   --
|-- docs
|   --  
|-- models
|   --
|-- results
|   --
|-- scripts
|   --
|-- CITATIONS
|-- contributions
|-- conduct
|-- requirements

How to download

  1. Fork/clone the repo to your system.
  2. Download the cookie.sh file by right-click > save link as.. from the raw button.

How to run it

Navigate to the folder where the file cookie.sh is saved and run the following command from the terminal -

bash cookie.sh

The script will have prompts to specify location of directory and name of the project folder.

An example of the path that can be specified -

/c/Users/User1/Desktop

Note: The output can be observed in the project folder created in this path

Other cookie cutter projects

There are others trying to develop similar cookie cutter templates for data science projects if my project does not meet your requirements -

  1. https://github.com/chendaniely/computational-project-cookie-cutter
  2. https://github.com/ardydedase/cookiecutter-pypackage

Author

Developed by Abishek Murali, Nov. 2017.

cookiecutter's People

Contributors

abishek-murali avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.