shell environment recorder and manager
Python Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
python
.gitignore
README.txt
TODO.txt
setup.sh
usage.txt

README.txt

This is EnvWatcher.
===================
A project by Simon Heisterkamp.
  Please send comments/suggestions/bugs to EnvWatcher@gmail.com)
  ( Please also read the section below on reporting bugs. )

Requirements
============
    - bash
    - python
        Tested for python 2 version 2.4 and up.

SETUP
=====
Simply source the script setup.sh

    $ source path/to/EnvWatcher/setup.sh

You will now have access to the command env-watcher.
A short help message showing the available command-line options is shown when calling

    $ env-watcher --help
    
Full usage information can be found in the file usage.txt or by calling 

    $ env-watcher usage

Description
===========

env-watcher is able to monitor your bash environment and record changes that you make to
it. One can then ask the env-watcher to undo those changes.

In its functionality the env-watcher is not unlike other dynamic environment loaders
like, for example, 'module' (http://modules.sourceforge.net/). However, module requires
the user to write special tcl modules in order to be able to load and unload them. The
advantage of env-watcher is that it can accept and recognize changes made by any other
shell-script because it relies on 'before' and 'after' snapshots of the shell
environment.

The env-watcher monitors
    - environment variables
    - local variables
    - shell functions
    - aliases

Example Session
===============

Here I am showing an example session of things that one can do with the env-watcher:

    simon> source EnvWatcher/setup.sh 
    simon> env-watcher start mysession
    Started recording session 'mysession'

the session 'mysession' is now started. Any changes to the environment from now on
will be saved.

    simon> foo=bar
    simon> export hello=world
    simon> export PYTHONPATH="$PWD/EnvWatcher/python:${PYTHONPATH}"
    simon> env-watcher stop mysession
    Saved record with name 'mysession'

we can view the available records with "list":

    simon> env-watcher list
    No open sessions.
    Avaliable records:
    	mysession

to see the differences we can use "display":

    simon> env-watcher display mysession
    BashEnvVariable("PYTHONPATH"):
    { Path difference:
         added: /Users/simon/code/EnvWatcher/python
    }
    BashLocVariable("foo"): { n/a => 'bar' }
    BashEnvVariable("hello"): { n/a => 'world' }

The env-watcher noticed the shell and environment variables that we added.
I also detected that a path was added to the PYTHONPATH. We can now undo those
changes by using "undo":

    simon> env-watcher undo mysession
    Now reverting changes recorded for session 'mysession'

Finally we verify that our changes have been reverted.

    simon> echo $foo

    simon> echo $bar

    simon> echo $PYTHONPATH | grep EnvWatcher
    simon> 


BUGS
====

In the unlikely event that you encounter any bugs *ahem* please do the following:
  - Repeat the steps that lead you to the bug using debug-mode in each step.
    Debug mode is enabled by including the -d option on the command line.
  - Send me the entire output of your session.
  - Send me the log-files that are located in $ENV_WATCHER_DIR/Log_*.txt
    (They only get written in debug mode.)
Please send all of the above information to EnvWatcher@gmail.com
Thank you. I will hopefully get back to you soon.

LICENCE
=======

Copyright (C) 2011 Simon Heisterkamp and contributors

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.