skip to navigation
skip to content

PyMoJo 0.3

PyJoJo client library

Latest Version: 0.9.3


A client library for Pyjojo, which lives [here](
Together, they are [Mojojojo](!

## Usage

To interact with a Jojo server running on `localhost:9090`, which uses a self-
signed SSL certificate and HTTP Basic Authentication...

from pymojo.mojo import Mojo

mojo = Mojo(endpoint=localhost, port=9090, use_ssl=True, verify=False,
user="username", password="A good password")

script = mojo.get_script("my_script")
# script is now a JSON object detailing the remote script

resp ="my_script", {some_key="some value"})
# resp is a requests response object from which you can gather a
# resp.status_code and get the JSON body with resp.json()

# The Jojo server just reloaded its configuration

## More Details
Jojo is built to present system scripts in the form of a REST API. It has
essentially four functions:

* Get details about all scripts
* Get details about one script
* Reload the configuration
* Run a script

Mojo is a client library for this, which boils these things down to a
constructor and four functions:

* `reload()`
* `run(name, params={})`
* `get_script(name, use_cache=True)`
* `__get_scripts()`

The constructor accepts the following arguments:

* `endpoint` - The network path to the server. This should be an IP or domain.
* `port` - The port Jojo listens on (default: 3000)
* `use_ssl` - Whether or not to use HTTPS (default: False)
* `verify` - Whether to bother verifying Jojo's SSL certificate (default: True)
* `user` - The username for HTTP Basic Auth (default: None)
* `password` - The password for HTTP Basic Auth (default: None)

When you run the constructor, Mojo connects to Jojo, downloads the script index,
and caches that data. If you run `get_script`, the data will be returned from
this cache without consulting the server. Pass `use_cache=False` to force a
connection to the server. When you call `reload()`, this cache is refreshed.

You can run `__get_scripts()` manually if you like. Doing so will get you a
dictionary of scripts, but it will not update the cache.

When you call `get_script` with `use_cache=False`, a successful script retrieval
will cause the Mojo's cache to be updated with that data.

## Extending Mojo

Pyjojo is merely a remote script execution engine, and is meant to be extended
to meet the needs of its users. As-is, Pymojo can act on any custom scripts on
a Jojo server, but the specifics of a Jojo deployment can be easily wrapped up
in a class that inherits a Mojo.

Realistically, you'll use Jojo for things like remote service control or
software deployments, but for the sake of example, let's say our Jojo server
only knows how to execute one script, ``, which looks like this:


# -- jojo --
# description: echo
# param: text - Text to echo
# -- jojo --

echo ${TEXT}
exit 0

We'll make a special kind of Mojo built to run this echo script. We'll call it
an Echojo.

class Echojo(Mojo):
def __init__(self, **kwargs):
Mojo.__init__(self, **kwargs)

def echo(self, text):
return"echo", {"text" : text})

Simply put, it takes the same Jojo configuration options that Mojo takes,
and then passes them on to the superconstructor. The `echo` function passes
data through the superclass's `run` function and passes the result back up.  
File Type Py Version Uploaded on Size
PyMoJo-0.3.tar.gz (md5) Source 2014-03-24 3KB