Merged command-line argument parser module for Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
python2
python3
LICENSE.md
README.md

README.md

Clap

Table of contents


Definition

The Clap module is an easy-to-use command-line argument parser for Python projects.

Top

Details

Current versions of Python provide the ArgumentParser module to parse command-line arguments. However, older versions (such as Python 2.6 and below) only contain the deprecated OptionParser module.

The Clap project merges both parsers in a single module with less configuration effort, using ArgumentParser as default and OptionParser as fallback.

The current version of Clap provides a parser object which can parse arguments...

  • that expect a single user-defined value (such as a number, string or path).
  • that expect a certain value (from a predefined list of options).
  • that do not expect anything, but return a Boolean value (e. g. to set a variable to True when given).

Top

Requirements

In order to use Clap, the Python framework must be installed on the system.

Depending on which version of the framework you are using:

  • Python 2.x (version 2.7 or higher is recommended, may also work with earlier versions)
  • Python 3.x (version 3.2 or higher is recommended, may also work with earlier versions)

Top

Documentation

There is a plain text file inside the corresponding directories with further information and usage examples.

Top

Contact

Any suggestions, questions, bugs to report or feedback to give?

You can contact me by sending an email to dev@urbanware.org.

Top

Useless facts

  • The project name is an abbreviation for Command Line Agrument Parser.
  • The first version uploaded on GitHub was Clap 1.1.8 built on January 15th, 2015.
  • The module for Python 3 was created by converting the Python 2 module using the 2to3 tool. However, both files are identical except for the shebang.

Top