Skip to main content

A Python package that allows for simple interactions with Apache Guacamole REST API as a wrapper

Project description

Guacamole Wrapper Package

pipeline status

This is a simple package that allows you to take advantage of all currently available REST API calls within Apache Guacamole.


This package creates a class named session allowing you to interact with the REST API for Apache Guacamole in various ways. Full capabilities include:

  • Generating and Deleting your REST API Auth token
  • Users & UserGroups
    list, create, update, delete
  • Connection & ConnectionGroups
    list, create, update, delete
  • List Schema Info
  • Sharing Profiles
    list, create, delete

Work in Progress

  • Code Enhancements
  • CI/CD for auto deployment


pip install guacamole-api-wrapper


The overall usage capabilities of this module are extensive, I would recommend you leverage a good ide that can show all available functions and arguments. I tried to ensure each function has a basic comment and I have tested all functionality, but am always looking for ways to break it in order to improve it.

Initial Module Import:

import guacamole

Defining session arguments and then list users


guacamole.session("https://{guacamole_base_url}", "{datasource}", "{username}", "{password}")


session = guacamole.session("", "mysql", "guacadmin", "guacadmin")


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

guacamole-api-wrapper-0.0.4.tar.gz (8.2 kB view hashes)

Uploaded source

Built Distribution

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