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 OSBuild your virtual env
$ export WORKON_HOME=$HOME/.virtualenvs
$ mkvirtualenv tahrir-apiConnect w/ your virutal env
$ workon tahrir-api
(tahrir-api)$Install
Requirements
(tahrir-api)$ pip install -r requirements.txtProject installation
(tahrir-api)$ python setup.py developHappy hacking!
Run the tests
You can run the tests with tox
(tahrir-api)$ pip install tox
(tahrir-api)$ toxRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tahrir_api-1.0.0.tar.gz.
File metadata
- Download URL: tahrir_api-1.0.0.tar.gz
- Upload date:
- Size: 33.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.7.11-200.fc39.x86_64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f216d84f76e0855159a8845f4981da9dd662c5610eb303e2992d127d6569f515 |
|
| MD5 | 743851dba086d1f788bf24624d79e4bd |
|
| BLAKE2b-256 | fff0bbf743e5fb1d271c00780ec73afdcb216d6364b994ab103d881333345dc9 |
File details
Details for the file tahrir_api-1.0.0-py3-none-any.whl.
File metadata
- Download URL: tahrir_api-1.0.0-py3-none-any.whl
- Upload date:
- Size: 37.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.7.11-200.fc39.x86_64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3ebbbf9f46d9734a0517dd254fdc356ddcab23b590f7f1d8cc95eb6ef91e6b3d |
|
| MD5 | f1e1d5d396873b65c4bfc7f173fc9ce0 |
|
| BLAKE2b-256 | 52a08d8e7f85dd24190ce53ac33a4ec0881e384500b61dfd94faf174a1c75449 |
