GitHub - Doula/egggitinfo: Plants some git-related data into the .egg-info directory of a python package.

Doula / egggitinfo Public

Notifications You must be signed in to change notification settings
Fork 0
Star 1

Plants some git-related data into the .egg-info directory of a python package.

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.rst		README.rst
egggitinfo.py		egggitinfo.py
setup.py		setup.py

Repository files navigation

================
egggitinfo README
=================

Overview
========
This is a setuptools plugin that plants some git-related information into the .egg-info directory of a python package.  To setuptools this information is refered to as 'metadata'.  It is located in a file called 'git_info.txt', and can be retrieved using the from a Distribution object by calling the `get_metadata(name)` method.  The 'git_info.txt' file stores the following information in JSON format.

git_branch
----------
Stores the name of the active git branch.

git_remotes
-----------
Stores a JSON object of git remotes, where the key is the name of the remote and the value is the url.