Skip to main content

A command-line parser library

Project description

Commandeer is a command-line generator library that you can use to add a nice command line interface to your python programs.

It will take care of parsing all command line options as well as calling the right command functions in your script. And it will generate a nice-looking help for the program and for each of the commands.

We've written Commandeer in such a way that it should work just like you expect it to. There are only two things you need to do:

  • name the functions you want to expose on the command line to end in _command.

  • Add the following code snippet to the end of your command line module::

    import commandeer
    if __name__ == '__main__':
        commandeer.cli()
    

You should try it out!

For more information, consult the documentation on https://gitlab.com/jspielmann/commandeer/

License information

Copyright (C) 2012, 2021 Johannes Spielmann

Commandeer is licensed under the terms of the GNU General Public Licenses as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

For a full description of the license, please see the file

LICENSE

Project details


Download files

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

Source Distribution

commandeer-0.3.1.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

commandeer-0.3.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file commandeer-0.3.1.tar.gz.

File metadata

  • Download URL: commandeer-0.3.1.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.4 Linux/5.4.0-125-generic

File hashes

Hashes for commandeer-0.3.1.tar.gz
Algorithm Hash digest
SHA256 57a4cc6075365abda7287cc76e12268a353cb7faadf589c584bca18bf78442e2
MD5 908b70e41b48f5ff4add26fdbef0a123
BLAKE2b-256 9643a54cf84cbb14eb4d755ca2f5e946edd5016a9061cf45c7bd27650625197f

See more details on using hashes here.

File details

Details for the file commandeer-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: commandeer-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.4 Linux/5.4.0-125-generic

File hashes

Hashes for commandeer-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 590f919e2320d2d011f62010100eaca0171ead7004d2c7dcc53ba1027b42763d
MD5 4181cd2cddbc87c24bb925ea0649d989
BLAKE2b-256 f104343b9898ba49d3f841a69490ac0055e1f9e48dafe8c2db46f2057fd6ca1b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page