readme#

Helper functions for modifying README.md.

class ModifiableReadme(lines: list[str], source: Path, *, exists: bool)[source]#

Bases: ModifiableResource

In-memory representation of README.md.

classmethod load(source: Path = PosixPath('README.md')) ModifiableReadme[source]#

Load the resource from the working tree.

property changelog: list[str][source]#

Changes made to the in-memory representation.

dump() None[source]#

Write the in-memory representation to the working tree.

add_badge(badge: str) None[source]#
remove_badge(badge_pattern: str) None[source]#
add_badge(session: Session, /, badge: str) None[source]#
remove_badge(session: Session, /, badge_pattern: str) None[source]#