A Guacamole python client library.
Project description
# PyGuacamole
A Python client library for communication with [Guacamole](http://guac-dev.org/) server (guacd)
[![Build Status](https://travis-ci.org/mohabusama/pyguacamole.svg?branch=master)](https://travis-ci.org/mohabusama/pyguacamole)
## Installation
Using pip
` $ sudo pip install pyguacamole `
From source
` $ sudo python setup.py install `
## Usage
GuacamoleClient handles communication with a running guacd server via [Guacamole Protocol](http://guac-dev.org/doc/gug/protocol-reference.html).
GuacamoleClient must be used by a broker server which handles communication with a Javscript application running in the browser. GuacamoleClient implements the methods that enables communication with guacd server (send & receive).
First step should be establishing handshake with guacd server, then Broker server should handle instruction sending and receiving:
send: send instruction to guacd server
receive: receive instruction from guacd server
` >>> from guacamole.client import GuacamoleClient >>> client = GuacamoleClient('127.0.0.1', 4822) >>> client.handshake(protocol='rdp', hostname='localhost', port=3389) `
Once instruction is received from guacd server, it should be sent immediately to the browser
` >>> instruction = client.receive() >>> instruction '4.size,1.0,4.1024,3.768;' `
and once instruction is sent from browser, it should be sent immediately to guacd server
` >>> instruction = '5.mouse,3.400,3.500;' >>> client.send(instruction) `
## Notes
PyGuacamole is released under the [MIT License](https://raw.githubusercontent.com/mohabusama/pyguacamole/master/LICENSE) and is based on the initial effort by Rescale [django-guacamole](https://github.com/rescale/django-guacamole) project.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.