newspy 1.2.1

The news client written in Python that fetches and curates the world news across the web.

Newspy

The news client written in Python that fetches and curates the world news across the web.

Requirements

• Python 3.10
• Poetry 1.3.1+ (for dependency management)
• yarn (for the semantic-release versioning)
• API Key from the New API Organisation: https://newsapi.org/

News Sources

• News API. Requires API Key from: https://newsapi.org/
• RSS feeds

Getting started

1. Install and confirm the Python version

python --version

2. Create the virtual environment

python -m venv .venv

# Activate virtual environment
.venv/bin/activate # Linux or MacOS
.venv/Script/activate # Windows

3. Install the requirements

poetry install

4. Install the git hook scripts

pre-commit install

5. Yarn install semantic-release dependencies

yarn install

6. Set up husky pre-commit hook

yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'

Chores

• Add GitHub Action for Continuous Integration (CI)
• Add GitHub Action for Continuous Deployment (CD)