Skip to main content
Latest PyPI version Travis CI build status

niaopendata is a Python client library for accessing the Northern Ireland Assembly Open Data API. niaopendata has a full test suite and aims to have 100% coverage of the API. Tests exist both to ensure that the library is working as expected, and also that the library complies with and fully implements the API specification.

niaopendata supports Python 2.6, 2.7, PyPy, 3.3 and 3.4 (and probably later versions too, but I haven’t tested on those).

Installation

Distribute & Pip

Installing niaopendata is simple with pip:

$ pip install niaopendata

or, with easy_install:

$ easy_install niaopendata

But, you really shouldn’t do that.

Get the Code

niaopendata is actively developed on GitHub, where the code is always available.

You can either clone the public repository:

$ git clone git://github.com/paddycarey/niaopendata.git

Or download the tarball:

$ curl -OL https://github.com/paddycarey/niaopendata/tarball/master

Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily:

$ python setup.py install

Usage

niaopendata aims to provide a simple, pythonic interface to Northern Ireland Assembly Open Data API. It has been designed to be easy to use, and aims to provide full coverage of the API with a consistent interface.

First you’ll need to import niaopendata.:

import niaopendata

Retrieving data from the API

As an example of what is possible, it is easy to retrieve a list of all members.:

>>> niaopendata.all_current_members()
[
    OrderedDict([
        (u'PersonId', u'307'),
        (u'AffiliationId', u'2482'),
        (u'MemberName', u'Agnew, Steven'),
        (u'MemberLastName', u'Agnew'),
        (u'MemberFirstName', u'Steven'),
        (u'MemberFullDisplayName', u'Mr S Agnew'),
        (u'MemberSortName', u'AgnewSteven'),
        (u'MemberTitle', u'MLA - North Down'),
        (u'PartyName', u'Green Party'),
        (u'PartyOrganisationId', u'111'),
        (u'ConstituencyName', u'North Down'),
        (u'ConstituencyId', u'11'),
        (u'MemberImgUrl', u'http://aims.niassembly.gov.uk/images/mla/307_s.jpg'),
        (u'MemberPrefix', u'Mr')
    ]),
    ...
]

>>> len(niaopendata.all_current_members())
107

Full API documentation

Full documentation is a work in progress, but the code itself should be easy to follow. All public functions are explicitly imported in __init__.py and all functions have appropriate docstrings.

Testing

niaopendata has a full test suite. Assuming you have a full source checkout of the niaopendata repository, running the tests is simple with tox:

$ pip install tox
$ tox

It is recommended that you use a virtualenv when developing or running the tests to ensure that system libraries do not interfere with the tests.

TIP: If you’re using Ubuntu, you can find older/newer versions of python than the one shipped with your distribution here. You can install as many as you like side by side without affecting your default python install.

Release files for niaopendata 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for niaopendata 0.0.1
File Size Uploaded
niaopendata-0.0.1.tar.gz 6.3 kB Details

Release files / niaopendata-0.0.1.tar.gz

Download URL niaopendata-0.0.1.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5dd9138bf7a779dab76ddd5e6339966e103cfa9ac5bfa0611f019896aa84e5e1
BLAKE2b-256 checksum
How to use checksums
2b3486b44abfcebc55eeddd4acba4f92276775c768a81a865eaa99ce609445a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page