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.2.1.tar.gz (13.2 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.2.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for guacli-1.2.1.tar.gz
Algorithm Hash digest
SHA256 23bed41cf0d8a1e8752ea41cb82c963d38d184eeee1d36eea8b6c81880fcad23
MD5 63bf9d4fbd6199dc158e938fb17b962a
BLAKE2b-256 62ad02e443a6881e79c27a0b5490bad7a3ed14022cffd0a1186c61f293766c2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: guacli-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf16d2855eca3fc9af5d879d1c61d5d892846597a7c06729a5f1756063db9e98
MD5 2c283c7604afe23df090ecfa348dbac7
BLAKE2b-256 c99f4b43ddd4c841e497a04c8b0cdc80a40930bb906db65edd5d50bff5f19bd7

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