tahrir-api

An API for interacting with the Tahrir database

These details have not been verified by PyPI

Project links

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

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

1.4.0

Jul 27, 2024

1.3.0

Jul 25, 2024

1.2.0

Jul 10, 2024

1.1.5

Jun 20, 2024

1.1.4

Jun 11, 2024

1.1.3

May 30, 2024

1.1.2

May 22, 2024

1.1.1

May 19, 2024

1.1.0

May 18, 2024

1.0.0

Apr 16, 2024

0.8.1

Nov 1, 2016

0.8.0

Sep 20, 2016

0.7.2

Dec 4, 2014

0.7.0

Jul 14, 2014

0.6.1

May 15, 2014

0.6.0

Mar 4, 2014

0.5.1

Feb 24, 2014

0.5.0

Dec 17, 2013

0.4.2

Nov 18, 2013

0.4.1

Nov 18, 2013

0.4.0

Oct 25, 2013

0.3.0

Aug 26, 2013

0.2.8

Jul 30, 2013

0.2.7

Jul 17, 2013

0.2.6

Jul 16, 2013

0.2.5

Jul 10, 2013

0.2.4

Jul 3, 2013

0.2.3

Jun 26, 2013

0.2.2

Jun 23, 2013

0.2.1

Jun 23, 2013

0.2.0

Jun 20, 2013

0.1.8

Jun 6, 2013

0.1.7

Jul 23, 2012

0.1.6

Jul 17, 2012

0.1.5

Jul 17, 2012

0.1.4

Jul 12, 2012

0.1.3.6

Jul 11, 2012

0.1.3.5

Jul 10, 2012

0.1.3.4

Jun 18, 2012

0.1.3.3

Jun 18, 2012

0.1.3.2

Jun 18, 2012

0.1.3.1

Jun 11, 2012

0.1.3

Jun 11, 2012

0.1.2

Jun 11, 2012

0.1.1

Jun 11, 2012

0.1.0

Jun 11, 2012

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.0.tar.gz (34.1 kB view details)

Uploaded Jul 27, 2024 Source

Built Distribution

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

Uploaded Jul 27, 2024 Python 3

File details

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

File metadata

Download URL: tahrir_api-1.4.0.tar.gz
Upload date: Jul 27, 2024
Size: 34.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for tahrir_api-1.4.0.tar.gz
Algorithm	Hash digest
SHA256	`2e309b03d4f8163575240df1033de244f03407ae6280d052ae034ce786933630`
MD5	`c7ba12f9e0228520b3fea45cb77bebfd`
BLAKE2b-256	`b5e13cfc2c1de66654aeb5ad7b6a87ab9aa9ad455f7e5ffe64c8f59b1a7aada5`

See more details on using hashes here.

File details

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

File metadata

Download URL: tahrir_api-1.4.0-py3-none-any.whl
Upload date: Jul 27, 2024
Size: 40.1 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for tahrir_api-1.4.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`7332a39eb77594a998b39ceb3a0804d9e2df559be83e3ff82c989ace339a6ba7`
MD5	`b215a8a40bd15ee3932b0d533660df5a`
BLAKE2b-256	`ffca66146e2b43ae3fe64170fc4b37a22a8aad1dfd0a775a369f16416ded6db5`