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 | RSS feed

This version

0.1

Download files

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

Source Distribution

astropy-changelog-0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

astropy_changelog-0.1-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file astropy-changelog-0.1.tar.gz.

File metadata

  • Download URL: astropy-changelog-0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for astropy-changelog-0.1.tar.gz
Algorithm Hash digest
SHA256 34526b7663eb4300fe533c73b16ce139f498b7845230555b864023a3eea58287
MD5 7adf0fb20e5d8e2da2792b51d64b8b68
BLAKE2b-256 ecf44fa9f3c8d7de160514170897e82a50c214e9048d314ef1c651d288a502b9

See more details on using hashes here.

File details

Details for the file astropy_changelog-0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: astropy_changelog-0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for astropy_changelog-0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 293b9b0716f799d05db4b7096468c86746c269e1734b7980c98045ff9f812bb7
MD5 6ed42a219cc00f071adb554af555e657
BLAKE2b-256 97a54408aece3e1a474d7f31ec90d333ca581f983fbc7b257bfd3c44e387cd38

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page