Skip to content

trevormunoz/dumbwaiter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dumbwaiter

An ETL pipeline for NYPL menus data

DOI

Script for processing open data released by the New York Public Library's What's on the Menu? project.

Setup

dumbwaiter depends on the pandas data analysis library, which in turn depends on several of the numerical and scientific computing libraries available for python. Since these can be a pain to install, we recommend using the Anaconda distribution to manage and isolate these dependencies:

  1. Install Anaconda for your platform
  2. Create a new environment conda create -n dumbwaiter python=3.4 pandas pip pytz --yes
  3. Follow the instructions in your terminal to activate and use this environment
  4. Proceed with the standard python install below
git clone https://github.com/trevormunoz/dumbwaiter.git
cd dumbwaiter
pip install -r requirements.txt
python setup.py install

Usage

When you install you will get a command line program dumbwaiter which takes a required path to a directory containing a copy of the NYPL's data file as a tar.gz (this file is available to download here).

$ dumbwaiter /path/to/data/dir

dumbwaiter expects an elasticsearch server to be running to accept data as bulk uploads — you can optionally specify the hostname and port to use:

$ dumbwaiter /path/to/data/dir -s localhost -p 9200

License

Licensed under the MIT License (MIT)

Copyright (c) 2015 Trevor Muñoz and Katie Rawson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Workflow for processing open data released by the New York Public Library's What's on the Menu? project

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages