multipackage.data.scripts.release_notes module

Helper script for parsing release notes from a markdown file.

Summary

Functions:

build_parser	Build our argument parser.
get_release_notes	Get a release notes section from a markdown file.
get_version	Get the version of package.
main	Main entry point for release_notes.py.
parse_release_header	Parse a version from a markdown header.

Data:

DESCRIPTION	str(object=’‘) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
VERSION	str(object=’‘) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Reference

multipackage.data.scripts.release_notes.build_parser()

Build our argument parser.

multipackage.data.scripts.release_notes.get_version(path)

Get the version of package.

multipackage.data.scripts.release_notes.parse_release_header(version_line, prefix='##')

Parse a version from a markdown header.

The line must be formatted as: ## [v]X.Y.Z [whatever else you want]

So you could have, for example: ## 1.5.0 (11/28/2018) ##1.5.0 ## v1.5.0 - 11/28/2018 ## 1.5.0 hello this is a test

Returns:The parsed version. Return type:str

multipackage.data.scripts.release_notes.get_release_notes(path, version)

Get a release notes section from a markdown file.

multipackage.data.scripts.release_notes.main(argv=None, should_raise=True)

Main entry point for release_notes.py.