PyPeri¶
PyPeri makes getting data out of Periscope easy, with a sane and understandable API.
- Free software: MIT license
- Documentation: https://pyperi.readthedocs.io.
Features¶
- Python 3
- Easy to understand API
- Fully tested & documented
Functionality so far:
- Get information about Users
- Get information about Broadcasts
- Get a User’s Broadcast history
About¶
Periscope is pretty neat, but it’s difficult to get information out of it in a programatic way. Getting answers to simple questions like: “How many broadcasts did our client do this week” is not trivial, and in-depth analysis is pretty tough. This project is an attempt to make the lives of people who dip into Digital Marketing a little better.
PyPeri attempts to do this by providing a sane interface, and hides some of the tedium of using Periscope’s API. For example, Periscope makes doing simple things, like getting a list of a User’s past Broadcasts a 2-step process:
- Request a short-lived API session key from the Periscope Web Interface
- Use the session key on the Periscope API Interface using the getUserBroadcastsPublic endpoint.
PyPeri simplifies this considerably:
>>> from pyperi import Peri
>>> pp = Peri()
>>> history = pp.get_user_broadcast_history(username='george_clinton')
Quick start¶
Install via pip:
$ pip install pyperi
Do stuff:
>>> from pyperi import Peri
>>> pp = Peri()
>>> history = pp.get_user_broadcast_history(username='george_clinton')
>>> if history:
... print(history[0]['status'])
#George Clinton listening to music in houston
Full documentation is available here: https://pyperi.readthedocs.io
License¶
PyPeri is free software, distributed under the MIT license.