README

pychangelog is a python package which provides some simple utilities for parsing and testing change logs, based on a simple standard format which is not really documented anywhere. But you can look at the changelog for this project to get an idea (in CHANGES.txt in the root of the source distribution).

Page Contents

tl;dr

What?

Parses changelogs.

Install?

$ pip install pychangelog

Or, from source:

$ python setup.py install

Examples?

Example changelog (in ‘CHANGES.txt’):

Pre Rel 4
    [M] Remove the doo_little function.
    [n] Add optional argument to frobnicate.
    [p] More bug fixes.

Rel 3   - v1.1.0.0 - 2013-05-20
    [p] Bug fix in doo_little()
    [n] Added the frobnicate function in order to frob objects
        more easily.
    [s] Fixed up docs on doo_little.
    [p] Bug fix in some private functions

Rel 2   - v1.0.0.1 - 2013-05-18
    [s] Documentation improvements.

Rel 1   - v1.0.0.0 - 2013-05-15
    * Initial public release.
    * Provides the doo_little() function, and little else.

>>> import pychangelog
>>> with open('CHANGES.txt', 'r') as f:
...     changelog = pychangelog.parse_plain_text(f)
...
>>> changelog
<pychangelog.ChangeLog object at 0x01F71A30>
>>> len(changelog)
4
>>> for release in changelog:
...     print repr(release)
...
<ReleaseInfo r1-1.0.0.0 (05/15/13)>
<ReleaseInfo r2-1.0.0.1 (05/18/13)>
<ReleaseInfo r3-1.1.0.0 (05/20/13)>
<ReleaseInfo r4*>
>>> r3 = changelog[2]
>>> r3
<ReleaseInfo r3-1.1.0.0 (05/20/13)>
>>> r3.release_num
3
>>> r3.version
(1, 1, 0, 0)
>>> r3.year
2013
>>> r3.date
datetime.date(2013, 5, 20)
>>> len(r3)
4
>>> for change in r3:
...     print change
...
[p] Bug fix in doo_little()
[n] Added the frobnicate function in order to frob objectsmore easily.
[s] Fixed up docs on doo_little.
[p] Bug fix in some private functions
>>> p = r3.patch
>>> len(p)
2
>>> for patch_change in p:
...     print patch_change
...
[p] Bug fix in doo_little()
[p] Bug fix in some private functions
>>> r3.append('[p] Another change I forgot to mention.')
>>> len(p)
3
>>> len(r3)
5
>>> for patch_change in p:
...     print patch_change
...
[p] Bug fix in doo_little()
[p] Bug fix in some private functions
[p] Another change I forgot to mention.
>>>

Dependencies?

pychangelog is developed against python version 2.7.

pychangelog also requires the docit package for its internals. If you install with pip, this will be handled automatically.

Some of the utilities in pychangelog.tests are optionally enhanced by the nose python package, but this is not strictly required. You can install nose with:

$ pip install nose

To build the sphinx docs from source (as is), you’ll need the sphinx_rtd_theme:

$ pip install sphinx_rtd_theme

Misc.

Contact Information

This project is currently hosted on bitbucket, at https://bitbucket.org/bmearns/pychangelog. The primary author is Brian Mearns, whom you can contact through bitbucket at https://bitbucket.org/bmearns.