This package provides tools for easily retrieving information from an OParl server. OParl is a standard interface for publishing information about parliaments and their work.
We recommend to install the library in a virtualenv:
virtualenv venv
source venv/bin/activate
Then:
pip install -e git+https://github.com/stadt-karlsruhe/python-oparl#egg=oparl
Currently, Python 2.7, 3.3, 3.4 and 3.5 are supported.
The main tool of the library is the Object class and its subclasses. They
provide wrappers for the various OParl classes (Body, Person, ...) and
support lazy loading and automatic conversion of OParl data types (e.g.
date-time) to Python types (datetime.datetime).
You will typically start by loading a single object from an OParl server
using the from_id function:
import oparl
system = oparl.from_id('https://politik-bei-uns.de/oparl')
If you've already got OParl JSON data you can also use from_json.
Instances of Object and its subclasses support a read-only dict-interface:
for body in system['body']:
print(body['name'])
This library tries to be as compatible with OParl 1.0 as possible but does not
enforce strict compliance. In some cases non-compliant server behavior that has
been seen "in the wild" is supported. These cases trigger a
SpecificationWarning. If invalid values are encountered during
auto-conversion (e.g. illegal date strings) then a ContentWarning is issued
and conversion is skipped.
By default, HTTPS certificates are verified. You can disable that verification
by setting VERIFY_HTTPS to False.
The library's logger (log) doesn't have a handler attached to it by default,
but may come in handy during development.
First make sure that you have the necessary tools installed:
pip install -r dev-requirements.txt
To run the tests, execute
tox
Copyright (c) 2016, Stadt Karlsruhe (www.karlsruhe.de)
Distributed under the MIT license, see the file LICENSE for details.
- Fixed a bug in the handling of unknown types
- Made parsing more robust and warning messages more informative
- First public release