[TOC]
Hi guys, in this blog post, I'll be demonstrating some basics on how to manage PopIt records with PopIt-Python. I'll be using the Sinar PopIt instance as the working example.
Note Since this is a Python specific topic. I'll assume most will know how to install remote
Pythonpackages. Else, read here.
Install PopIt-Python
pip install PopIt-PythonLet"s construct a PopIt-Python object. Your configuration will be stored here and throughout the tutorial we'll be using this object to call the PopIt API.
from popit_api import PopIt
api = PopIt(
instance="sinar-malaysia",
hostname="popit.mysociety.org",
api_version="v0.1",
api_key="yourapikeyhere",
)Now let"s proceed to our first record creation.
me = api.persons.post({"name": "Chow Chee Leong"})
print(me)The response
{
"result": {
"contact_details": [],
"html_url": "http://sinar-malaysia.popit.mysociety.org/persons/54c48c8fdde553347cbe01e3",
"id": "54c48c8fdde553347cbe01e3",
"identifiers": [],
"links": [],
"memberships": [],
"name": "Chow Chee Leong",
"other_names": [],
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/persons/54c48c8fdde553347cbe01e3"
}
}
my_id = me["result"]["id"]# this will be our working data
my_info = me["result"]
my_info["other_names"].append({"name": "motionman"})
my_info["contact_details"].append({
"label": "Email Address",
"type": "email",
"value": "[email protected]"
})
result = api.persons(my_id).put(my_info)
my_info = result["result"]
print(my_info){
"contact_details": [
{
"id": "54c48c90dde553347cbe01e5",
"label": "Email Address",
"type": "email",
"value": "[email protected]"
}
],
"html_url": "http://sinar-malaysia.popit.mysociety.org/persons/54c48c8fdde553347cbe01e3",
"id": "54c48c8fdde553347cbe01e3",
"identifiers": [],
"links": [],
"memberships": [],
"name": "Chow Chee Leong",
"other_names": [
{
"id": "54c48c90dde553347cbe01e4",
"name": "motionman"
}
],
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/persons/54c48c8fdde553347cbe01e3"
}The result Person page.
api.persons(my_id).delete()sinar = api.organizations.post({"name": "Sinar Project"})
sinar_id = sinar["result"]["id"]{
"result": {
"contact_details": [],
"html_url": "http://sinar-malaysia.popit.mysociety.org/organizations/54c48c90dde553347cbe01e6",
"id": "54c48c90dde553347cbe01e6",
"identifiers": [],
"links": [],
"memberships": [],
"name": "Sinar Project",
"other_names": [],
"posts": [],
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/organizations/54c48c90dde553347cbe01e6"
}
}sinar_info = sinar["result"]
sinar_info["contact_details"].append({
"label": "Email Address",
"type": "email",
"value": "[email protected]"
})
sinar_info["classification"] = "NGO"
result = api.organizations(sinar_id).put(sinar_info)
sinar_info = result["result"]
print(sinar_info){
"classification": "NGO",
"contact_details": [
{
"id": "54c48c90dde553347cbe01e7",
"label": "Email Address",
"type": "email",
"value": "[email protected]"
}
],
"html_url": "http://sinar-malaysia.popit.mysociety.org/organizations/54c48c90dde553347cbe01e6",
"id": "54c48c90dde553347cbe01e6",
"identifiers": [],
"links": [],
"memberships": [],
"name": "Sinar Project",
"other_names": [],
"posts": [],
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/organizations/54c48c90dde553347cbe01e6"
}api.organizations(sinar_id).delete()my_post = api.posts.post({
"label": "IT Department",
"organization_id": sinar_id,
})
print(my_post){
"result": {
"contact_details": [],
"html_url": "http://sinar-malaysia.popit.mysociety.org/posts/54c48c91dde553347cbe01e8",
"id": "54c48c91dde553347cbe01e8",
"label": "IT Department",
"links": [],
"memberships": [],
"organization_id": "54c48c90dde553347cbe01e6",
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/posts/54c48c91dde553347cbe01e8"
}
}api.posts(post_id).delete()my_membership = api.memberships.post({
"organization_id": sinar_id,
"post_id": post_id,
"person_id": my_id,
"role": "Software Developer",
"start_date": "2013-05-01",
"end_date": None,
})
print(my_membership){
"result": {
"contact_details": [],
"end_date": null,
"html_url": "http://sinar-malaysia.popit.mysociety.org/memberships/54c48c91dde553347cbe01e9",
"id": "54c48c91dde553347cbe01e9",
"links": [],
"organization_id": "54c48c90dde553347cbe01e6",
"person_id": "54c48c8fdde553347cbe01e3",
"post_id": "54c48c91dde553347cbe01e8",
"role": "Software Developer",
"start_date": "2013-05-01",
"url": "http://sinar-malaysia.popit.mysociety.org/api/v0.1/memberships/54c48c91dde553347cbe01e9"
}
}api.memberships(membership_id).delete()That concludes our brief introduction of data creation with PopIt-Python.
For the script with all the above examples, check out examples.py. However there are some changes
- Uses Python logging module instead of
print. - Outputs are pretty-printed with pprint.
- Simple exception handling.
- For an empty field, empty string
""is not accepted. Make sure to check and convert them tonull(or in PythonNone) - The Python SDK is developed with slumber, it"s a smart decision because it maps the RESTful API as it changes instead of hardcoding.
- Failed API calls throw exception, make sure they're captured to avoid interrupting your program.