rtfc 0.1.0__py3-none-any.whl

rtfc-0.1.0.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: rtfc
+Version: 0.1.0
+Author-email: Victorien <contact@vctrn.dev>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: tomli-w>=1.2.0
+Requires-Dist: typing-extensions>=4.16.0
+Description-Content-Type: text/x-rst
+
+====
+rtfc
+====
+
+|Pythons| |PyPI| |Docs| |Ruff|
+
+.. |Pythons| image:: https://img.shields.io/pypi/pyversions/rdfm.svg
+  :alt: Supported Python versions
+  :target: https://pypi.org/project/rdfm/
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/rdfm.svg
+  :alt: PyPI - Version
+  :target: https://pypi.org/project/rdfm/
+
+.. |Docs| image:: https://img.shields.io/readthedocs/rtfc.svg
+  :alt: Documentation status
+  :target: https://rtfc.readthedocs.io
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+  :alt: Ruff
+  :target: https://github.com/astral-sh/ruff
+
+*Read the freaking changelog* is a tool to manage changelogs and versioning.
+
+As the name implies, rtfc helps you produce clear, well-structured changelogs,
+leaving your users no excuse for being surprised by what changed between releases.
+
+rtfc is heavily inspired by the great `Towncrier`_ project.
+
+.. _`Towncrier`: https://towncrier.readthedocs.io/en/stable/
+
+Installation
+------------
+
+From PyPI:
+
+.. code:: bash
+
+    pip install rtfc
+
+Usage
+-----
+
+Configure rtfc in the ``[tool.rtfc]`` table of your ``pyproject.toml`` (or in
+an ``rtfc.toml`` file), and add the insert marker to your changelog document:
+
+.. code:: toml
+
+    [tool.rtfc]
+    changelog = "docs/source/changelog.rst"
+
+.. code:: rst
+
+    Changelog
+    =========
+
+    .. rtfc-insert
+
+Changelog entries are individual files created along the changes of a pull
+request, avoiding the merge conflicts a shared changelog file causes:
+
+.. code:: console
+
+    $ rtfc new --section bugfix --meta gh_issue=123 --content "Fix a bug."
+    Created changelog/d0592011.bugfix.rtfc
+
+Each entry holds a TOML frontmatter and the change description, written in the
+documentation format of your project:
+
+.. code:: text
+
+    +++
+    date = 2026-08-06
+    nonce = "d0592011"
+    section = "bugfix"
+
+    [metadata]
+    gh_issue = 123
+    +++
+    Fix a bug.
+
+Validate the configuration and the entries, typically in CI:
+
+.. code:: console
+
+    $ rtfc check
+    OK: 1 valid entries
+
+On release, combine the entries into the changelog. The version block is
+inserted after the marker, and the entry files are deleted:
+
+.. code:: console
+
+    $ rtfc build --version 1.2.0
+    Updated docs/source/changelog.rst
+
+A sphinx extension is also provided, rendering the not-yet-released entries
+when building your documentation.

rtfc-0.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+rtfc/__init__.py,sha256=2Gdt2aIA9F4LF_IX3NHwNqSKRbBk7oRu3OUOws2KPnE,162
+rtfc/__main__.py,sha256=uWkpImb8cYH1yMZkUNLc5eApAp0xzkCThS7OZN5Ggdg,159
+rtfc/_changelog.py,sha256=b3qVSGP_t42EGp9A706J93ZS_P6BnqQb9PNNKgubLE0,1471
+rtfc/_cli.py,sha256=ezMoTg_t1NyMg1XfLjHXTWYeT_TjP5j-Hxyx3h4rg2M,8281
+rtfc/_config.py,sha256=_xxyJMwTfZNTXSXM_g3dPZeMPyyL6XcwXEGFNYUi6IU,11020
+rtfc/_entry.py,sha256=FIVGDt2OF5DmWi_4v7ZzbLSeaBX-veWp9iNhcupECnc,8926
+rtfc/_validation.py,sha256=OCjXwTgEXzebAhcZqcs4GMCPdlXV6dXLmm9MTUcS_Qk,19415
+rtfc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rtfc/sphinx.py,sha256=cActwlRXiflz8nx3J94NMlDetWCj9EBigYUvP0eHR34,3704
+rtfc/_format/__init__.py,sha256=6A-kjJDYVEUSSf_MkwmJmmV7dajCSzaYXyCe7gAurDg,1387
+rtfc/_format/base.py,sha256=--vZjFZ2vXQSCdS57ASYCGCAQW1XOFcopSdL0VOaLEE,2004
+rtfc/_format/rst.py,sha256=2U2ynMlimmR_MKirn0XGZPfukuuXjD4uBaYu1ZAftUg,597
+rtfc/_render/__init__.py,sha256=zNvSSHE9sh1skry24Ht20GITeljhoXlV172vKyB7exY,701
+rtfc/_render/base.py,sha256=T1C0CDxj8SGruwvAtmWAy5Kf0pkRhP2ff-jLEH9ikOU,3468
+rtfc/_render/jinja.py,sha256=wg-iR6Dx_3CXgXXFIxDhlFZyFTf8IuTtDAi2MK6WzF4,2904
+rtfc-0.1.0.dist-info/METADATA,sha256=NbV8LOjDf7ujvO5H1Qio1jQ_sfiFybGXUqdull0tdTs,3293
+rtfc-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+rtfc-0.1.0.dist-info/entry_points.txt,sha256=Etq7TvAZUMj90rVfhKS-iVRMPhiX5DLeO-WE2GvuaY0,40
+rtfc-0.1.0.dist-info/licenses/LICENSE,sha256=A04j6CjugHTujrL2VRuEw7A8NjQv4PX4cVrxqq8DOno,1066
+rtfc-0.1.0.dist-info/RECORD,,

rtfc-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

rtfc-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rtfc = rtfc._cli:main

rtfc-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Victorien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.