poof's Introduction

poof

Quickly open "your setup" from the command line. Some examples of setup's:

Web development
Writing
Music
Android development
Note-taking

Poof automates the process of starting up applications that comprise these setups. It's designed for Mac OS X, and currently does not work on other platforms.

installation

from pip:

$ pip install poof

or from source:

clone this
cd into it
$ pip install .

Now $ poof will be available at the command line.

usage

A setup is known as a space. An application within the space is known an application.

first, create a new space:

$ poof space <space-name>

add an application to the space:

$ poof add <space-name> <application-name>

You can add as many applications to a space as you'd like. When you add an application, the script will check for a close match in /Applications/. So clearly, this won't cover all possible executables you'd like to launch, but it will cover most all traditional applications.

It uses a fuzzy search library to find this close match, so don't worry about entering the application name exactly as-is.

startup a space:

$ poof start <space-name>

This will launch all application in that space.

If you need to, you can either delete the entire space or a single application in the space.

delete an application from a space:

$ poof delete <space-name> <application-name>

delete an entire space:

$ poof delete <space-name>

if you're a lost puppy:

$ poof help

underlying form

As mentioned above, this will only work on OS X. This is because it launches applications out of /Applications/.

Poof stores the data in a simple JSON file at $HOME/.poof. This is the only place any data is stored - and messing with this file is not advised.

It uses fuzzywuzzy for fuzzy search, and click as a command line library.

contributing

Support for other platforms, tab-completion, more customization...that's what's on the agenda. PR's welcome!

poof's People

Stargazers

Watchers

poof's Issues

poof help typo in "space" command

On latest poof, installed Jan 19, 2016 via pip install poof, the short description for command "space" uses "add" instead of "space.

poof help
Usage: poof [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  add     $ poof add <existing-space> <new-application>
  all     list all spaces and applications
  delete  $ poof delete <space> [<application>]
  help    this help page
  space   $ poof add <new-space-name>
  start   $ poof start <space-to-start>

PyPI - poof package name

Hi Andrew!

We're about to publish a project to PyPI, poof backup, and we'd love to use the name poof instead of poof-backup when we publish it. We saw that your poof project has been inactive for 5 years. Would you be OKi with removing the project from PyPI or with us claiming the name?

You may see the our poof project here: https://github.com/poof-backup/poof

Thanks in advance,

E
https://github.com/pr3d4t0r

ahoskins / poof Goto Github PK