Skip to main content

A Guacamole python client library.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyguacamole-0.10.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

pyguacamole-0.10-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file pyguacamole-0.10.tar.gz.

File metadata

  • Download URL: pyguacamole-0.10.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2

File hashes

Hashes for pyguacamole-0.10.tar.gz
Algorithm Hash digest
SHA256 31b619a05e00a9e5e6fde4d4003a2a126f73ed63207b34eb08f8c0d733d94d3f
MD5 28e8479df26708e91190940d67ce078b
BLAKE2b-256 d2dc61136fa1a73b69b58f885d2d644062f8afd13db867156b4612b1069a7898

See more details on using hashes here.

File details

Details for the file pyguacamole-0.10-py3-none-any.whl.

File metadata

  • Download URL: pyguacamole-0.10-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2

File hashes

Hashes for pyguacamole-0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 4de2d25cb5dc76d3fab6d26e0a1fe908b700508cc24e093bcc9f015a1975e555
MD5 4871ea6f13112afc9dbd0d76cf72496c
BLAKE2b-256 40e608b04508f6f5f94fe835ec78769b99aa7fc833985d576f9282ee716777f1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page