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.

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()

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

Uploaded Source

Built Distribution

guacamole_api_wrapper-0.1.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for guacamole-api-wrapper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6940d59239f468537fb95377fb6e0a2b2046b7decfa762d85260350801e17b29
MD5 8187d69e878daebe656314c18c2feadc
BLAKE2b-256 5f25391912407c03aafca0c28b117d66392947b086e603766b51a05cd16d0453

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for guacamole_api_wrapper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3773aa1784d5b7cd0a044909575c782430dbdf546150f923e50cfc8f914bfde2
MD5 0c82f3fce25002a3bb01f5a82721f8ae
BLAKE2b-256 553311e9b42b017a5a334acecfe274d7a374853105ce6a688aa67bf186608354

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