rss-reader

rss-reader provides an API to serve users with RSS feeds.

Installation

To install, follow these steps:

1. Create a Python virtual environment using your preferred choice (pyenv is recommended)

2. With the recently created virtual environment activated, install the package with the following command:

   make setup

Note: rss-reader requires Python 3.10 or newer.

Database

rss-reader uses PostgreSQL to store its date. Provide the database connection URL via the RSS_READER_DATABASE_URL environment variable. For instance:

export RSS_READER_DATABASE_URL="postgresql://postgres:postgres@localhost:5432/rss_reader"

Then proceed to create the tables:

make create-tables

Running locally

Once the package is installed, run the API with the following:

make run

Or with debug level logging:

LOG_LEVEL=DEBUG make run

The API should be available at http://localhost:8000

Accessing the API

The API documentation is available at http://localhost:8000/docs and provides details on how to interact with the API.

Running tests

1. Run tests with:

   make test

2. And check code coverage with:

   make coverage
   open htmlcov/index.html

Extra

1. To see all available make targets:

   make list

License

Code in this repository is distributed under the terms of the BSD 3-Clause License (BSD-3-Clause).

See LICENSE for details.