Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog.d/20260914_aryabov_cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Added
-----

* Add a command-line tool that outputs normalized feed data as JSON.
27 changes: 27 additions & 0 deletions feedparser/cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import argparse
import json
import sys

from .api import parse


def main():
parser = argparse.ArgumentParser()
parser.add_argument("source", help="feed URL, filename, or - for stdin")
args = parser.parse_args()

source = sys.stdin.buffer if args.source == "-" else args.source
feed = parse(source)
if feed.bozo:
raise feed.bozo_exception

json.dump(
{"feed": feed.feed, "entries": feed.entries},
sys.stdout,
ensure_ascii=False,
indent=2,
)


if __name__ == "__main__":
main()
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ dependencies = [
"requests>=2.20.0",
]

[project.scripts]
feedparser = "feedparser.cli:main"

[project.urls]
Source = "https://github.com/kurtmckee/feedparser"
Documentation = "https://feedparser.readthedocs.io/en/latest/"
Expand Down
55 changes: 55 additions & 0 deletions tests/test_cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import json
import subprocess
import sys

import pytest

FEED = """\
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
<channel>
<title>Test feed</title>
<link>https://example.com/</link>
<description>Test feed</description>
<item>
<title>Café</title>
<link>https://example.com/cafe</link>
</item>
</channel>
</rss>
"""


@pytest.mark.parametrize("from_stdin", [False, True])
def test_cli_outputs_entries(tmp_path, from_stdin):
path = tmp_path / "feed.xml"
path.write_text(FEED)
source = "-" if from_stdin else str(path)

result = subprocess.run(
[sys.executable, "-m", "feedparser.cli", source],
input=FEED if from_stdin else None,
capture_output=True,
text=True,
)

assert result.returncode == 0
output = json.loads(result.stdout)
assert output["feed"]["title"] == "Test feed"
assert output["entries"][0]["title"] == "Café"
assert "Café" in result.stdout
assert '\n "feed": {' in result.stdout
assert result.stderr == ""


def test_cli_fails_on_malformed_feed():
result = subprocess.run(
[sys.executable, "-m", "feedparser.cli", "-"],
input="<rss>",
capture_output=True,
text=True,
)

assert result.returncode != 0
assert result.stdout == ""
assert result.stderr