Giter Club home page Giter Club logo

utilityknife's Introduction

UtilityKnife

Animated GIF demo UtilityKnife is a web application that visualizes a user's Dropbox space usage/allocation as a treemap. It is similar to desktop programs like Windirstat, KDirStat, Disk Inventory X, Grand Perspective, and Space Monger.

UtilityKnife was built in under 40 hours by Kevin Conley and Carolynn Sullivan at the PennApps Fall 2013 hackathon.

Inspiration

UtilityKnife's visualization using the treemap from D3.js was heavily inspired by and built on Ben Garvey's Philadelphia budget visualization web application: http://budget.brettmandel.com/

Getting started

Prerequisites

  • Python 2.6
  • pip
  • virtualenv
  • redis

Virtualenv

After cloning the repository, create a virtualenv called "venv" and activate it:

virtualenv venv
. venv/bin/activate

Then use the requirements.txt file to install the requirements for the app:

pip install -r requirements.txt

Environment Variables

There are several important environment variables that must be defined for the app to work. These are listed in "secrets.py", and it is helpful when working locally to define them in a file called ".env" that foreman will load automatically:

".env"

DROPBOX_APP_KEY=fill_me_in
DROPBOX_APP_SECRET=fill_me_in
DROPBOX_APP_REDIRECT=fill_me_in
FLASK_SECRET_KEY=fill_me_in

Likewise, it is important to define these environment variables for the production server (i.e. Heroku).

Running the App

First, open a terminal and start the redis server:

redis-server /path/to/redis.conf

Then, open another terminal and start the app with:

foreman start

If all goes well, you should be able to access the app locally at 127.0.0.1:5000.

License

The MIT License (MIT)

Copyright (c) 2013 Kevin Conley

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.

utilityknife's People

Contributors

ebensh avatar

Watchers

Aaron Harris 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.