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

Uploaded Python 3

File details

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

File metadata

  • Download URL: guacli-1.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 cfde2c26e7a6970221299807bfc65f643bfb84029d01bdbed45e68a4ea2b64b5
MD5 5eadafbf55763ba2521f5b15a72144b1
BLAKE2b-256 b8c7166d1882aea84a91f04b7d6f6dca0023e05b93f47202eb474a15c30481f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: guacli-1.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 736930150e231dcf61b73281ad670aad017f58383c272dea923a73151a483ecd
MD5 dc1fffbf9824699a5e16cf59c273b11f
BLAKE2b-256 3f62af3832749682162a498fc1573032b2e2ac010b78f96a2f2bacaeef5daf7d

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