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

Uploaded Source

Built Distribution

pyguacamole-0.8-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyguacamole-0.8.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.1

File hashes

Hashes for pyguacamole-0.8.tar.gz
Algorithm Hash digest
SHA256 b7dca3b0e3d63e319c0794a4f506e9cac7b4b24aa510853e7498ec6088efff77
MD5 44befe97075c33347c4d8a9f0ab4617f
BLAKE2b-256 439f76b455a74eda8c33b679096c3fddf2d213ce890ca1af96154a9cf6a55513

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyguacamole-0.8-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.1

File hashes

Hashes for pyguacamole-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0763da1ea159c1e9f6a07117abcdd1eca8bb81fd7ad2e9e55b0a237c9dc4f7e4
MD5 e5b184a6c9391be31fe65ab4dfb3e559
BLAKE2b-256 3edd9442a2ec162aaa33aa78c050ed81646fc011ea45a596ab40fe88319fbc5f

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