# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/chaimeleon-eu/guacamole-python-client",
"name": "guacli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cli client guacamole api",
"author": "Pau Lozano",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b7/d9/a9b99f8d3a595fb77dadcff32ce8410fea38d25017d83d7eb6eb7fc7c93b/guacli-1.1.1.tar.gz",
"platform": null,
"description": "# guacli\r\n\r\nA python client (library and CLI) for the Apache Guacamole front-end REST API.\r\n\r\n## Requirements\r\n\r\nTested with python 3.10.2 and 3.6.9.\r\n\r\n## Install\r\n\r\n```\r\npip install guacli\r\n```\r\n\r\n## Example of use\r\n\r\n```\r\nguacli --help\r\nguacli --url \"https://example.com/guacamole\" --user guacadmin create user james-smith\r\n```\r\n\r\n## Upgrade\r\n\r\n```\r\npip install --upgrade guacli\r\n```\r\n\r\n## Uninstall\r\n\r\n```\r\npip uninstall guacli\r\n```\r\n\r\n## Manually install\r\n\r\n```\r\ncd /opt\r\ngit clone https://github.com/chaimeleon-eu/guacamole-python-client.git\r\nmv guacamole-python-client/guacli/cli.py guacamole-python-client/cli\r\nchmod +x guacamole-python-client/cli\r\nln -s /opt/guacamole-python-client/cli /usr/local/bin/guacli\r\n```\r\n\r\n## For developers\r\n\r\n### Run without install\r\n\r\n```\r\npython -m guacli.cli --help\r\n```\r\n\r\n### Test setup\r\n\r\nTest the setup.py:\r\n```\r\npip install --log install.log .\r\n```\r\nUninstall with:\r\n```\r\npip uninstall guacli\r\n```\r\n\r\n### Build the package\r\n\r\nREF: https://packaging.python.org/en/latest/tutorials/packaging-projects/\r\n\r\nRequirements:\r\n```\r\npython -m pip install --upgrade build\r\npython -m pip install --upgrade twine\r\n```\r\n\r\nBuild:\r\n```\r\ncd guacamole-python-client\r\npython -m build\r\nls dist\r\n```\r\nTwo files are generated: \r\n - guacli-VERSION.tar-gz is the source package\r\n - guacli-VERSION-py3-none-any.whl is the built package\r\n\r\nThen upload the package:\r\n```\r\npython -m twine upload dist/*\r\n```\r\nIf you want to test previously, add `--repository testpypi` for uploading to test.pypi.org.\r\n\r\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python client (library and CLI) for Apache Guacamole front-end REST API.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/chaimeleon-eu/guacamole-python-client"
},
"split_keywords": [
"cli",
"client",
"guacamole",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93f753e00e7afc680f43930cfb4077e484d3f1a6e25b02560b03ff2e49c05323",
"md5": "359ff729bb842c72eca55800ef30ff02",
"sha256": "6ed7d3e54f20fb56977c5d245f3bd580f20c77b8864dfc9ad4972c1449fa5c18"
},
"downloads": -1,
"filename": "guacli-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "359ff729bb842c72eca55800ef30ff02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11893,
"upload_time": "2023-05-21T19:31:35",
"upload_time_iso_8601": "2023-05-21T19:31:35.817797Z",
"url": "https://files.pythonhosted.org/packages/93/f7/53e00e7afc680f43930cfb4077e484d3f1a6e25b02560b03ff2e49c05323/guacli-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7d9a9b99f8d3a595fb77dadcff32ce8410fea38d25017d83d7eb6eb7fc7c93b",
"md5": "2c3b1fe6293b97252e96424b96cdd824",
"sha256": "53944f70426a6e95f3b92ea03d6d9508f03dee19914d8b72939a2bc831e09344"
},
"downloads": -1,
"filename": "guacli-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2c3b1fe6293b97252e96424b96cdd824",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11770,
"upload_time": "2023-05-21T19:31:41",
"upload_time_iso_8601": "2023-05-21T19:31:41.794825Z",
"url": "https://files.pythonhosted.org/packages/b7/d9/a9b99f8d3a595fb77dadcff32ce8410fea38d25017d83d7eb6eb7fc7c93b/guacli-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-21 19:31:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaimeleon-eu",
"github_project": "guacamole-python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "guacli"
}
JSON
