Skip to main content

A Python client library for communication with Guacamole server (guacd)

https://travis-ci.org/mohabusama/pyguacamole.svg?branch=master https://img.shields.io/pypi/v/pyguacamole.svg https://img.shields.io/pypi/pyversions/pyguacamole.svg https://img.shields.io/github/license/mohabusama/pyguacamole.svg https://img.shields.io/pypi/status/pyguacamole.svg

Installation

Using pip

$ pip install pyguacamole

From source

$ python setup.py install

Usage

GuacamoleClient handles communication with a running guacd server via Guacamole Protocol.

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 and is based on the initial effort by Rescale django-guacamole project.

Metadata

Release files for unimatrix.ext.guacamole 0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for unimatrix.ext.guacamole 0.9
File Size Uploaded
unimatrix.ext.guacamole-0.9.tar.gz 7.9 kB Details

Release files / unimatrix.ext.guacamole-0.9.tar.gz

Download URL unimatrix.ext.guacamole-0.9.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b646e345b6b722ab3f066bfe0c31503db52f4804110340ae544043bb42228374
BLAKE2b-256 checksum
How to use checksums
038e0d17a47d0378107cef990cde79e033518cf278460606020a301216067bb1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.9 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page