pyvoa.help

The command-line help of pyvoa.

Prints the reference of the listing and charting methods, with their main options and a few worked examples. Reachable as python -m pyvoa.help, and from a session through front.help().

Project : pyvoa Authors : Tristan Beau, Julien Browaeys, Olivier Dadoun Copyright ©pyvoa_org License : see the joint LICENSE file https://pyvoa.org/

pyvoa.help.display_full_help()

Print the full pyvoa command reference to the terminal.

Writes a colourised summary of the listing methods, the four chart methods and their main options, followed by a handful of worked examples. Called by main() for the -h/–help switch.

pyvoa.help.main()

Entry point of the command-line help.

Parses the -h/–help, -v/–version, -a/–author, -g/–github and -w/–web switches and prints what each of them asks for. With no argument, or with –help, the argparse usage is printed, and –help adds the full reference from display_full_help().