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

Uploaded Python 3

File details

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

File metadata

  • Download URL: guacli-1.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 f2b24b295ad6a59fef38b128f5935e3f9ddf27f14d4f24e9b74b36e958be5e34
MD5 dc358da813280691e23a5b58abb82561
BLAKE2b-256 7e8f7b953134e0fe878c42161307f3edb3ab5db17d200281495f61d86d26ff86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: guacli-1.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6985db86aaa0ef8196207b0eee8e47e31a82d1b5b9cdd05ab57151d1784c7236
MD5 45b8a6f61c570f9e5ff103b9965fdf5c
BLAKE2b-256 c87a454639b84ea346bfcc4a32ee7a50e2e3d8be3f8aa9ba1163c70cbe804190

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