Giter Club home page Giter Club logo

pbp_cookiecutter's Introduction

Cookiecutter Template: Repeatable Data Analysis with Notebooks

A cookiecutter template for simple data analysis.

Full details and walk-through over at Practical Business Python: Building a Repeatable Data Analysis Process with Jupyter Notebooks on the background and how to use this cookiecutter template.

Folder structure

This template will jumpstart your data science projects with the following predictable organizational file structure:

.
├── 1-Data_Prep.ipynb  # Data prep notebook
├── 2-EDA.ipynb        # Final analysis notebook
├── data               # Categorized data files
│   ├── external       # External data files  
│   ├── interim        # Working folder
│   ├── processed      # Cleaned and ready to use
│   └── raw            # Unmodified originals
└── reports            # Final reports

Installation

To use Cookiecutter, you must have it installed along with Python 3. Once you have Python installed, the recommended way to install Cookiecutter is as follows. Install to the current user's folder, upgrade if available:

$ pip3 install -U --user cookiecutter

Usage

Then in the folder you want to contain the project you're starting, run the template as follows, answering the questions as relevant to your project:

$ cookiecutter https://github.com/talkpython/pbp_cookiecutter        
project_name [project_name]: data_journalism_project
directory_name [data_journalism_project]: 
description [More background on the project]: Research into latest news trends.

Now, in this example, we'll have a folder data_journalism_project with the structure described above ready to get to work!

pbp_cookiecutter's People

Contributors

chris1610 avatar mikeckennedy 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.