Skip to main content

image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg

Project description

https://yourlabs.io/oss/cli2/badges/master/pipeline.svg https://codecov.io/gh/yourlabs/cli2/branch/master/graph/badge.svg https://img.shields.io/pypi/v/cli2.svg

cli2: Dynamic CLI for Python 3

Expose Python functions or objects with a minimalist argument typing style, or building your own command try during runtime.

Documentation available on RTFD.

Demo

cli2 is a little library to build CLIs, which documentation is available on RTFD, but it comes with its own demo command that may as well be useful to explore Python libraries and call functions on the fly.

Because, initially, cli2 was supposed to just bring Python callables on the CLI without even a single line of code:

cli2 path.to.your.callable arg1 kwarg1=value

This command was implemented again in this 10th rewrite of the CLI engine extracted from Playlabs, however this implementation features something pretty funny: cli2 is a Group subclass which overrides the default Group implementation based on the first argument passed on the command line.

Basically, when you call cli2 path.to.module, it will load a Group of name path.to.module which whill load one Command per callable in path.to.module.

When you call cli2 path.to.function it will execute the function.

As a result, these three commands are strictly equivalent:

cli2 cli2.test_node.example_function foo=bar
cli2 cli2.test_node example_function foo=bar

That is because cli2 generates a group with every member of the previous group!

See for yourself with:

cli2 help cli2.test_node

Or just:

cli2 cli2.test_node

Because cli2.test_node is not a callable but a module, cli2’s cli2 CLI created a command Group on the fly with the module and added every callable member as command.

When you call a group on the command line, it displays help by default to drive the user.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

cli2-2.5.0.tar.gz (18.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page