Move to subdirectory and add examples

Author: Stefan Oderbolz

README.md

@@ -0,0 +1,4 @@
+swissparlpy
+===========
+
+Inspired by the R package swissparl, this module provides easy access to the data of the webservice of the Swiss parliament.

examples/filter.py

@@ -0,0 +1,12 @@
+import swissparlpy as spp
+from pprint import pprint
+
+subjects = spp.get_data(
+    table="SubjectBusiness",
+    BusinessShortNumber="05.057",
+    Language="DE"
+)
+
+print(f"Total rows: {len(subjects)}")
+for subject in subjects:
+    pprint(subject)

examples/glimpse.py

@@ -0,0 +1,6 @@
+import swissparlpy
+
+glimpse = swissparlpy.get_glimpse("Canton", 10)
+for r in glimpse:
+    print(r)
+

examples/list_all_tables_and_properties.py

@@ -0,0 +1,10 @@
+import swissparlpy
+
+# print all tables with their properties
+
+overview = swissparlpy.get_overview()
+for table, props in overview.items():
+     print(table)
+     for prop in props:
+         print(f' + {prop}')
+     print('')

examples/slice.py

@@ -0,0 +1,10 @@
+import swissparlpy as spp
+from pprint import pprint
+
+subjects = spp.get_data(
+    table="Voting",
+)
+
+print(f"Total rows: {len(subjects)}")
+for subject in subjects[5:10]:
+    pprint(subject)

setup.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+from codecs import open
+from setuptools import setup, find_packages
+import re
+
+with open('swissparlpy/__init__.py', 'r') as fd:
+    version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
+                        fd.read(), re.MULTILINE).group(1)
+
+if not version:
+    raise RuntimeError('Cannot find version information')
+
+with open('README.md', 'r', encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name='swissparlpy',
+    packages=find_packages(),
+    version=version,
+    install_requires=['requests', 'pyodata'],
+    description='Client for Swiss parliament API',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author='Stefan Oderbolz',
+    author_email='odi@metaodi.ch',
+    maintainer='Stefan Oderbolz',
+    maintainer_email='odi@metaodi.ch',
+    url='https://github.com/metaodi/swissparlpy',
+    download_url='https://github.com/metaodi/swissparlpy/archive/v%s.zip' % version,
+    keywords=['api', 'swiss', 'switzerland', 'parliament', 'odata', 'swissparl'],
+    license='MIT',
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries',
+        'Development Status :: 4 - Beta',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+    ],
+    python_requires='>=3.6'
+)

swissparlpy/__init__.py

@@ -0,0 +1,25 @@
+__version__ = '0.0.1'
+__all__ = ['client', 'errors']
+
+from .errors import SwissParlError
+from .client import SwissParlClient
+
+def get_tables():
+    client = SwissParlClient()
+    return client.get_tables()
+
+def get_variables(table):
+    client = SwissParlClient()
+    return client.get_variables()
+
+def get_overview():
+    client = SwissParlClient()
+    return client.get_overview()
+
+def get_glimpse(table, rows=5):
+    client = SwissParlClient()
+    return client.get_glimpse(table, rows)
+
+def get_data(table, **kwargs):
+    client = SwissParlClient()
+    return client.get_data(table, **kwargs)

swissparlpy/client.py

@@ -0,0 +1,86 @@
+import requests
+import pyodata
+
+SERVICE_URL = 'https://ws.parlament.ch/odata.svc/'
+
+
+class SwissParlClient(object):
+    def __init__(self, session=None):
+        if not session:
+            session = requests.Session()
+        self.client = pyodata.Client(SERVICE_URL, session)
+        self.cache = {}
+        self.get_overview()
+
+    def get_tables(self):
+        if self.cache:
+            return self.cache.keys()
+        return [es.name for es in self.client.schema.entity_sets]
+
+    def get_variables(self, table):
+        if self.cache and table in self.cache:
+            return self.cache[table]
+        return [p.name for p in self.client.schema.entity_type(table).proprties()]
+
+    def get_overview(self):
+        if self.cache:
+            return self.cache
+        self.cache = {}
+        for t in self.get_tables():
+            self.cache[t] = self.get_variables(t)
+        return self.cache
+
+    def get_glimpse(self, table, rows=5):
+        entities = self._get_entities(table)
+        return SwissParlResponse(
+            entities.top(rows).count(inline=True),
+            self.get_variables(table)
+        )
+
+    def get_data(self, table, **kwargs):
+        entities = self._get_entities(table)
+        return SwissParlResponse(
+            entities.count(inline=True).filter(**kwargs),
+            self.get_variables(table)
+        )
+
+    def _get_entities(self, table):
+        return getattr(self.client.entity_sets, table).get_entities()
+
+
+class SwissParlResponse(object):
+    def __init__(self, entity_request, variables):
+        self.entities = entity_request.execute()
+        self.count = self.entities.total_count
+        self.variables = variables
+
+        self.data = []
+        self._setup_proxies()
+
+    
+    def _setup_proxies(self):
+        for e in self.entities:
+            row = {k: SwissParlDataProxy(e, k) for k in self.variables}
+            self.data.append(row)
+
+    def __len__(self):
+        return self.count
+
+    def __iter__(self):
+        for row in self.data:
+            yield {k: v() for k,v in row.items()}
+
+    def __getitem__(self, key):
+        items = self.data[key]
+        if isinstance(key, slice):
+             return [{k: v() for k,v in i.items()} for i in items]
+        return {k: v() for k,v in items.items()}
+
+
+class SwissParlDataProxy(object):
+    def __init__(self, proxy, attribute):
+        self.proxy = proxy
+        self.attribute = attribute
+
+    def __call__(self):
+        return getattr(self.proxy, self.attribute)

swissparlpy/errors.py

@@ -0,0 +1,4 @@
+class SwissParlError(Exception):
+    """
+    General SwissParl error class to provide a superclass for all other errors
+    """