python-qgenda 1.0.dev5

Logging In

You can login manually to test your credentials, but this library keeps the client authenticated automatically so you don’t need to worry about it after you know your credentials work.

import os

# tell configparser where to look for config
os.environ['QGENDA_CONF_FILE'] = '/path/to/qgenda.conf'
# optional
os.environ['QGENDA_CONF_REGION'] = 'name_of_region' # defaults to qgenda

from qgenda.api import client
client = client.QGendaClient()
client.authenticate()

Basics

Every method returns a Response object from the requests library, so it’s up to you to handle the json (or errors) that come out.

import json

odata_kwargs = {"$select": "StartDate,EndDate,StaffLName"}
api_response = client.get_schedule(start_date='2019-01-01',
odata_kwargs=odata_kwargs)
# the response is now in a dictionary for easy consumption
response_dict = json.loads(api_response.text)

print(json.dumps(response_dict[0], indent=4))

Output

{
    "StaffLName": "Holmes K",
    "EndDate": "2019-01-01T00:00:00",
    "StartDate": "2019-01-01T00:00:00"
}

Get Method Examples

Each of the get methods has optional OData parameters available, which allow you to sort, filter, or limit what data you are pulling from the API. These are different for each of the get methods, so you will want to check the official QGenda API docs for more details on that.

# odata is completely optional, but pretty useful.

odata_kwargs = {
"$select": "StartDate,EndDate,StaffLName",
"$orderby": "StartDate",
"$filter": "startswith(StaffLName, 'H')"
}
api_response = client.get_schedule(start_date='2019-01-01',
end_date='2019-01-14',
odata_kwargs=odata_kwargs)

response_dict = json.loads(api_response.text)
print(json.dumps(response_dict[:2], indent=4))

odata_kwargs = {
    '$select': 'Name,ID',
}
api_response = client.get_facility()
response_dict = json.loads(api_response.text)
# looks like there aren't any yet.
print(json.dumps(response_dict[:2], indent=4))

api_response = client.get_timeevent(start_date='2019-01-01')
response_dict = json.loads(api_response.text)
# looks like there aren't any yet.
print(json.dumps(response_dict[:2], indent=4))

api_response = client.get_dailycase(start_date='2019-01-01')
response_dict = json.loads(api_response.text)
# looks like there aren't any yet.
print(json.dumps(response_dict[:2], indent=4))

Redis

You need to install redis in your environment and run a redis server.

pip install redis

Config

[qgenda]
company_key = YOUR-COMPANY-KEY
username = API-USERNAME
password = API-PASSWORD
api_url = https://api.qgenda.com/
documentation = http://restapi.qgenda.com
api_version = v2
cache_backend = redis
cache_host = 127.0.0.1
cache_port = 6379
cache_lifetime = 600 ; in seconds
debug = 0

Memcached

You need to install python-memecached in your environment and run a memcached server.

pip install python-memcached

Config

[qgenda]
company_key = YOUR-COMPANY-KEY
username = API-USERNAME
password = API-PASSWORD
api_url = https://api.qgenda.com/
documentation = http://restapi.qgenda.com
api_version = v2
cache_backend = memcached
cache_host = 127.0.0.1
cache_port = 11211
cache_lifetime = 600 ; in seconds
debug = 0