https://github.com/op/argcmd

Library for easy creation of Python scripts together with argparse
https://github.com/op/argcmd

Last synced: about 2 months ago
JSON representation

Library for easy creation of Python scripts together with argparse

• Host: GitHub
• URL: https://github.com/op/argcmd
• Owner: op
• Created: 2010-12-28T08:56:37.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2011-03-25T04:28:05.000Z (almost 14 years ago)
• Last Synced: 2024-10-14T10:57:18.753Z (3 months ago)
• Language: Python
• Homepage:
• Size: 109 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
argcmd

======

Easy sub-command program creation with argument parsing and interactive shell.

Together with the power of `argparse`_, this small library removes most of the

boiler plate you often write when you need to create python programs. It

gathers all commands from one module and presents them as sub-commands, similar

to eg. git.

It also comes with an optional interactive shell. When your program is run

without any specific sub-command, a readline based shell is started which

has simple command completion and history (currently via ``--enable-history``).

Think of eg. gdb.

.. _argparse: http://code.google.com/p/argparse/

Usage

-----

There are two ways of creating programs. First way is by prefixing the method

names with ``cmd_`` or registering them with the ``@command``-decorator.

Second way is by subclassing the ``ArgCommand`` class. The advantage with this

way is that you will have a unified way to setup and teardown your class

through callbacks.

Arguments can be added both using a function, either prefixed ``args_`` or

added as argument to the ``@command``-decorator, -- or you can use the

``@argument``-decorator. A small sample::

    import argcmd

    class Example(argcmd.ArgCmd):

        def start(self):

            self.calls = 0

        def stop(self):

            print 'called:', self.calls

        @argcmd.argument('arg', help='arg help')

        def bar(self, args):

            self.calls += 1

            print 'arg:', args.arg

    if __name__ == '__main__':

        argcmd.main()

If this command is run via the interactive shell, the counter will increase

for each call.

See examples for more information. For information about the parser, please

see argparse.

Related

-------

If this library is not for you, don't worry. Many great projects by great

people exists with similar goals as this one.

* https://github.com/anandology/subcommand/

* https://github.com/simonw/optfunc/

* http://code.google.com/p/cmdln/