add RSS feed

[halyph]

I use mkdocs rss plugin to generate feed. this is total crap. I think it is better to rewrite to simpler script

[halyph]

Sample pip install feedgen:

"""
Feed generation example using feedgen.
Install with: pip install feedgen

Generates both RSS 2.0 (feed.xml) and Atom (feed.atom) from the same data.
"""

from datetime import datetime, timezone
from feedgen.feed import FeedGenerator


# --- Your blog posts (in a real app, load these from a DB or markdown files) ---

POSTS = [
    {
        "title": "Getting Started with Python",
        "url": "https://example.com/2026/02/getting-started-with-python/",
        "published": datetime(2026, 2, 13, 9, 0, 0, tzinfo=timezone.utc),
        "content": "<p>Python is a great language to start with...</p>",
        "summary": "An introduction to Python for beginners.",
    },
    {
        "title": "Understanding RSS and Atom Feeds",
        "url": "https://example.com/2026/01/rss-and-atom/",
        "published": datetime(2026, 1, 20, 12, 0, 0, tzinfo=timezone.utc),
        "content": "<p>RSS and Atom are XML-based feed formats...</p>",
        "summary": "A comparison of RSS 2.0 and Atom feed formats.",
    },
    {
        "title": "Building a Static Site Generator",
        "url": "https://example.com/2025/12/static-site-generator/",
        "published": datetime(2025, 12, 5, 8, 0, 0, tzinfo=timezone.utc),
        "content": "<p>Static site generators are simple but powerful...</p>",
        "summary": "How to build your own static site generator in Python.",
    },
]


def build_feed() -> FeedGenerator:
    """Create and configure the feed with site metadata."""
    fg = FeedGenerator()

    fg.title("My Python Blog")
    fg.link(href="https://example.com", rel="alternate")  # site homepage
    fg.description("A blog about Python and software engineering.")  # required for RSS
    fg.language("en")
    fg.author({"name": "Jane Smith", "email": "jane@example.com"})

    # Self-referencing links (best practice — tells readers where to find the feed)
    fg.link(href="https://example.com/feed.xml", rel="self")

    # Add the 10 most recent posts (slice your list here)
    recent = POSTS[:10]

    for post in recent:
        fe = fg.add_entry()

        fe.title(post["title"])
        fe.link(href=post["url"])

        # guid / id: stable unique identifier — use the URL if it won't change
        fe.id(post["url"])

        fe.published(post["published"])
        fe.updated(post["published"])  # set to last-modified if you track that

        # Full HTML content (what readers display)
        fe.content(post["content"], type="html")

        # Short summary (optional but useful — some readers show this in list view)
        fe.summary(post["summary"])

    return fg


def main():
    fg = build_feed()

    # --- RSS 2.0 ---
    # pretty_print=True adds indentation, making the file human-readable
    fg.rss_file("feed.xml", pretty=True)
    print("Written: feed.xml")

    # --- Atom ---
    fg.atom_file("feed.atom", pretty=True)
    print("Written: feed.atom")


if __name__ == "__main__":
    main()