Skip to content

README.md

Latest commit

 

History

History
40 lines (24 loc) · 1.4 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.4 KB

Python backend

Usage

  • uv sync to install dependencies
  • uv run python xyz.py to run a Python script
  • uv run uvicorn media_impact_monitor.api:app --host 0.0.0.0 --port 8000 to serve the API
  • uv run --extra dev pytest to run tests
  • uv run --extra dev pytest -k fridays to run only tests with "fridays" in their definition name
  • uv run --extra dev py-spy record -o profile.svg -- python xyz.py to do profiling

Deployment

Continuous deployment is currently set up with railway.app.

Important: Configure a PORT environment variable there, otherwise the app will not be accessible and will be Shutting down for no apparent reason.

Mount a persistent disk to /app/backend-python/cache.

3rd party services

These are configured via a .env file, see .env.example. You will need to add the required API keys (BUNDESTAG_API_KEY, ACLED_KEY, etc.).

Azure OpenAI

We have defined the following endpoints on Azure OpenAI:

  • gpt-4o-mini: gpt-4o-mini-2024-07-18 (128k tokens context)

Azure OpenAI uses content filters, also for the input texts, that cannot be switched off, but their thresholds can be set to high.

Similar models are also available via OpenAI directly.

Conventions

Date types

  • For dates use datetime.date, also within Pandas dataframes (where usually one might use pd.Timestamp, but for consistency we do not).
  • For datetimes: t.b.d.