highoncarbs / pint-assg Goto Github PK

Built using Python - Flask & Newspaper & SQLite

Create a virtual environment

python -m venv ENV

For Windows: ENV/Scripts/activate

For Unix or Linux: ENV/bin/activate

Install required packages pip install -r requirement.txt

API will run on localhost:5000

Returns: A JSON response containing a list of articles matching the filters.

Query Parameters:

• title (str): Filter articles by title (optional).
• url (str): Filter articles by URL (optional).
• limit (int): Limit the number of articles returned (default: 10).
• publish_date (str): Filter articles by publish date (optional).
• publisher (str): Filter articles by publisher (optional).

To retrieve articles with any parameters

curl "localhost:5000/articles?title=example_title&publish_date=yyyy-mm-dd&limit=10&publisher=example_publisher&url=example_url"

To retrieve articles with simple parameters

curl "localhost:5000/articles?limit=100"

To use this API, make a GET request to the /summary endpoint with the following query parameters:

• hour: (Optional) A string representing the hour to filter articles by yyyy-mm-dd HH:00:00.
• publisher: (Optional) A string representing the publisher to filter articles by.
• limit: (Optional) An integer representing the maximum number of articles to retrieve. The default is 10.

curl "localhost:5000/summary?hour=yyyy-mm-dd HH:00:00&publisher=nytimes&limit=5"