Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introducing version.py and using it in setup.py to get the python
package version number from `git describe`, so we can have officially tagged versions, and releases distinguished by commit hash. Also introducing Makefile, which helps regiment some of these setup.py commands, and will facilitate auto testing.
- Loading branch information
John R. Frank
committed
Aug 19, 2013
1 parent
6452593
commit 06322c1
Showing
4 changed files
with
136 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
include RELEASE-VERSION | ||
include version.py | ||
include README.md | ||
include run_tests.sh | ||
include settings.py | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
|
||
clean: | ||
rm -rf build dist src/*.egg-info/ | ||
|
||
.PHONY : build | ||
build: clean | ||
python setup.py build | ||
|
||
build_eggs: build | ||
python setup.py bdist_egg | ||
|
||
build_packages: build_eggs | ||
python setup.py bdist_rpm | ||
|
||
install: build | ||
python setup.py clean --all | ||
python setup.py install | ||
|
||
test: | ||
python runtests.py src | ||
|
||
register: | ||
python setup.py sdist bdist_egg upload -r pypi | ||
|
||
check: | ||
pylint -i y --output-format=parseable src/`git remote -v | grep origin | head -1 | cut -d':' -f 2 | cut -d'.' -f 1` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# -*- coding: utf-8 -*- | ||
# Author: Douglas Creager <dcreager@dcreager.net> | ||
# This file is placed into the public domain. | ||
|
||
# Calculates the current version number. If possible, this is the | ||
# output of “git describe”, modified to conform to the versioning | ||
# scheme that setuptools uses. If “git describe” returns an error | ||
# (most likely because we're in an unpacked copy of a release tarball, | ||
# rather than in a git working copy), then we fall back on reading the | ||
# contents of the RELEASE-VERSION file. | ||
# | ||
# To use this script, simply import it your setup.py file, and use the | ||
# results of get_git_version() as your package version: | ||
# | ||
# from version import * | ||
# | ||
# setup( | ||
# version=get_git_version(), | ||
# . | ||
# . | ||
# . | ||
# ) | ||
# | ||
# This will automatically update the RELEASE-VERSION file, if | ||
# necessary. Note that the RELEASE-VERSION file should *not* be | ||
# checked into git; please add it to your top-level .gitignore file. | ||
# | ||
# You'll probably want to distribute the RELEASE-VERSION file in your | ||
# sdist tarballs; to do this, just create a MANIFEST.in file that | ||
# contains the following line: | ||
# | ||
# include RELEASE-VERSION | ||
|
||
__all__ = ("get_git_version") | ||
|
||
from subprocess import Popen, PIPE | ||
|
||
|
||
def call_git_describe(abbrev=4): | ||
try: | ||
p = Popen(['git', 'describe', '--abbrev=%d' % abbrev], | ||
stdout=PIPE, stderr=PIPE) | ||
p.stderr.close() | ||
line = p.stdout.readlines()[0] | ||
return line.strip() | ||
|
||
except: | ||
return None | ||
|
||
|
||
def read_release_version(): | ||
try: | ||
f = open("RELEASE-VERSION", "r") | ||
|
||
try: | ||
version = f.readlines()[0] | ||
return version.strip() | ||
|
||
finally: | ||
f.close() | ||
|
||
except: | ||
return None | ||
|
||
|
||
def write_release_version(version): | ||
f = open("RELEASE-VERSION", "w") | ||
f.write("%s\n" % version) | ||
f.close() | ||
|
||
|
||
def get_git_version(abbrev=4): | ||
# Read in the version that's currently in RELEASE-VERSION. | ||
|
||
release_version = read_release_version() | ||
|
||
# First try to get the current version using “git describe”. | ||
|
||
version = call_git_describe(abbrev) | ||
|
||
# If that doesn't work, fall back on the value that's in | ||
# RELEASE-VERSION. | ||
|
||
if version is None: | ||
version = release_version | ||
|
||
# If we still don't have anything, that's an error. | ||
|
||
if version is None: | ||
# raise ValueError("Cannot find the version number!") | ||
version = '0.1.0' | ||
|
||
# If the current version is different from what's in the | ||
# RELEASE-VERSION file, update the file to be current. | ||
|
||
if version != release_version: | ||
write_release_version(version) | ||
|
||
# Finally, return the current version. | ||
|
||
return version | ||
|
||
|
||
if __name__ == "__main__": | ||
print get_git_version() |