Skip to content

zodman/feed-api

Repository files navigation

Feed Readed api only

Django CI

Coverage Status

Functional Requeriments:

  • Follow and unfollow multiple feeds
  • List all feeds registered by them
  • List feed items belonging to one feed
  • Mark items as read
  • Filter read/unread feed items per feed and globally (e.g. get all unread items from all feeds or one feed in particular). Order the items by the date of the last update
  • Force a feed update
  • async implementation with dramatiq

Api Design:

  • List all feeds registered
    /api/feed/
  • Create a feed
    POST /api/feed/
  • List feed items belongs to one feed
    /api/feed/<id>/entries/
  • Filter with params /api/feed/<id>/entries/?readed=True|False
  • mark feed items readed
    /api/feed/<id>/entries/<id>/readed
  • follow and unfollow feeds
    /api/feed/<id>/follow /api/feed/<id>/unfollow
  • force feed update
    /api/feed/<id>/fetch
  • List all feed globally
    /api/entries/

get it running

docker-compose up

Then check the http://<dockerhost>:8000

run the testing

docker-compose run web bash
bake test

async requirements implementation on

run.py
core/tasks.py
core/tests/test_tasks.py

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published