polyversion 0.0.2a8

Lib code deriving subproject versions from tags on git monorepos.

Version:

0.0.2a8

updated:

2018-05-24T00:50:38.794096

Documentation:

file:///D:/Work/polyvers.git/build/sphinx/html/usage.html#usage-of-polyversion-library

repository:

https://github.com/JRCSTU/polyvers

pypi-repo:

https://pypi.org/project/polyversion/

Copyright:

2018 JRC.C4(STU), European Commission (JRC)

license:

MIT License

The python 2.7+ library needed by (sub-)projects managed by polyvers cmd to derive their version-ids on runtime from Git.

Quickstart

There are 3 ways to use this library:

• through its Python-API (to dynamically version your project);

• through its barebone cmdline tool: polyversion (installation required);

• through the standalone executable wheel: pvlib/bin/pvlib.whl (no installation, but sources required; behaves identically to polyversion command).

Note

Only this library is (permissive) MIT-licensed, so it can be freely used by any program - the respective polyvers command-line tool is “copylefted” under EUPLv1.2.

API usage

currentmodule: polyversion

An API sample of using func(polyversion.polyversion()) in a myproject.git/setup.py file:

...
setup(
    name='myproject',
    version=polyversion('myproject')
    ...
)

An API sample of using also func(polytime()) in a myproject.git/myproject/__init__.py file:

...
__version__ = polyversion()  # project assumed equal to module-name 'myproject'
__updated__ = polytime()
...

Tip

Depending on your repo’s versioning scheme (eg you have a mono-project repo, with version-tags simply like vX.Y.Z), you must add in both invocations of func(polyversion.polyversion()) above the kw-arg mono_project=True.

Console usage

A sample of command-line usage is given below:

user@host:~/ $ polyversion --help
Describe the version of a *polyvers* projects from git tags.

USAGE:
    polyversion [PROJ-1] ...

user@host:~/ $ polyversion polyversion
polyversion: 0.0.2a7+37.g0707a09
polyvers: 0.0.2a9.post0+7.g0707a09

user@host:~/polyvers.git (dev) $ polyversion --help
Describe the version of a *polyvers* projects from git tags.

USAGE:
    polyversion [PROJ-1] ...

A sample of the standalone wheel:

user@host:~/ $ cd ~/polyvers.git
user@host:~/polyvers.git (master) $ polyversion polyversion
polyversion: 0.0.2a7+37.g0707a09

For the rest, consult the polyvers project: https://polyvers.readthedocs.io