PyCLI2

Python library to auto parse command line args from function typing.

Overview

This package simplfies the creation of CLI apps, by analysing the typing of python functions and parsing command line arguments.

Installation

The python package, both wheel and source distribution is available at PyPI pycli2 project. Install using your python package manager of choice. E.g. pip or uv.

uv pip install pycli2

Usage

The package comes with a demo CLI, which the source can be view at src/pycli2/__main__.py. It can be accessed by running

python -m pycli --help

In order to make your own CLI, simply import pycli2 and use the pycli2.run function. Provide it with functions, and it'll automatically create a CLI app from the function typing and function docstring.

import pycli2

if __name__ == "__main__":
    # This will expose firstfunc, secondfunc, and thirdfunc to the CLI.
    pycli2.run(
        firstfunc,
        secondfunc,
        thirdfunc,
    )

Contributing

...

Install locally

Install in edit mode, with dev dependendencies using your python package manager of choice. E.g. pip or uv.

uv pip install -e .[dev]

Build

Build a distribution by setting the PYTHON_PACKAGE environment variable to the version and run

uv build

The documentation can also be built using the Sphinx.

sphinx-build -M html docs/ dist/

License

This project is licensed under the GNU General Public License v3.0 only.