Curator Application

A full-stack application for managing and monitoring CuratorBot jobs.

Overview

The Curator Application consists of:

1. Backend: A FastAPI-based service that provides an interface to the Wikimedia Toolforge API
2. Frontend: A Vue.js application with TypeScript and PrimeVue for displaying and managing Toolforge jobs

This application is designed to work within the Wikimedia ecosystem, particularly for tools that need to interact with the Toolforge infrastructure programmatically.

Deployment

Build

toolforge build start -i web https://github.com/DaxServer/wikibots-curator-backend.git -L

-L flag uses the latest buildpacks and base image, required for Poetry.

Environment variables

Use toolforge envvars to set them up. The OAuth1 application is at OAuth applications - Wikimedia Meta-Wiki.

X_USERNAME
CURATOR_OAUTH1_KEY
CURATOR_OAUTH1_SECRET
SECRET_KEY
TOKEN_ENCRYPTION_KEY

TOKEN_ENCRYPTION_KEY is used to encrypt the access tokens using Fernet key, which is a 32 url-safe base64-encoded byte string. Generate a new key using:

openssl rand -base64 32

Webservice

When deploying for the first time, use:

toolforge webservice buildservice start --buildservice-image tool-curator/web:latest --mount all

For subsequent deployments, use:

toolforge webservice restart

Celery worker

After building the web image, run the Celery worker:

toolforge jobs run --image tool-curator/web:latest --emails all --continuous --filelog --mount all --command "worker" worker

Development

This project is the Backend application.

Prerequisites

• Python 3.13 or higher
• Poetry (for dependency management)

Installation

Install backend dependencies:

poetry install

Running the server

Start the FastAPI server:

X_USERNAME=DaxServer CURATOR_OAUTH1_KEY=abc123 CURATOR_OAUTH1_SECRET=abc123 TOKEN_ENCRYPTION_KEY=abc123 poetry run web

The backend server will be available at http://localhost:8000. The OAuth1 application is at OAuth applications - Wikimedia Meta-Wiki.

Testing build

Build the frontend for production:

pack build -B tools-harbor.wmcloud.org/toolforge/heroku-builder:24_0.20.7 curator-web

Running Tests

To run the tests, use the following command:

poetry run pytest

For verbose output:

poetry run pytest -v

Code Style

This project uses Black for code formatting. Run Black before committing your changes:

poetry run black .

License

MIT