Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cli2

Package Overview
Dependencies
Maintainers
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cli2

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

  • 3.0.1
  • PyPI
  • Socket score

Maintainers
2

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

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
<https://cli2.rtfd.io>`_.

Demo
====

cli2 is a little library to build CLIs, which documentation is `available on
RTFD <https://cli2.readthedocs.io/en/latest/>`_, 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.

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc