katversion 0.9

版本字符串格式

katversion为您的scm包生成一个版本字符串 符合PEP 440。 它主要支持git存储库，并半心半意地尝试svn支持。

我们版本字符串的格式是：

- for RELEASE builds:
    <major>.<minor>
    e.g.
    0.1
    2.4

- for DEVELOPMENT builds:
    <major>.<minor>.dev<num_commits>+<branch_name>.g<short_git_sha>[.dirty]
    e.g.
    0.2.dev34+new.shiny.feature.gfa973da
    2.5.dev7+master.gb91ffa6.dirty

- for UNKNOWN builds:
    0.0+unknown.[<scm_type>.]<timestamp>
    e.g.
    0.0+unknown.svn.201402031023
    0.0+unknown.201602081715

where <major>.<minor> is derived from the latest version tag and
<num_commits> is the total number of commits on the development branch.

The <major>.<minor> substring for development builds will be that of the
NEXT (minor) release, in order to allow proper Python version ordering.

To add a version tag use the `git tag` command, e.g.

    $ git tag -a 1.2 -m 'Release version 1.2'

典型用法

将此添加到setup.py（处理已安装的软件包）：

fromsetuptoolsimportsetupsetup(...,setup_requires=['katversion'],use_katversion=True,...)

将此添加到mypackage/__init__.py，包括注释行 （处理本地包）：

# BEGIN VERSION CHECK# Get package version when locally imported from repo or via -e develop installtry:importkatversionas_katversionexceptImportError:# pragma: no coverimporttimeas_time__version__="0.0+unknown.{}".format(_time.strftime('%Y%m%d%H%M'))else:# pragma: no cover__version__=_katversion.get_version(__path__[0])# END VERSION CHECK

此外，还有一个用于检查版本的命令行脚本：

# From inside your SCM subdirectory, run the following command
# which will print the result to stdout:
$ kat-get-version.py