git-app-version

CLI tool to get Git commit informations and store them in a config file

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Project description

https://badge.fury.io/py/git-app-version.svg

https://travis-ci.org/csanquer/git-app-version.svg?branch=master

https://scrutinizer-ci.com/g/csanquer/git-app-version/badges/quality-score.png?b=master

https://scrutinizer-ci.com/g/csanquer/git-app-version/badges/coverage.png?b=master

A CLI tool written in Python to fetch Git commit informations and store them in an INI/XML/YAML/JSON file.

Typical usecase : when deploying, run this command and import the git version config file.

Requirements

Python 2.7 or >= 3.3
python pip package tool

Installation

Just run

pip install git-app-version

Usage

Help

To get help

git-app-version -h

Help result

usage: git-app-version [-h] [-V] [-v] [-q] [-o path] [-f format]
                       [-n namespace]
                       [path] [commit]

Get Git commit informations and store them in a INI/XML/YAML/JSON file.

positional arguments:
  path                  git repository path. Default is the current directory.
  commit                git commit to check. Default is HEAD.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         display tool version
  -v, --verbose         increase verbosity : use -v or -vv
  -q, --quiet           silent mode
  -o path, --output path
                        output file path (without extension). Default is
                        '<repository-path>/version'.
  -f format, --format format
                        output file format and extension (ini/xml/yml/json).
                        Default is json.
  -n namespace, --namespace namespace
                        namespace like notation in version file, use dot
                        separator to segment namespaces e.g.: 'foo.bar.git'.
                        Default is 'app_version' for XML and INI and no
                        namespace for JSON and YAML.

Get Commit Informations

To store git commit informations into a json file

# git-app-version -o <output-file-without-extension> -f <file-format> <my-git-repository>

git-app-version -o version -f json

This will generate a version.json file in the current directory (if this directory is a git repository).

Commit informations

full_commit : Git SHA1 commit hash,

e.g.: 40aaf83894b98898895d478f8b7cc4a866b1d62c
abbrev_commit : Git SHA1 commit hash abbrev notation (x significant first characters),

e.g.: 40aaf83
version : result of the command git describe --tags --always, see git-describe, if no version is found, the abbrev commit will be used per default

e.g.: v1.1.0-3-g439e52
commit_date : Git commit date in iso8601 format,

e.g.: 2016-03-01T09:33:33+0000
commit_timestamp : Git commit date in timestamp format,

e.g.: 1456824813
author_date : Git author date in iso8601 format,

e.g.: 2016-03-02T11:33:45+0000
author_timestamp : Git author date in timestamp format,

e.g.: 1456918425
deploy_date : current date (when running the tool) in iso8601 format,

e.g.: 2016-03-02T11:33:45+0000
deploy_timestamp : current date (when running the tool) in timestamp format,

e.g.: 1456918425
branches : branches which the commit belongs,

e.g.: [‘master’, ‘develop’]
top_branches : branches where the commit is the HEAD commit,

e.g.: [‘master’]
branches : branches which the commit belongs,

e.g.: [‘master’, ‘develop’]
committer_name : Git committer name,

e.g.: Paul Durand
committer_email : Git committer email,

e.g.: paul.durand@example.com
author_name : Git author name,

e.g.: Paul Durand
author_email : Git author email,

e.g.: paul.durand@example.com

File formats

json

without namespace

git-app-version -f json

result

{
  "version": "v1.1.0-3-g439e52",
  "full_commit": "40aaf83894b98898895d478f8b7cc4a866b1d62c",
  "abbrev_commit": "40aaf83",
  "branches": [
    "develop",
    "master"
  ],
  "top_branches": [
    "master"
  ],
  "committer_email": "paul.durand@example.com",
  "committer_name": "Paul Durand",
  "author_name": "Paul Durand",
  "author_email": "paul.durand@example.com",
  "commit_date": "2015-09-05T16:14:16+0000",
  "commit_timestamp": "1441469656",
  "author_date": "2015-09-05T16:14:16+0000",
  "author_timestamp": "1441469656",
  "deploy_date": "2016-06-21T09:33:01+0000",
  "deploy_timestamp": "1466501581"
}

with namespace

git-app-version -f json -n git.infos

result

{
  "git": {
    "infos": {
      "version": "v1.1.0-3-g439e52",
      "full_commit": "40aaf83894b98898895d478f8b7cc4a866b1d62c",
      "abbrev_commit": "40aaf83",
      "branches": [
        "develop",
        "master"
      ],
      "top_branches": [
        "master"
      ],
      "committer_email": "paul.durand@example.com",
      "committer_name": "Paul Durand",
      "author_name": "Paul Durand",
      "author_email": "paul.durand@example.com",
      "commit_date": "2015-09-05T16:14:16+0000",
      "commit_timestamp": "1441469656",
      "author_date": "2015-09-05T16:14:16+0000",
      "author_timestamp": "1441469656",
      "deploy_date": "2016-06-21T09:33:01+0000",
      "deploy_timestamp": "1466501581"
    }
  }
}

yml

without namespace

git-app-version -f yml

result

---
'version': 'v1.1.0-3-g439e52'
'full_commit': '40aaf83894b98898895d478f8b7cc4a866b1d62c'
'abbrev_commit': '40aaf83'
'committer_name': 'Paul Durand'
'committer_email': 'paul.durand@example.com'
'author_name': 'Paul Durand'
'author_email': 'paul.durand@example.com'
'commit_date': '2015-09-05T16:14:16+0000'
'commit_timestamp': '1441469656'
'author_date': '2015-09-05T16:14:16+0000'
'author_timestamp': '1441469656'
'deploy_date': '2016-06-21T09:32:57+0000'
'deploy_timestamp': '1466501577'
'branches':
- 'develop'
- 'master'
'top_branches':
- 'master'

with namespace

git-app-version -f yml -n git.infos

result

---
'git':
  'infos':
    'version': 'v1.1.0-3-g439e52'
    'full_commit': '40aaf83894b98898895d478f8b7cc4a866b1d62c'
    'abbrev_commit': '40aaf83'
    'committer_name': 'Paul Durand'
    'committer_email': 'paul.durand@example.com'
    'author_name': 'Paul Durand'
    'author_email': 'paul.durand@example.com'
    'commit_date': '2015-09-05T16:14:16+0000'
    'commit_timestamp': '1441469656'
    'author_date': '2015-09-05T16:14:16+0000'
    'author_timestamp': '1441469656'
    'deploy_date': '2016-06-21T09:32:57+0000'
    'deploy_timestamp': '1466501577'
    'branches':
    - 'develop'
    - 'master'
    'top_branches':
    - 'master'

xml

with default namespace

git-app-version -f xml

result

<?xml version='1.0' encoding='UTF-8'?>
<app_version>
  <version>v1.1.0-3-g439e52</version>
  <full_commit>40aaf83894b98898895d478f8b7cc4a866b1d62c</full_commit>
  <abbrev_commit>40aaf83</abbrev_commit>
  <commit_date>2015-09-05T16:14:16+0000</commit_date>
  <commit_timestamp>1441469656</commit_timestamp>
  <author_date>2015-09-05T16:14:16+0000</author_date>
  <author_timestamp>1441469656</author_timestamp>
  <deploy_date>2016-06-21T09:32:53+0000</deploy_date>
  <deploy_timestamp>1466501573</deploy_timestamp>
  <committer_name>Paul Durand</committer_name>
  <committer_email>paul.durand@example.com</committer_email>
  <author_name>Paul Durand</author_name>
  <author_email>paul.durand@example.com</author_email>
  <branches>develop</branches>
  <branches>master</branches>
  <top_branches>master</top_branches>
</app_version>

with namespace

git-app-version -f xml -n git.infos

result

<?xml version='1.0' encoding='UTF-8'?>
<git>
  <infos>
    <version>v1.1.0-3-g439e52</version>
    <full_commit>40aaf83894b98898895d478f8b7cc4a866b1d62c</full_commit>
    <abbrev_commit>40aaf83</abbrev_commit>
    <commit_date>2015-09-05T16:14:16+0000</commit_date>
    <commit_timestamp>1441469656</commit_timestamp>
    <author_date>2015-09-05T16:14:16+0000</author_date>
    <author_timestamp>1441469656</author_timestamp>
    <deploy_date>2016-06-21T09:32:53+0000</deploy_date>
    <deploy_timestamp>1466501573</deploy_timestamp>
    <committer_name>Paul Durand</committer_name>
    <committer_email>paul.durand@example.com</committer_email>
    <author_name>Paul Durand</author_name>
    <author_email>paul.durand@example.com</author_email>
    <branches>develop</branches>
    <branches>master</branches>
    <top_branches>master</top_branches>
  </infos>
</git>

ini

with default namespace

git-app-version -f ini

result

[app_version]
version = v1.1.0-3-g439e52
full_commit = 40aaf83894b98898895d478f8b7cc4a866b1d62c
abbrev_commit = 40aaf83
commit_date = 2016-03-01T09:33:33+0000
commit_timestamp = 1456824813
author_date = 2016-03-01T09:33:33+0000
author_timestamp = 1456824813
deploy_date = 2016-03-02T11:33:45+0000
deploy_timestamp = 1456918425
author_name = Paul Durand
author_email = paul.durand@example.com
committer_name = Paul Durand
committer_email = paul.durand@example.com
top_branches = ['master']
branches = ['master','develop']

with namespace

git-app-version -f ini -n git.infos

result

[git.infos]
version = v1.1.0-3-g439e52
full_commit = 40aaf83894b98898895d478f8b7cc4a866b1d62c
abbrev_commit = 40aaf83
commit_date = 2016-03-01T09:33:33+0000
commit_timestamp = 1456824813
author_date = 2016-03-01T09:33:33+0000
author_timestamp = 1456824813
deploy_date = 2016-03-02T11:33:45+0000
deploy_timestamp = 1456918425
author_name = Paul Durand
author_email = paul.durand@example.com
committer_name = Paul Durand
committer_email = paul.durand@example.com
top_branches = ['master']
branches = ['master','develop']

Licensing

Project under GPL v3 License

Project details

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Release history Release notifications | RSS feed

1.0.2

Nov 27, 2018

1.0.1

Nov 27, 2018

1.0.0

May 21, 2017

1.0.0b4 pre-release

May 21, 2017

1.0.0b3 pre-release

Feb 13, 2017

1.0.0b2 pre-release

Feb 12, 2017

1.0.0b1 pre-release

Feb 9, 2017

0.7.1

Feb 8, 2017

0.7.0

Feb 6, 2017

0.6.0

Feb 3, 2017

This version

0.5.1

Jun 23, 2016

0.5.0

Jun 21, 2016

0.4.0

Apr 11, 2016

0.3.1

Mar 21, 2016

0.3.0

Mar 21, 2016

0.2.1

Mar 20, 2016

0.2.0

Mar 20, 2016

0.1.2

Jan 4, 2016

0.1.0

Mar 20, 2016

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-app-version-0.5.1.tar.gz (10.5 kB view hashes)

Uploaded Jun 23, 2016 Source

Built Distribution

git_app_version-0.5.1-py2.py3-none-any.whl (13.0 kB view hashes)

Uploaded Jun 23, 2016 Python 2 Python 3

Hashes for git-app-version-0.5.1.tar.gz

Hashes for git-app-version-0.5.1.tar.gz
Algorithm	Hash digest
SHA256	`afde51b7ee00e99a11055c75cf3061d761489fd67cf894ac363c0a3b8fc32772`
MD5	`74d5e483de400a8fb570c6f5ec27195b`
BLAKE2b-256	`e1c0f649910efb9eb3eaa2ac066d2805d262d4a7aaa3a38f9b857efbf675e274`

Hashes for git_app_version-0.5.1-py2.py3-none-any.whl

Hashes for git_app_version-0.5.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`617f72587cc1d8289e0407a1733ccb4c6a18ad7e6a01c5572498ae6268c06649`
MD5	`62fd7b1335764d06e03408ffb5bbe3c8`
BLAKE2b-256	`941552c768cd2bdfacf6f86db019670572db807fdadcce6bec259993afb30b86`