Skip to main content
============================================================
Guacamole - Framework for Creating Command Line Applications
============================================================

.. image:: https://badge.fury.io/py/guacamole.png
:target: http://badge.fury.io/py/guacamole

.. image:: https://travis-ci.org/zyga/guacamole.png?branch=master
:target: https://travis-ci.org/zyga/guacamole

.. image:: https://pypip.in/d/guacamole/badge.png
:target: https://pypi.python.org/pypi/guacamole

Tools, done right
=================

Guacamole is a LGPLv3 licensed toolkit for creating good command line
applications. Guacamole that does the right things for you and makes writing
applications easier.

.. testsetup::

import guacamole

.. doctest::

>>> class HelloWorld(guacamole.Command):
... """A simple hello-world application."""
... def register_arguments(self, parser):
... parser.add_argument('name')
... def invoked(self, ctx):
... print("Hello {0}!".format(ctx.args.name))

Running it directly is as simple as calling ``main()``:

.. doctest::

>>> HelloWorld().main(['Guacamole'], exit=False)
Hello Guacamole!
0

What you didn't have to do is what matters:

- configure the argument parser
- define and setup application logging
- initialize internationalization features
- add debugging facilities
- write a custom crash handler

Features
========

* Free software: LGPLv3 license
* Documentation: https://guacamole.readthedocs.org.
* Create command classes and run them from command line.
* Group commands to create complex tools.
* Use recipes, ingredients and spices to customize behavior





History
=======

0.9.2 (2015-08-06)
------------------

* Fix https://github.com/zyga/guacamole/issues/11

0.9.1 (2015-08-06)
------------------

* Fix https://github.com/zyga/guacamole/issues/9

0.9 (2015-05-11)
----------------

* Vastly improved documentation
* Bugfixes and changes based on early feedback
* New cmdtree module with two ingredients (for instantiating commands and for
dispatching the invoked method)
* Simplified argparse ingredient (for just handling parser)
* Unit tests and doctests for some of the functionality

0.8 (2015-04-21)
----------------

* First release on PyPI.


2012-2015
---------

* Released on PyPI as a part of plainbox as ``plainbox.impl.clitools``,
``plainbox.impl.logging``, ``plainbox.i18n`` and
``plainbox.impl.secure.plugins``.

Metadata

Release files for guacamole 0.9.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for guacamole 0.9.2
File Size Uploaded
guacamole-0.9.2.tar.gz 59.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for guacamole 0.9.2
File Interpreter ABI Platform
guacamole-0.9.2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 91.8 kB

Release files / guacamole-0.9.2.tar.gz

Download URL guacamole-0.9.2.tar.gz
Size 59.4 kB
Tags Source
SHA-256 checksum
How to use checksums
77223263d5e7b8958f5456394af4fd54cda8f2579230f34e9561ca5d0a870d5f
BLAKE2b-256 checksum
How to use checksums
1af950c83a812015a7b4cf7279c5202ce6cce5542e2abeb7229d5a4be79ff594
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / guacamole-0.9.2-py2.py3-none-any.whl

Download URL guacamole-0.9.2-py2.py3-none-any.whl
Size 32.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
da3e5dadef0c77fcbef3f1d7f43b4bf0e94def7ea06381ecca0aba06eeb688c4
BLAKE2b-256 checksum
How to use checksums
123200933c2e6fb116957774c0b4274258d5dbe8ac83ea959b63ad44cb169749
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.9.2 This release

2 release files

0.9.1

2 release files

0.9

2 release files

0.8

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page