           __     __            _             _
 _ __  _   \ \   / /__ _ __ ___(_) ___  _ __ (_)_ __   __ _
| '_ \| | | \ \ / / _ \ '__/ __| |/ _ \| '_ \| | '_ \ / _` |
| |_) | |_| |\ V /  __/ |  \__ \ | (_) | | | | | | | | (_| |
| .__/ \__, | \_/ \___|_|  |___/_|\___/|_| |_|_|_| |_|\__, |
|_|    |___/                                          |___/

pyVersioning Documentation

The Python package pyVersioning offers a template tool to write version information for any programming language as a source file that can be included into the normal build flow.

The main idea is to provide a unified tool to collect all necessary version information from a configuration file, user defined parameters, version control systems (e.g. Git) or environment variables. Especially the latter ones can be tricky in CI environments, as every CI service uses different environment variables.

Planned features

read template from STDIN.
add C++ example
add VHDL example

Use Cases

Integrate version information from e.g. Git into current builds

Supported Version Control Systems

Git
Subversion (SVN) (planned)
more to come

Supported CI Services

Supported Languages

Any language

Tested with …

ANSI C
VHDL

Examples

ANSI C Example
VHDL Example

Contributors

Patrick Lehmann (Maintainer)
and more…

License

This Python package (source code) is licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).