Command line

Note

The documentation in this section is aimed at people wishing to contribute to versionah, and can be skipped if you are simply using the tool from the command line.

class versionah.ValidatingAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

argparse action to validate versionah input.

versionah.guess_type(filename)

Guess output type from filename.

Parameters:filename (str) – File to operate on

versionah.bump_version(display_format, filename, file_type, shtool, bump)

Bump version in existing file.

Parameters:

• display_format (str) – Format to display output in
• filename (str) – File to operate on
• file_type (str) – File type to produce
• shtool (bool) – Write shtool compatible files
• bump (str) – Component to bump

versionah.set_version(display_format, filename, file_type, name, version_str)

Set version in new or existing file.

Parameters:

• display_format (str) – Format to display output in
• filename (str) – File to operate on
• file_type (str) – File type to produce
• name (str) – Project name used in output
• version_str (str) – Initial version string

versionah.display(display_format, filename)

Display version in existing file.

Parameters:

• display_format (str) – Format to display output in
• filename (str) – File to operate on

versionah.main(argv=sys.argv)

Main script entry point.

Examples

Guess file type from name

>>> guess_type('main.c')
'c'
>>> guess_type('version.py')
'py'
>>> guess_type('no_suffix')
'text'
>>> guess_type('suffix.unknown')
'text'