pypresseportal 0.1

Installing with pip

Use pip on a command line to download PyPresseportal from PyPI and install it on your system:

$ pip install pypresseportal

Getting an API key

PyPresseportal requires a valid API key from https://api.presseportal.de/en. This website is also where you can find general information on the API as well as the API’s Terms.

Initializing the API

First, create an instance of the PresseportalApi class, using your API key:

>>> from pypresseportal import PresseportalApi
>>> api_object = PresseportalApi(YOUR_API_KEY)

Requesting data

Next, request data from the API through the PresseportalApi class. It contains several methods to access API data, all of which work very similarly.

The easiest way to access the most recently published stories is the get_stories() method. If you do not provide any arguments to this method, PyPresseportal defaults to retrieving the 50 most recent stories available.

For example:

>>> from pypresseportal import PresseportalApi
>>> api_object = PresseportalApi(YOUR_API_KEY)
>>> stories = api_object.get_stories()

get_stories() returns a list of Story objects. Access Story data through the individual Story object’s attributes.

For example:

>>> stories[0].title
"Kohls Wohnhaus hat keinen Denkmalwert"
>>> stories[0].id
"4622388"