Skip to main content

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.

Overview

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
    list
  • Sharing Profiles
    list, create, delete

Work in Progress

  • Code Enhancements
  • CI/CD for auto deployment

Install

pip install guacamole-api-wrapper

Usage

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

syntax:

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

example:

session = guacamole.session("https://web.app/guacamole", "mysql", "guacadmin", "guacadmin")

session.list_users()

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

Uploaded Source

Built Distribution

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

guacamole_api_wrapper-0.0.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file guacamole-api-wrapper-0.0.1.tar.gz.

File metadata

  • Download URL: guacamole-api-wrapper-0.0.1.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for guacamole-api-wrapper-0.0.1.tar.gz
Algorithm Hash digest
SHA256 d76a61755e45667e07f1b00942585aeb36569219b8d2c966748efa8db088fc65
MD5 eeb8e0d5883782e83e839977912b4e31
BLAKE2b-256 ecd4be57274a5398242499e014900b4e2e3bc3e3e073121bc1f3be4fd4426755

See more details on using hashes here.

File details

Details for the file guacamole_api_wrapper-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: guacamole_api_wrapper-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for guacamole_api_wrapper-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e662228a04b4aabb2fbd89bffdf93de6c8c2985a1835569c2d64667f870cec87
MD5 612b94b6b96c431a686229efac350e8f
BLAKE2b-256 cbdb39d578c54396ace70a166fd860689c8b0c6ab5e659866eec08741d5f4137

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.0

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

This release

0.0.1 This release

2 files

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