Help Develop This: A read-only API for P2PU


Join community member Jose Flores in this volunteer effort to build a read-only API for P2PU.

Description: This project entails the creation of an Application Programming Interface (API) that will expose some of the information available in the P2PU platform to third party consumers. A web API can be described as a series of calls that a programmer can make from their own programs to fetch data from platforms such as Lernanta (the software on top of which P2PU runs) without having to access it through the main website. Some use cases have been discussed such as mobile phone apps or widgets that can be embedded in other websites in a ‘mash up’ style to show a list of courses, tasks and so on.

Skills required: A good understanding on how a Django application is laid out and a bit of research on tools to write APIs on top of Django. (I chose tastypie through recommendation from my local Python group).

Time commitment: A few weeks of spare time.

Goal: To have something up and running, at least in the alpha site, in the next couple of weeks. This would be the first step towards a full-blown API that allows not only reading but also writing. With a read-only API users could receive notifications of new comments or new courses in their phone, but to be able to reply to those messages or even create courses from a third party application we will need to develop a ‘read and write’ API.

Get started: https://github.com/p2pu/lernanta/wiki/API-development-process



Back to Blog home