Giter VIP home page Giter VIP logo

fastapi_rss's Introduction

FastAPI RSS

A library to easily integrate RSS Feeds into FastAPI

Rationale

The RSS standard has been around for a long time, and the specification has not changed much in the past 20 years. Regardless, it is still a useful format, and there is an added value to have an automated feed for updates about an API (notify users of upcoming changes), or in general as a backend for full-featured applications

Usage

You will need to import at least three classes to use that library:

  • RSSResponse, which is a subclass of starlette.Response. It's a text/xml typed response which will handle generating the XML from the pydantic models
  • RSSFeed which is a pydantic model that represents an RSS feed according to the RSS v2.0 specification from the World Wide Web Consortium
  • Item which is another pydantic model that represents an item in the feed.

Once those are imported, instanciate an RSSFeed object, with the appropriate parameters, then return an RSSResponse with that feed.

Your endpoint should now return an appropriate XML document representing your RSS feed. Look at example/app.py for an example app that uses the W3C RSS example.

fastapi_rss's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.