Skip to main content

Async Simple and fast RSS parser module.

Project description

Ultra FAST RSS

PyPI - Version PyPI - Python Version


A simple ASYNC RSS parser. To make retrieving RSS feeds ultra fast.

Table of Contents

Status

[!CAUTION] This is module works and is used! But should be used with care! Extensive exception validation is left out on purpose for now in the code.

Installation

pip install ultrafastrss

Usage

In your Python program call the async function with a (large) list of URLs: process_rssfeeds(urls)

To validate and see the working: Create a simple demo program, create a python file fastrss_demo.py like (just copy-paste):

from ultrafastrss.ultrafastrss import process_rssfeeds 
import asyncio

urls = [
        'https://nocomplexity.com/rss',
        'https://www.eff.org/rss/updates.xml',
        'https://www.freebsd.org/news/rss.xml',
        'https://ubuntu.com/blog/feed',
        'https://nlnet.nl/feed.atom',
        'https://j3s.sh/feed.atom',
        'https://blog.research.google/atom.xml'
    ]
    
# Run the async RSS feed processing, all results are as json stored in the variable results

results = asyncio.run(process_rssfeeds(urls))
print(results)

After running this demo in a terminal by doing:

python ultrafastrss_demo.py

You should seen directly the result of all RSS information gathered!

You can do all kind of fun things with the returned json object which contains the crucial parts from the parsed rss or atom feeds!

Benchmarking

I did some benchmarking test with feedparser, a module that is widely used within many Python programs for parsing rss feeds. Results are minimal 10 times faster with 500 URLs.

License

ultrafastrss is distributed under the terms of the GPL-3.0-or-later license.

Architecture

This ultrafastrss parser is designed to parse RSS or Atom return JSON data. The parsing is delegating to specific parsers functions (rss_parser, atom_parser or rdf_parser). Only the attributes title, link and date are retrieved.

The key design principle for this parser is to retrieve JSON data from a significant number of feeds asynchronously.

Feed content or summary is not parsed on purpose. This is also not a RSS reader. But by clicking the retrieved link, the retrieved item can be viewed in a browser.

The fields that are parsed and stored for every feed are:

"title": "Exphormer: Scaling transformers for graph-structured data",
      "link": "http://blog.research.google/2024/01/exphormer-scaling-transformers-for.html",
      "date": "2024-01-23",
      "tags": [
        "Deep Learning",
        "Graphs"

All kind but edge cases are left out on purpose to keep the needed code simple. Creating a generic module for RSS/ATOM parsing is not simple. So design decision is to only incorporate logic that I need for the URLs I use.

Contribute

Great you want to contribute!

Simple Guidelines:

  • Questions, Feature Requests, Bug Reports please use on the Github Issue Tracker.

[!NOTE] This is module works and is used! But it is in pre-release status. Extensive exception validation is left out on purpose for now in the code. Feature requests are possible, but will probably only be realized after a quote and paid invoice. But this code is so Simple that I encourage everyone to make a special parser and share the code. So we all benefit!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ultrafastrss-0.1.20.tar.gz (54.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ultrafastrss-0.1.20-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file ultrafastrss-0.1.20.tar.gz.

File metadata

  • Download URL: ultrafastrss-0.1.20.tar.gz
  • Upload date:
  • Size: 54.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ultrafastrss-0.1.20.tar.gz
Algorithm Hash digest
SHA256 df5a588cc27dbcf7ffff8dd520c9f014af76c47885aebb85b400d010610ad8bc
MD5 2d3fdece2d17841f10a7c26ddc41e4a2
BLAKE2b-256 c04333f775c352e35b84d9345d33d5f707508c35367ee33b5542a2a1dac0d19d

See more details on using hashes here.

File details

Details for the file ultrafastrss-0.1.20-py3-none-any.whl.

File metadata

File hashes

Hashes for ultrafastrss-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 2200d3d638a2bf599c4d714ace329100a29f9eb883a43fa0a73d7791e530db9a
MD5 36f74ed816cb8c66ce6d5f173f77d54a
BLAKE2b-256 31161111b2cce11e41065c19d037a01280bb29b4451fa86b31efdfacc7c6f2b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page