{"author":null,"author_email":"Ben Finney ","bugtrack_url":null,"classifiers":["Development Status :: 2 - Pre-Alpha","Intended Audience :: Developers","License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)","Programming Language :: Python :: 3","Topic :: Software Development :: Build Tools"],"description":"changelog-chug is a parser for project Change Log documents.\n\nchangelog-chug\n##############\n\nExample\n=======\n\nGiven a reStructuredText document ChangeLog::\n\n Change Log\n ##########\n\n Version 1.0.1\n =============\n\n :Released: 2020-01-10\n :Maintainer: Cathy Morris \n\n …\n\n Version 1.0\n ===========\n\n :Released: 2020-01-10\n :Maintainer: Luis Flores \n\n …\n\n Version 0.2\n ===========\n\n :Released: 2019-07-04\n :Maintainer: Cathy Morris \n\n …\n\n Version 0.2-alpha1\n ==================\n\n :Released: 2019-07-04\n :Maintainer: Cathy Morris \n\n …\n\n Version 0.1\n ===========\n\n :Released: 2019-05-16\n :Maintainer: Cathy Morris \n\n …\n\nGenerate Change Log entry data for all versions from the reStructuredText\nformatted ChangeLog::\n\n >>> import pathlib\n >>> import pprint\n >>> import chug.parsers.rest\n >>> import chug.writers\n >>> infile_path = pathlib.Path(\".\", \"ChangeLog\")\n >>> document_text = chug.parsers.get_changelog_document_text(infile_path)\n >>> document = chug.parsers.rest.parse_rest_document_from_text(\n ... document_text)\n >>> entries = chug.parsers.rest.make_change_log_entries_from_document(\n ... document)\n >>> pprint.pprint([entry.as_version_info_entry() for entry in entries])\n [OrderedDict([('release_date', '2020-01-10'),\n ('version', '1.0.1'),\n ('maintainer', 'Cathy Morris '),\n ('body', '…')]),\n OrderedDict([('release_date', '2020-01-10'),\n ('version', '1.0'),\n ('maintainer', 'Luis Flores '),\n ('body', '…')]),\n OrderedDict([('release_date', '2019-07-04'),\n ('version', '0.2'),\n ('maintainer', 'Cathy Morris '),\n ('body', '…')]),\n OrderedDict([('release_date', '2019-07-04'),\n ('version', '0.2-alpha1'),\n ('maintainer', 'Cathy Morris '),\n ('body', '…')]),\n OrderedDict([('release_date', '2019-05-16'),\n ('version', '0.1'),\n ('maintainer', 'Cathy Morris '),\n ('body', '…')])]\n\nGenerate a JSON document describing the latest version::\n\n >>> import json\n >>> latest_entry = entries[0]\n >>> latest_entry_json = json.dumps(\n ... latest_entry.as_version_info_entry(), indent=4)\n >>> print(latest_entry_json)\n {\n \"release_date\": \"2020-01-10\",\n \"version\": \"1.0.1\",\n \"maintainer\": \"Cathy Morris \",\n \"body\": \"\\u2026\"\n }\n\n\nCopying\n=======\n\nchangelog-chug is free software. See the file `COPYING`_ for details.\n\n.. _COPYING: COPYING\n\n\f\n..\n This document is written using `reStructuredText`_ markup, and can\n be rendered with `Docutils`_ to other formats.\n\n .. _Docutils: http://docutils.sourceforge.net/\n .. _reStructuredText: http://docutils.sourceforge.net/rst.html\n\n..\n Local variables:\n coding: utf-8\n mode: rst\n End:\n vim: fileencoding=utf-8 filetype=rst :\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"version, changelog, release, packaging","license":"Copying this work ################# changelog-chug is `free software`_; you are free to redistribute it and/or modify it under specific conditions. .. _free software: https://www.gnu.org/philosophy/free-sw.html Software ======== Copyright © 2008–2023 Ben Finney This is free software: you may copy, modify, and/or redistribute this work under the terms of the GNU Affero General Public License as published by the Free Software Foundation; version 3 of that license or any later version. No warranty expressed or implied. See the file `LICENSE.AGPL-3`_ for details, or online at ``_. .. _LICENSE.AGPL-3: LICENSE.AGPL-3 .. Local variables: coding: utf-8 mode: rst End: vim: fileencoding=utf-8 filetype=rst : ","license_expression":null,"license_files":null,"maintainer":"Ben Finney ","maintainer_email":null,"name":"changelog-chug","package_url":"https://pypi.org/project/changelog-chug/","platform":null,"project_url":"https://pypi.org/project/changelog-chug/","project_urls":{"Change Log":"https://git.sr.ht/~bignose/changelog-chug/tree/main/item/ChangeLog","Home Page":"https://git.sr.ht/~bignose/changelog-chug","Issue Tracker":"https://todo.sr.ht/~bignose/changelog-chug","Source":"https://git.sr.ht/~bignose/changelog-chug"},"provides_extra":["build","devel","publish","static-analysis","test"],"release_url":"https://pypi.org/project/changelog-chug/0.0.3/","requires_dist":["semver>=3.0.0","docutils>=0.21.0","changelog-chug[devel]; extra == \"build\"","wheel; extra == \"build\"","build; extra == \"build\"","changelog-chug[test]; extra == \"devel\"","pyupgrade~=3.17; extra == \"devel\"","isort~=5.13; extra == \"devel\"","changelog-chug[build]; extra == \"publish\"","twine; extra == \"publish\"","pip-check; extra == \"static-analysis\"","mccabe~=0.7; extra == \"static-analysis\"","pycodestyle~=2.12; extra == \"static-analysis\"","ruff~=0.6; extra == \"static-analysis\"","changelog-chug[static-analysis]; extra == \"test\"","testtools; extra == \"test\"","testscenarios>=0.4; extra == \"test\"","coverage; extra == \"test\""],"requires_python":">=3.7","summary":"Parser library for project Change Log documents.","version":"0.0.3","yanked":false,"yanked_reason":null}

Dependency	Optional
docutils	false
semver	false
build	true
changelog-chug	true
coverage	true
isort	true
mccabe	true
pip-check	true
pycodestyle	true
pyupgrade	true
ruff	true
testscenarios	true
testtools	true
twine	true
wheel	true

Package search

changelog-chug

project_urls

Dependencies

All package metadata

Releases