tahrir-api

Tahrir-API

API for interacting with the Tahrir database. Based on the Tahrir database model written by Ralph Bean. There are two classes that can be used in this module. The first is the TahrirDatabase class located in tahrir_api.dbapi and the second is the database model located in tahrir_api.model. The TahrirDatabase class is a high level way to interact with the database. The model is used for a slightly more low level way of interacting with the database. It allows for custom interactions with the database without having to use the TahrirDatabase class.

Development

System Requirements

Before getting started, ensure your system meets the following requirements:

Software Requirements

Python: 3.9 or higher
Poetry: Latest version for dependency management
Database: PostgreSQL 9.6+ (recommended) or SQLite (basic development)
Git: For version control

Operating System Requirement

Fedora Linux: Latest non-EOL versions

Note: Other distributions may work, but are not officially supported. The maintainers may not be able to assist with platform-specific issues on non-Fedora systems.

Project Setup

Ensure that the necessary packages are installed:

$ sudo dnf install -y python3 python3-pip python3-devel poetry gcc krb5-devel git

Clone your fork to the local storage and make it your current working directory:

$ git clone https://github.com/fedora-infra/tahrir-api.git
$ cd tahrir-api

Create a virtual environment and activate it for installing project dependencies:

$ python3 -m venv venv
$ source venv/bin/activate

Install project dependencies:

(venv) $ poetry check
(venv) $ poetry install

Database Setup

Create a directory for storing the Tahrir database snapshot:

(venv) $ cd ..
(venv) $ mkdir badges-database
(venv) $ cd badges-database

Download and extract the Tahrir database snapshot:

(venv) $ wget https://infrastructure.fedoraproject.org/infra/db-dumps/tahrir.dump.xz
(venv) $ unxz tahrir.dump.xz

Create directories for persistent data and the database dump:

(venv) $ mkdir data dump
(venv) $ mv tahrir.dump dump/

Pull the PostgreSQL container image:

(venv) $ podman pull docker.io/library/postgres:15

Start the database container (be sure to rename the username and paths based on your development environment):

(venv) $ podman run \
    --name badges-database \
    --env POSTGRES_USER=badgesdb \
    --env POSTGRES_PASSWORD=badgesdb \
    --env POSTGRES_DB=badgesdb \
    --env PGDATA=/var/lib/postgresql/data/pgdata \
    --volume /home/username/Projects/badges-database/data:/var/lib/postgresql/data:Z \
    --volume /home/username/Projects/badges-database/dump:/badgesdb:Z \
    --publish 5432:5432 \
    --restart unless-stopped \
    --detach docker.io/library/postgres:15

Once the database container has started, log in to the interactive shell using the password to begin importing the extracted dump:

(venv )$ podman pull docker.io/library/postgres:15
(venv )$ podman run \

Execute the following SQL commands to create roles, load the database dump, and grant the needed access:

badgesdb=# create role "tahrir" with inherit nocreatedb nocreaterole noreplication nosuperuser valid until 'infinity' login password 'tahrir';
badgesdb=# create role "tahrir-readonly" with nocreatedb inherit nocreaterole noreplication nosuperuser valid until 'infinity' login password 'tahrir-readonly';
badgesdb=# \i badgesdb/tahrir.dump
badgesdb=# grant connect on database tahrir to "tahrir";
badgesdb=# grant all on all tables in schema public to "tahrir";
badgesdb=# grant all on all sequences in schema public to "tahrir";
badgesdb=# revoke create on schema public from public;

Exit out of the interactive shell and log back in using the newly created credentials:

(venv )$ podman exec -ti badges-database psql --username badgesdb --password

Verify the database setup:

(venv )$ tahrir=> \dt+

Run the tests

Download and install tox:

(venv) $ cd ./tahrir-api
(venv) $ sudo dnf install tox

Run the tests with tox:

(venv) $ tox

Release files for tahrir-api 1.5.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tahrir-api 1.5.6
File	Size	Uploaded
tahrir_api-1.5.6.tar.gz	50.8 kB	Aug 20, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for tahrir-api 1.5.6
File	Interpreter	ABI	Platform	Reset
tahrir_api-1.5.6-py3-none-any.whl 58.8 kB Aug 20, 2026	Python 3	none	any	Details

Total release size: 109.6 kB

Release files / tahrir_api-1.5.6.tar.gz

Download URL	tahrir_api-1.5.6.tar.gz
Size	50.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`be8ad34a15f598ab69634de804912c1800ba40f026a0e3704392aa76a0985c84`
BLAKE2b-256 checksum How to use checksums	`afc4415f1856a081c4e9546fa90930cebcfc3d8efbee32a091223773f044f141`
Upload date	Aug 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/fedora-infra/tahrir-api
Publishing commit: github.com/fedora-infra/tahrir-api/tree/8773a0a9c57fd9c5c273332c55b6b5a2cc422acf

Workflow

Publishing configuration: github.com/fedora-infra/tahrir-api/blob/8773a0a9c57fd9c5c273332c55b6b5a2cc422acf/.github/workflows/main.yml
Publishing logs: github.com/fedora-infra/tahrir-api/actions/runs/32369850688/attempts/1

Artifact

Subject: tahrir_api-1.5.6.tar.gz
SHA-256 checksum: be8ad34a15f598ab69634de804912c1800ba40f026a0e3704392aa76a0985c84 Verifying attestations

Release files / tahrir_api-1.5.6-py3-none-any.whl

Download URL	tahrir_api-1.5.6-py3-none-any.whl
Size	58.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`fb98e4c92cbd7049b34390407f4bfa4ab24fc1154d95ef0fb768bdd1f58176a8`
BLAKE2b-256 checksum How to use checksums	`1f2cbcc3e73926d31356cdc834a9340275afdd5edc0f92df0a5d1a9fba1b03ec`
Upload date	Aug 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/fedora-infra/tahrir-api
Publishing commit: github.com/fedora-infra/tahrir-api/tree/8773a0a9c57fd9c5c273332c55b6b5a2cc422acf

Workflow

Publishing configuration: github.com/fedora-infra/tahrir-api/blob/8773a0a9c57fd9c5c273332c55b6b5a2cc422acf/.github/workflows/main.yml
Publishing logs: github.com/fedora-infra/tahrir-api/actions/runs/32369850688/attempts/1

Artifact

Subject: tahrir_api-1.5.6-py3-none-any.whl
SHA-256 checksum: fb98e4c92cbd7049b34390407f4bfa4ab24fc1154d95ef0fb768bdd1f58176a8 Verifying attestations