====================================
Nimboss: The Nimbus Provisioning API
====================================


Install
=======

Create a virtualenv:
    $ virtualenv nimboss_env

Install dependencies:
    $ pip -E nimboss_env install zope.interface httplib2 simplejson
    $ cd nimboss_env
    $ git clone git://github.com/apache/libcloud.git
    $ cd libcloud; python setup.py install; cd ..

Install Nimboss:
    $ git clone git@github.com:clemesha-ooi/nimboss.git # Read+Write, or use "git://...".
    $ cd nimboss
    $ python setup.py install


Tests
=====

Nimboss currently uses Python's unittest framework.

To run tests:
    $ cd tests
    $ python tests.py




Layout of Nimboss
=================

node.py
-------
Node specific connection and management.

cluster.py
----------
Cluster management and driver implementation for both EC2 and Nimbus.
Support for Cluster creation, termination, and status querying.

broker.py
---------
Communication with the Nimbus Context Broker.
Support for creating Context and querying Cluster status.

nimbus.py
---------
Nimbus 'Cluster document' and 'Cluster spec' utitlities.