kac_tools package

Subpackages

• kac_tools.cli package
  • Submodules
  • kac_tools.cli.cli module
    • parse_changelog()
    • main()
  • Module contents

Submodules

kac_tools.changelog module

Changelog class that represents the model of a provided CHANGELOG file

class kac_tools.changelog.Section(section_string: str)

Bases: object

Section class representing a single changelog section.

to_json() → str

Read content section in json format

Returns:

String containing the content of the section in json format.

Return type:

json (str)

class kac_tools.changelog.Changelog(path: PurePath)

Bases: object

Changelog class representing changelog composed of multiple sections.

read_content() → str

Read content of file in self.path

Returns:

String containing the content of the changelog file.

Return type:

content (str)

parse_sections() → OrderedDict

Parse sections from self.content

Returns:

Dict containing Section objects with their titles as keys.

Return type:

section_dict (OrderedDict)

Module contents