Command Line Interfaces

When installed via PIP, the command line program pyVersioning is registered in the Python installation’s Scripts directory. Usually this path is listed in PATH, thus this program is globally available after installation.

The program is self-describing. Use pyVersioning without parameters or pyVersioning help to see all available common options and commands. Each command has then it’s own help page for command specific options, which can be listed by calling pyVersioning <cmd> -h or pyVersioning help <cmd>. The pyVersioning’s version and license information is shown by calling pyVersioning version.

pyVersioning

Version file generator.

usage: pyVersioning [-v] [-d] [--config-file <pyVersioning.yaml>]
                    {help,version,variables,field,fillout,json,yaml} ...

options

-v, --verbose: Print verbose messages.

-d, --debug: Print debug messages.

--config-file <<pyversioning.yaml>>: Path to pyVersioning.yaml .

pyVersioning field

usage: pyVersioning field [-h] [--project-version <Version>]
                          [--project-variant <Variant>]
                          [--project-name <Name>]
                          [--compiler-options <Options>]
                          [--compiler-config <Config>]
                          [--compiler-version <Version>]
                          [--compiler-name <Name>]
                          <Field name> [<Output file>]

<field name>: Field to return.

<output file>: Output filename.

-h, --help: show this help message and exit

--project-version <<version>>: Version of the project.

--project-variant <<variant>>: Variant of the project.

--project-name <<name>>: Name of the project.

--compiler-options <<options>>: Used compiler options.

--compiler-config <<config>>: Used compiler configuration.

--compiler-version <<version>>: Used compiler version.

--compiler-name <<name>>: Used compiler.

pyVersioning fillout

usage: pyVersioning fillout [-h] [--project-version <Version>]
                            [--project-variant <Variant>]
                            [--project-name <Name>]
                            [--compiler-options <Options>]
                            [--compiler-config <Config>]
                            [--compiler-version <Version>]
                            [--compiler-name <Name>]
                            <Template file> [<Output file>]

<template file>: Template input filename.

<output file>: Output filename.

-h, --help: show this help message and exit

--project-version <<version>>: Version of the project.

--project-variant <<variant>>: Variant of the project.

--project-name <<name>>: Name of the project.

--compiler-options <<options>>: Used compiler options.

--compiler-config <<config>>: Used compiler configuration.

--compiler-version <<version>>: Used compiler version.

--compiler-name <<name>>: Used compiler.

pyVersioning help

usage: pyVersioning help [-h] [Command]

command: Print help page(s) for a command.

-h, --help: show this help message and exit

pyVersioning json

usage: pyVersioning json [-h] [--project-version <Version>]
                         [--project-variant <Variant>] [--project-name <Name>]
                         [--compiler-options <Options>]
                         [--compiler-config <Config>]
                         [--compiler-version <Version>]
                         [--compiler-name <Name>]
                         [<Output file>]

<output file>: Output filename.

-h, --help: show this help message and exit

--project-version <<version>>: Version of the project.

--project-variant <<variant>>: Variant of the project.

--project-name <<name>>: Name of the project.

--compiler-options <<options>>: Used compiler options.

--compiler-config <<config>>: Used compiler configuration.

--compiler-version <<version>>: Used compiler version.

--compiler-name <<name>>: Used compiler.

pyVersioning variables

usage: pyVersioning variables [-h] [--project-version <Version>]
                              [--project-variant <Variant>]
                              [--project-name <Name>]
                              [--compiler-options <Options>]
                              [--compiler-config <Config>]
                              [--compiler-version <Version>]
                              [--compiler-name <Name>]

-h, --help: show this help message and exit

--project-version <<version>>: Version of the project.

--project-variant <<variant>>: Variant of the project.

--project-name <<name>>: Name of the project.

--compiler-options <<options>>: Used compiler options.

--compiler-config <<config>>: Used compiler configuration.

--compiler-version <<version>>: Used compiler version.

--compiler-name <<name>>: Used compiler.

pyVersioning version

Display version information.

usage: pyVersioning version [-h]

-h, --help: show this help message and exit

pyVersioning yaml

usage: pyVersioning yaml [-h] [--project-version <Version>]
                         [--project-variant <Variant>] [--project-name <Name>]
                         [--compiler-options <Options>]
                         [--compiler-config <Config>]
                         [--compiler-version <Version>]
                         [--compiler-name <Name>]
                         [<Output file>]

<output file>: Output filename.

-h, --help: show this help message and exit

--project-version <<version>>: Version of the project.

--project-variant <<variant>>: Variant of the project.

--project-name <<name>>: Name of the project.

--compiler-options <<options>>: Used compiler options.

--compiler-config <<config>>: Used compiler configuration.

--compiler-version <<version>>: Used compiler version.

--compiler-name <<name>>: Used compiler.