Skip to main content

Python client (library and CLI) for Apache Guacamole front-end REST API.

Project description

guacli

A python client (library and CLI) for the Apache Guacamole front-end REST API.

Requirements

Tested with python 3.10.2 and 3.6.9.

Install

pip install guacli

Example of use

guacli --help
guacli --url "https://example.com/guacamole" --user guacadmin create user james-smith

Upgrade

pip install --upgrade guacli

Uninstall

pip uninstall guacli

Manually install

cd /opt
git clone https://github.com/chaimeleon-eu/guacamole-python-client.git
mv guacamole-python-client/guacli/cli.py guacamole-python-client/cli
chmod +x guacamole-python-client/cli
ln -s /opt/guacamole-python-client/cli /usr/local/bin/guacli

For developers

Run without install

python -m guacli.cli --help

Test setup

Test the setup.py:

pip install --log install.log .

Uninstall with:

pip uninstall guacli

Build the package

REF: https://packaging.python.org/en/latest/tutorials/packaging-projects/

Requirements:

python -m pip install --upgrade build
python -m pip install --upgrade twine

Build:

cd guacamole-python-client
python -m build
ls dist

Two files are generated:

  • guacli-VERSION.tar-gz is the source package
  • guacli-VERSION-py3-none-any.whl is the built package

Then upload the package:

python -m twine upload dist/*

If you want to test previously, add --repository testpypi for uploading to test.pypi.org.

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

guacli-1.1.4.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

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

guacli-1.1.4-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file guacli-1.1.4.tar.gz.

File metadata

  • Download URL: guacli-1.1.4.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for guacli-1.1.4.tar.gz
Algorithm Hash digest
SHA256 d95577033a04626495485ce9d7c4c7e2565b3824bb039e22cd5c5c1b43d9ed51
MD5 a1a932875c5d23f06e220500e456f17d
BLAKE2b-256 cbd8c9f9aac1d58908fa575a2e7f4cfeeabd5b46ef48c4b974a1a4b193c2453a

See more details on using hashes here.

File details

Details for the file guacli-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: guacli-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for guacli-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 785f505eb868c4804122a0f9ac19f24fcf400df172e0fa3495d6690b9b333b97
MD5 dd0922ec6f2793627bdb9ce2491d1c22
BLAKE2b-256 74ebe86997ce4211314392acb81af819d569bb0c5a4075aefdfa53ac0f35d7c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page