Skip to main content

A high-performance, unifying library for data ingestion pipelines from multiple sources.

Project description

FeedUnify

A high-performance, asynchronous Python library designed to unify and simplify data ingestion from multiple sources like RSS feeds and APIs into a single, clean format.


About The Project

Developers often need to pull data from various inconsistent sources like RSS feeds, Atom feeds, JSON APIs, and more. Each source has its own data structure and quirks, leading to brittle, custom code for each one.

feedunify solves this by providing a single, elegant interface to fetch, parse, and standardize content from any source into a predictable, easy-to-use FeedItem object.

Key Features

  • Unified Schema: All data is parsed into a standard FeedItem object with consistent fields like .title, .url, and .published_at.
  • Asynchronous-First: Built from the ground up with asyncio and httpx to handle hundreds of sources concurrently without blocking.
  • Extensible Architecture: Designed around a BaseConnector class, allowing new connectors for different source types to be easily added.
  • Type-Safe & Robust: Leverages pydantic for powerful data validation and parsing, preventing errors from malformed data.

Installation

Currently, you can install feedunify directly from the GitHub repository.

pip install git+[https://github.com/Rudra-K/feedunify.git]


Quickstart

Here's how easy it is to fetch articles from multiple RSS feeds at the same time.

import asyncio
from feed_forge import Forge

# A list of RSS feeds to fetch from.
SOURCES = [
    "https://www.theverge.com/rss/index.xml",
    "https://www.wired.com/feed/rss",
    "https://hnrss.org/frontpage"
]

async def main():
    """Main function to run the fetching process."""
    
    # 1. Create an instance of the main Forge class.
    forge = Forge()
    
    # 2. Fetch all items concurrently.
    print(f"Fetching from {len(SOURCES)} sources")
    all_items = await forge.fetch_all(sources=SOURCES)
    print(f"Found {len(all_items)} total items.")
    
    # 3. Work with the clean, standardized data.
    print("\nLatest from The Verge:")
    for item in all_items:
        if "theverge.com" in str(item.source_url):
            print(f"- {item.title}")

if __name__ == "__main__":
    asyncio.run(main())

Usage

First, fetch a list of items from your desired sources.

import asyncio
from feed_forge import Forge

SOURCES = ["https://www.theverge.com/rss/index.xml", "https://hnrss.org/frontpage"]

async def get_items():
    forge = Forge()
    all_items = await forge.fetch_all(sources=SOURCES)
    return all_items

items = asyncio.run(get_items())

Once you have the items list, you can easily work with the standardized data.

Example 1: Find All Articles About "AI"

ai_articles = [
    item for item in items 
    if "ai" in item.title.lower()
]

print("AI Articles Found:")
for article in ai_articles:
    print(f"- {article.title}")

Example 2: Get the 5 Most Recent Articles

# Filter out items that might not have a publication date.
dated_items = [item for item in items if item.published_at]

# Sort the items by date.
dated_items.sort(key=lambda item: item.published_at, reverse=True)

print("\nMost Recent Articles:")
for article in dated_items[:5]:
    print(f"- {article.title} (Published: {article.published_at.strftime('%Y-%m-%d')})")

The FeedItem Object

The primary output of feedunify is a list of FeedItem objects. This object provides a standardized interface to the data, regardless of the original source.

Key Attributes

  • item.id (str): A unique identifier for the item.
  • item.title (str): The headline or title.
  • item.url (HttpUrl): A validated Pydantic URL object for the original content.
  • item.source_url (HttpUrl): The URL of the feed this item came from.
  • item.summary (str | None): A short summary or description.
  • item.published_at (datetime | None): A timezone-aware datetime object of when the item was published.
  • item.authors (List[Author]): A list of Author objects, each with .name and .url attributes.
  • item.tags (List[str]): A list of tags or categories.
  • item.raw (dict | None): The original, unprocessed data from the source, useful for debugging.

Future Plans

feedunify is actively being developed. Future goals include:

  • Adding a connector for common JSON APIs.
  • Implementing intelligent HTTP caching (ETags, Last-Modified).
  • Improving source detection logic.
  • Exploring support for more complex sources like newsletters.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

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

feedunify-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

feedunify-0.1.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file feedunify-0.1.0.tar.gz.

File metadata

  • Download URL: feedunify-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for feedunify-0.1.0.tar.gz
Algorithm Hash digest
SHA256 057e45e1602afc63ae1d2b0936befa2b33bcce9f2aab89034c5dc1abe7d9b83b
MD5 1d19df0ddd578d1907549867a1a76eb9
BLAKE2b-256 f28f645bc1c9adf82287ca23b5e517aea6a6205d83f3610b131f32ac1a9df461

See more details on using hashes here.

File details

Details for the file feedunify-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: feedunify-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for feedunify-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf12ec1001ffb2b0af5471aad07ec24b52e75202c28e8bd8cc5160ea0e0da5e5
MD5 26a045953e94d720adfb52ae83aa9071
BLAKE2b-256 c4903371c5f8bee95e1cc2c2f0772b50fedf07fd74e9aac7e50af05a40c2c157

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