Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Guacamole is an command line tool library for Python

Project description

============================================================
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``.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for guacamole, version 0.9.2
Filename, size File type Python version Upload date Hashes
Filename, size guacamole-0.9.2-py2.py3-none-any.whl (32.4 kB) File type Wheel Python version 2.7 Upload date Hashes View hashes
Filename, size guacamole-0.9.2.tar.gz (59.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page