query yes/no (Python)

2010-03-09T17:57:28-08:00

Python recipe 577058 by Trent Mick (ask, cli, no, query, raw_input, yes). Revision 2.

Ask the user a question using raw_input() and looking something like this:

QUESTION [Y/n] 
...validate...

See also: Recipe 577096 (query custom answers), Recipe 577097 (query yes/no/quit), Recipe 577098 (query long), Recipe 577099 (query)

transform command line arguments to args and kwargs for a method call (Python)

2010-03-21T22:41:42-07:00

Python recipe 577122 by Trent Mick (argv, cli, json). Revision 2.

For many of my Python modules I find it convenient to provide a small if __name__ == "__main__": ... block to be able to call individual methods from the command line. This requires some kind of translation of command-line string arguments to args and kwargs for the method call. This recipe uses a few conventions to do that:

the first argument is the method name
positional args are positional (duh)
"key=value" is a keyword argument
an attempt is made to interpret arguments as JSON to allow specifying types other than string

Unix tee-like functionality via a Python class (Python)

2017-03-31T14:30:30-07:00

Python recipe 580767 by Vasudev Ram (cli, command, commandline, linux, python, tee, unix, utilities, windows).

The Unix tee commmand, when used in a command pipeline, allows you to capture the output of the preceding command to a file or files, while still sending it on to standard output (stdout) for further processing via other commands in a pipeline, or to print it, etc.

This recipe shows how to implement simple tee-like functionality via a Python class. I do not aim to exactly replicate the functionality of the Unix tee, only something similar.

More details and sample output here:

https://jugad2.blogspot.in/2017/03/a-python-class-like-unix-tee-command.html

Send Email (Python)

2012-08-26T11:23:54-07:00

Python recipe 576807 by sfwgeek (argparse, cli, command, email, interface, line, mail, python, send, smtplib). Revision 5.

A Command Line Interface (CLI) program to send email.

Progress bar class (Python)

2012-08-09T17:39:10-07:00

Python recipe 578228 by Xavier L. (class, cli, curses, files, module, progress). Revision 5.

See gist:3306295 for future developments.

Here is a little class that lets you present percent complete information in the form of a progress bar using the '=' character to represent completed portions, spaces to represent incomplete portions, '>' to represent the current portion and the actual percent done (rounded to integer) displayed at the end:

[===========> ] 60%

When you initialize the class, you specify the minimum number (defaults to 0), the maximum number (defaults to 100), and the desired width of the progress bar. The brackets [] are included in the size of the progress bar, but you must allow for up to 4 characters extra to display the percentage.

You'd probably want to use this in conjuction with the curses module, or something like that so you can over-write the same portion of the screen to make your updates 'animated'.

query yes/no/quit (Python)

2010-03-09T17:57:18-08:00

Python recipe 577097 by Trent Mick (ask, cli, no, query, quit, raw_input, yes).

Ask the user a question using raw_input() and looking something like this:

QUESTION [Y/n/q] 
...validate...

See also: Recipe 577058 (query yes/no), Recipe 577096 (query custom answers), Recipe 577098 (query long), Recipe 577099 (query)

Give Python code a web plus command-line interface with hug (Python)

2017-01-05T16:57:15-08:00

Python recipe 580742 by Vasudev Ram (cli, commandline, hug, library, python, python3, user_interface, web, web_server).

This recipe shows how to take a Python function and wrap it with both a web and a command-line interface, somewhat easily, using the hug Python library. The example used shows how to wrap a function that uses the psutil library to get information on disk partitions. So you can see the disk partition info either via the web browser or the command line. The code for the recipe is shown below. It is also possible to wrap multiple functions in the same Python file, and expose all of them via both the web and the command-line.

More information and multiple sample outputs are available here:

https://jugad2.blogspot.in/2017/01/give-your-python-function-webcli-hug.html

Automated management of CLI devices (Python)

2009-05-27T01:24:12-07:00

Python recipe 576778 by Alan Holt (cli, management, ssh, telnet, tunnel).

This recipe provides a mechanism for remote, automated control of a network device via its command-line interface (CLI). It assumes that the CLI is accessed using Telnet. Furthermore, the device cannot be accessed directly, instead the user has to SSH to an intermediate jump host before Telneting to the device.

file path generator from path patterns (Python)

2010-07-09T19:10:59-07:00

Python recipe 577230 by Trent Mick (cli, files, path, paths, walk). Revision 4.

Provides a _paths_from_path_patterns that will generate a list of paths from a list of path patterns. A "path pattern" can include glob chars. By default it generates a recursive listing of file paths, but: recursion can be turned off, file and/or dir paths can be listed. It supports a list of glob exclusions or inclusions.

This function makes it easy to implement typical "-r|--recursive" and "-x|--exclude" options for command-line scripts that work on given file paths. See example usages below.

Note: I use a leading _ on function names because my typical usage of my recipes is as re-usable internal functions in Python modules.

command line query (Python)

2010-03-09T18:37:52-08:00

Python recipe 577098 by Trent Mick (ask, cli, query, raw_input). Revision 3.

Ask the user a question using raw_input() and looking something like this (style=="compact"):

QUESTION [DEFAULT]: _
...validation...

or this (style=="verbose"):

QUESTION
Hit <Enter> to use the default, DEFAULT.
> _
...validate...

It supports some basic validation/normalization of the given answer.

See also: Recipe 577058 (query yes/no), Recipe 577097 (query yes/no/quit), Recipe 577096 (query custom answers)

query (Python)

2010-03-09T18:34:05-08:00

Python recipe 577099 by Trent Mick (ask, cli, query, raw_input).

Ask/prompt the user for a short piece of data. Recipe 577098 is a much more generic/functional (but longer) take on this.

query custom answers (Python)

2010-03-09T17:57:22-08:00

Python recipe 577096 by Trent Mick (cli, query).

Ask the user a question using raw_input() and looking something like this:

Frob nots the zids? [Yes (default), No, quit] _
...validate...

See also: Recipe 577058 (query yes/no), Recipe 577097 (query yes/no/quit), Recipe 577098 (query long), Recipe 577099 (query)

Generate automatically list of actions with argparse (Python)

2011-12-02T10:25:13-08:00

Python recipe 577947 by Andrea Crotti (argparse, cli). Revision 2.

This little sample script looks up in locals() to determine all the callables in main.

Then it passes them to parse_arguments, which show an help message as following usage:

prova.py [-h] {func2,func1}

positional arguments:
  {func2,func1}

optional arguments:
  -h, --help     show this help message and exit

Useful to avoid duplication and make it easy to extend script functions.

Most viewed recipes tagged "cli"

query yes/no (Python)

transform command line arguments to args and kwargs for a method call (Python)

Unix tee-like functionality via a Python class (Python)

Send Email (Python)

Progress bar class (Python)

query yes/no/quit (Python)

Give Python code a web plus command-line interface with hug (Python)

Automated management of CLI devices (Python)

file path generator from path patterns (Python)

command line query (Python)

query (Python)

query custom answers (Python)

Generate automatically list of actions with argparse (Python)