redcom/sentinel

Sentinel is a sentiment analysis tool

Sentinel

Sentinel is an application written in Python that may be used to perform sentiment analysis on a piece of text. It leverages an external API for this purpose and provides a safe default when the API is unavailable.

Commands

The following commands describe how the application may be built, run and tested. Note that Python 3.10 and Poetry are required.

Setup

poetry install

Run

uvicorn sentinel.api:app --host 0.0.0.0 --port 8000 --reload

From another terminal window, you may query the application with:

curl -XPOST http://localhost:8000/analyze -H "Content-Type: application/json" -d '{"text": "This is a test."}'

Unit tests and coverage

poetry run coverage run -m pytest tests/test_unit.py
poetry run coverage report --fail-under 90

Regression tests

By default, regression tests run against an application running on localhost:8000. However, you may use the BASE_URL environment variable to run against a different URL.

BASE_URL=http://localhost:8000 poetry run pytest tests/test_regression.py

Integration tests

poetry run pytest tests/test_integration.py