Skip to main content

An API for interacting with the Tahrir database

Project description

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.

Creating a Badge

This is an example of creating a badge via Tahrir-API:

from tahrir_api.dbapi import TahrirDatabase


db = TahrirDatabase('backend://badges:badgesareawesome@localhost/badges')

origin = 'http://foss.rit.edu/badges'
issuer_name = 'FOSS@RIT'
org = 'http://foss.rit.edu'
contact = 'foss@rit.edu'

issuer_id = db.add_issuer(origin, issuer_name, org, contact)

badge_name = 'fossbox'
image = 'http://foss.rit.edu/files/fossboxbadge.png'
desc = 'Welcome to the FOSSBox. A member is you!'
criteria = 'http://foss.rit.edu'

db.add_badge(badge_name, image, desc, criteria, issuer_id)

Awarding a Badge

This is an example of awarding a badge via Tahrir-API:

from tahrir_api.dbapi import TahrirDatabase


db = TahrirDatabase('backend://badges:badgesareawesome@localhost/badges')

badge_id = 'fossbox'
person_email = 'person@email.com'
issued_on = None

db.add_person(person_email)
db.add_assertion(badge_id, person_email, issued_on)

Development

Set-up your env

Install helper

$ sudo dnf install -y python3-virtualenvwrapper  # RedHat-based OS

Build your virtual env

$ export WORKON_HOME=$HOME/.virtualenvs
$ mkvirtualenv tahrir-api

Connect w/ your virutal env

$ workon tahrir-api
(tahrir-api)$

Install

Requirements

(tahrir-api)$ pip install -r requirements.txt

Project installation

(tahrir-api)$ python setup.py develop

Happy hacking!

Run the tests

You can run the tests with tox

(tahrir-api)$ pip install tox
(tahrir-api)$ tox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tahrir_api-1.4.1.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

tahrir_api-1.4.1-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

Details for the file tahrir_api-1.4.1.tar.gz.

File metadata

  • Download URL: tahrir_api-1.4.1.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tahrir_api-1.4.1.tar.gz
Algorithm Hash digest
SHA256 68aac0c4795216985a91989f8cdcd3c054faa1fe6ea41dae28a9ec4c2792ffae
MD5 a355a50398f7469a1702707d90595de7
BLAKE2b-256 34ad7805978a627848c293e6c7387ca2f5bd97e30497c261a09b68125f3a7a3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tahrir_api-1.4.1.tar.gz:

Publisher: main.yml on fedora-infra/tahrir-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tahrir_api-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: tahrir_api-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 40.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tahrir_api-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 770fff53b7a457022e2d0617602c79abe5d2f5da128e77c848f05ec02901a252
MD5 6938f3e977df5db30b2475f0d0741ab9
BLAKE2b-256 52adaf8cf236f7deeaba38f208b443757b4a17cfb48c65c2408471a3c6227744

See more details on using hashes here.

Provenance

The following attestation bundles were made for tahrir_api-1.4.1-py3-none-any.whl:

Publisher: main.yml on fedora-infra/tahrir-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page