Skip to main content

unfrustrating python CLI

Project description

Sometimes I just want to execute a python callback and pass args/kwargs on the CLI, and not have to define any custom CLI entry point of any sort, nor change any code, typically when automating stuff, cli2 unfrustrates me:

cli2 yourmodule.yourcallback somearg somekwarg=foo

Sometimes I just want to define a new command and expose all callables in a module and I can’t just do it with a one-liner. cli2 unfrustrates me again:

console_script = cli2.ConsoleScript(__doc__).add_module('mymodule')
# then i add console_script entrypoint as such: mycmd = mycmd.console_script

I also like when readonly commands are in green, writing commands in yellow and destructive commands in red, I find the commands list in the help output more readable, and directive for new users of the CLI:

@cli2.config(color=cli2.RED)
def challenge(dir):
   '''The challenge command dares you to run it.'''
   os.exec('rm -rf ' + dir)

Of course then there’s all this code I need to have coverage for and I’m still so lazy that I still don’t write most of my test code myself, so I throwed an autotest function in cli2 (“ala” dbunit with a personal touch) that I can use as such:

@pytest.mark.parametrize('name,command', [
    ('cli2', ''),
    ('help', 'help'),
    ('help_debug', 'help debug'),
    # ... bunch of other commands
    ('debug', 'debug cli2.run to see=how -it --parses=me'),
])
def test_cli2(name, command):
    cli2.autotest(
        f'tests/{name}.txt',
        'cli2 ' + command,
    )

You should be able tho pip install cli2 and start using the cli2 command, or cli2.ConsoleScript to make your own commands.

https://asciinema.org/a/221137.svg

Check djcli, another cli built on cli2.

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-1.1.9.dev2.tar.gz (12.1 kB view details)

Uploaded Source

File details

Details for the file cli2-1.1.9.dev2.tar.gz.

File metadata

  • Download URL: cli2-1.1.9.dev2.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for cli2-1.1.9.dev2.tar.gz
Algorithm Hash digest
SHA256 54a4c9fd194c4e70a1a9c5c033bdfe0901af96c8751ac33008e0a0f6cf2fa76a
MD5 675d40571330aa27cc64517c013e3971
BLAKE2b-256 ec679e0ddc73c646272c6c7e7740940214b851385d9aa352d27416400fb0fa81

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