{"author":"Andrzej Klajnert","author_email":"python@aklajnert.pl","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"changelogd\r\n==========\r\n\r\n\r\n.. image:: https://img.shields.io/pypi/v/changelogd.svg\r\n :target: https://pypi.python.org/pypi/changelogd\r\n\r\n.. image:: https://dev.azure.com/aklajnert/changelogd/_apis/build/status/aklajnert.changelogd?branchName=master\r\n\r\n\r\nChangelogs without conflicts.\r\n\r\n\r\n* Free software: MIT license\r\n* Documentation: https://changelogd.readthedocs.io.\r\n\r\n\r\nOverview\r\n--------\r\n\r\nChangelogd allows teams to avoid merge conflicts for the changelog files. \r\nThe ``changelogd`` content is stored within multiple YAML files - one per each \r\nchangelog entry. Then, during application release, all input files are combined \r\ninto one release file. The script uses Jinja2 templates to generate one consistent \r\ntext file out of all input YAML files. The default output format is Markdown, but \r\nby modifying the templates it can be changed into any text format you like. \r\n\r\nInstallation\r\n------------\r\n\r\nYou can install ``changelogd`` via `pip`_ from `PyPI`_::\r\n\r\n $ pip install changelogd\r\n\r\nQuickstart\r\n----------\r\n\r\nFirst, initialize ``changelogd`` configuration.\r\n\r\n.. code-block:: bash\r\n\r\n $ changelogd init\r\n Created main configuration file: changelog.d\\config.yaml\r\n Copied templates to changelog.d\\templates\r\n\r\nThen, create changelog entries:\r\n\r\n.. code-block:: bash\r\n\r\n $ changelogd entry\r\n [1]: Features [feature]\r\n [2]: Bug fixes [bug]\r\n [3]: Documentation changes [doc]\r\n [4]: Deprecations [deprecation]\r\n [5]: Other changes [other]\r\n > Select message type [1]: 2\r\n > Issue ID: 100\r\n > Changelog message: Changelog message\r\n Created changelog entry at changelog.d\\bug.a3f13823.entry.yaml\r\n\r\nFinally, generate changelog file.\r\n\r\n.. code-block:: bash\r\n\r\n $ changelogd release version-number\r\n > Release description (hit ENTER to omit): This is the initial release.\r\n Saved new release data into changelog.d\\releases\\0.release-name.yaml\r\n Generated changelog file to changelog.md\r\n\r\nOutput file:\r\n\r\n.. code-block:: md\r\n\r\n # Changelog \r\n \r\n \r\n ## version-number (2020-01-11) \r\n \r\n This is the initial release. \r\n \r\n ### Bug fixes \r\n * [#100](http://repo/issues/100): Changelog message ([@user](user@example.com)) \r\n\r\nDocumentation\r\n-------------\r\n\r\nFor full documentation, please see https://changelogd.readthedocs.io/en/latest/.\r\n\r\nLicense\r\n-------\r\n\r\nDistributed under the terms of the `MIT`_ license, \"changelogd\" is free and open source software\r\n\r\nIssues\r\n------\r\n\r\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\r\n\r\n\r\n\r\n.. _`MIT`: http://opensource.org/licenses/MIT\r\n.. _`file an issue`: https://github.com/aklajnert/changelogd/issues\r\n.. _`pip`: https://pypi.org/project/pip/\r\n.. _`PyPI`: https://pypi.org/project\r\n\r\nHistory \r\n=======\r\n\r\n0.1.8 (2023-02-24) \r\n------------------\r\n\r\nFeatures \r\n~~~~~~~~\r\n* `#37 `_: Allow to set default values for entries.\r\n* `#36 `_: Allow to add entry to the existing release.\r\n\r\n0.1.7 (2022-10-10) \r\n------------------\r\n\r\nMinor improvements \r\n~~~~~~~~~~~~~~~~~~\r\n* `#26 `_: Trim whitespace from multi-value fields.\r\n\r\nOther changes \r\n~~~~~~~~~~~~~\r\n* `#25 `_: Switch to GitHub Actions.\r\n\r\n0.1.6 (2022-09-06) \r\n------------------\r\n\r\nFeatures \r\n~~~~~~~~\r\n* `#21 `_: Add support for computed values.\r\n\r\nMinor improvements \r\n~~~~~~~~~~~~~~~~~~\r\n* `#7 `_: Add a readme file that will be put into the changelogd config directory.\r\n\r\nOther changes \r\n~~~~~~~~~~~~~\r\n* `#19 `_: Remove invalid pytest option.\r\n* `#18 `_: Add support for python 3.9 and 3.10, fix tests.\r\n\r\n0.1.5 (2020-01-30) \r\n------------------\r\n\r\nMinor improvements \r\n~~~~~~~~~~~~~~~~~~\r\n* `#6 `_: Add __main__.py file to allow invoking via `python -m changelogd`.\r\n\r\n0.1.4 (2020-01-24) \r\n------------------\r\n\r\nMinor improvements \r\n~~~~~~~~~~~~~~~~~~\r\n* `#5 `_: Save timestamp with entry YAML, so the order won't be affected by simple file modification.\r\n* `#4 `_: Display entry title with `Select message type` question.\r\n\r\n0.1.3 (2020-01-20) \r\n------------------\r\n\r\nFeatures \r\n~~~~~~~~\r\n* `#2 `_: Allow to control which user data will be saved in entries.\r\n* `#3 `_: Automatically add new entries and releases to git.\r\n\r\nOther changes \r\n~~~~~~~~~~~~~\r\n* `#1 `_: Switch from ``tox`` to ``nox`` for running tests and tasks.\r\n\r\n0.1.2 (2020-01-17) \r\n------------------\r\n\r\nBug fixes \r\n~~~~~~~~~\r\n* Fixed missing templates from the ``MANIFEST.in``\r\n\r\n0.1.1 (2020-01-16) \r\n------------------\r\n\r\nInitial release \r\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/aklajnert/changelogd","keywords":"changelogd","license":"MIT license","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"changelogd","package_url":"https://pypi.org/project/changelogd/","platform":null,"project_url":"https://pypi.org/project/changelogd/","project_urls":{"Homepage":"https://github.com/aklajnert/changelogd"},"provides_extra":["test","dev","docs"],"release_url":"https://pypi.org/project/changelogd/0.1.9/","requires_dist":["Click>=8.1.7","Jinja2>=3.1.3","toml>=0.10.2","ruamel.yaml>=0.18.6","pytest>=5; extra == \"test\"","pyfakefs==5.4; extra == \"test\"","pytest-subprocess; extra == \"test\"","bump2version==1.0.1; extra == \"dev\"","wheel==0.43.0; extra == \"dev\"","flake8==7.0.0; extra == \"dev\"","nox==2024.3.2; extra == \"dev\"","mypy==1.9.0; extra == \"dev\"","sphinx; extra == \"docs\""],"requires_python":">=3.6","summary":"Changelogs without conflicts.","version":"0.1.9","yanked":false,"yanked_reason":null}

Dependency	Optional
Click	false
Jinja2	false
ruamel.yaml	false
toml	false
bump2version	true
flake8	true
mypy	true
nox	true
pyfakefs	true
pytest	true
pytest-subprocess	true
sphinx	true
wheel	true

Package search

changelogd

project_urls

Dependencies

All package metadata

Releases