penv 0.1

Framework for ease project management tools building.

Framework for ease project management tools building.

Principal rule is like autoenv from Kenneth Reitz but with more fun. It basically allows you to create plugins (in Python) that are activated/deactivated then entring/leaving project directory (directory that contains “.penv”)

Installation:

$> pip install penv

# And put following to your .bashrc
# eval "`penv --override-cd-bash`"

Usage:

# overriden "cd" function generation
$> penv --override-cd-bash

# Generated output is following:
#
# function cd () {
#     builtin cd "$@" && eval "$(penv scan)"
# }
#
# so that's why, in order to activate it, you should put
# following to your .bashrc:
#
# eval "`penv --override-cd-bash`"

So… what it does?

Well why not just ask program itself?:

# Case 1) - no ".penv"
$> cd /tmp
$> penv scan
# Scanning: /tmp | OLDPWD=/tmp
# Scanning: / | OLDPWD=/tmp
#
# ^^^^ haven't found anything but, as you can see, it doesn't
# stop when it fails immediatelly - it searches for ".penv"
# in parent directory, too.

# Case 2) with ".penv" directory
$> cd /tmp
$> penv scan
# Scanning: /tmp | OLDPWD=/tmp
#     new env found (/tmp/.penv) and it shouldn't be skipped, so generating activation scripts
#     ##############################
#     Following places will be checked for plugins existance:
#        /home/<user>/.penv/.plugins
#        /tmp/.penv/.plugins
#        /tmp/.penv-plugins
#     ##############################

# <GENERATE BASH CONTENT GOES HERE>

#     generation script done.

Basically it searches for “.penv” directory whereever you go with “cd” command (assuming you’ve installed it in .bashrc) and activates whatever plugins are generating.

Ok, so why it’s cool?

1. It’s very simple: basically it’s just providing hooks for “cd” and “cd ..” commands. Allows you to activate environment or your own specific tools and deactivate them when your leaving project directory.

2. Pluginable nature allows you to customize environment for each project and reuse plugins.

3. When you’ll have to deal with 100 projects each having Makefile you have to maintain you’ll probably understand why two above reasons are important.

TODO

• docs for plugins

• some tests wouldn’t hurt

Authors

• Jakub Janoszek ([e-mail])