Skip to main content

Helpers for parsing astropy changelogs

Project description

About

https://travis-ci.org/astropy/astropy-changelog.svg https://codecov.io/gh/astropy/astropy-changelog/branch/master/graph/badge.svg

This package contains a parser for the Astropy changelog format. Example usage:

In [1]: from astropy_changelog import load

In [2]: changes = load('CHANGES.rst')

In [3]: changes.versions
Out[3]:
['0.1',
 '0.2',
 '0.2.1',
 '0.2.2',
 '0.2.3',
 ...]

In [4]: changes.issues
Out[4]:
[256,
 272,
 291,
 293,
 296,
 ...]

In [5]: changes.versions_for_issue(4242)
Out[5]: ['1.2']

In [6]: changes.issues_for_version('2.0.7')
Out[6]: [7411, 7248, 7402, 7422, 7469, 7486, 7453, 7493, 7510, 7493]

Format specification

The current format uses reStructuredText. Changelog entries should be given as bullet point items inside sections for each version. These sections should have a title with the following syntax:

version (release date)

The release date can be unreleased if the version is not released yet.

The version sections can optionally include sub-sections in which the bullet items are organized, and the file can also optionally include an overall title.

Project details


Release history Release notifications

This version
History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
astropy_changelog-0.1-py2.py3-none-any.whl (6.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
astropy-changelog-0.1.tar.gz (5.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page