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.

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.11.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyguacamole-0.11.tar.gz
  • Upload date:
  • Size: 6.5 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.11.tar.gz
Algorithm Hash digest
SHA256 d6facde097a1b1a3048b20fb2ff88b024744ceb2865fb912525da7ebb7779695
MD5 4a2557dc99094d8553249cacfc7caf8d
BLAKE2b-256 40c68c56fffdc5a8f5d193768a827db8acb3c835cabaf641acb24e41ceb0ac83

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyguacamole-0.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 7f8d8652ce2e86473d72a50e0c9d8a8e0c3c74e373c6b926ca4c851774cae608
MD5 9d216ea895a3efca41745cad8563ca1c
BLAKE2b-256 9868ee6b8c06beca8094305c0f75136941b3c84a62b9682a2ab374d119a40b31

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.11 This release

2 files

0.10

2 files

0.9

2 files

0.8

2 files

0.7

2 files

0.6

1 file

0.3

1 file

0.2

1 file

0.1

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page