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.3.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.3-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: guacamole-api-wrapper-0.0.3.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for guacamole-api-wrapper-0.0.3.tar.gz
Algorithm Hash digest
SHA256 a76b86ebe84018b984b0a8c3f63566c61623e6e4fcd48158b1000308cabf27ca
MD5 20c421f9c6e6887f0e78dda0d4e0f6f8
BLAKE2b-256 bfe28f2935a32f6b4609873f94f1148cc8259c3cb5022c11f3eb7e277c568a7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for guacamole_api_wrapper-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 43573332b4afa57950bc01e73eaa9fedd62c902956e25ae1d9d5e7951efedc59
MD5 1d9ef9ed090b770ff7f5d7f28669a9fe
BLAKE2b-256 85d0ac7cd26a754984ce65cd5517587b9845f002064d925080007db00ba4637a

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

This release

0.0.3 This release

2 files

0.0.2

2 files

0.0.1

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