Skip to main content

Provids easy access to German publically availible regional statistics

Project description

https://img.shields.io/pypi/v/datenguidepy.svg https://img.shields.io/travis/CorrelAid/datenguide-python.svg Documentation Status

The package provides easy access to German publicly available regional statistics. It does so by providing a wrapper for the GraphQL API of the Datenguide project.

Features

Overview of available statistics and regions:
The package provides DataFrames with the available statistics and regions, which can be queried by the user without having to refer to expert knowledge on regional statistics or the documentation of the underlying GraphQL API
Build and Execute Queries:
The package provides the user an object oriented interface to build queries that fetch certain statistics and return the results as a pandas DataFrame for further analysis.

Quick Start

Install

To use the package install the package (command line):

pip install datenguidepy

Setup query

Within your python file or notebook:
  1. Import the package

from datenguidepy.query_builder import Query

  1. Creating a query
  • either for single regions

query = Query.region('01')

  • or for all subregions a region (e.g. all Kommunen in a Bundeland)``

query_allregions = Query.allRegions(parent='01')

  1. Add statistics (fields)
    Add statistics you want to get data on (How do I find the short name of the statistics?(LINK))

query.add_field('BEV001')

  1. Add filters
    A field can also be added with filters. E.g. you can specify, that only data from a specific year shall be returned.

query.add_field('BEV001', args={year:'2017'})

  1. Add subfield
    A set of default subfields are defined for all statistics (year, value, source). If additional fields shall be returned, they can be specified as a field argument.

query.add_field('BEV001', field=['GES'])

  1. Get results
    Get the results as a Pandas DataFrame

df = query.results()

Get information on fields and meta data

TODO

Further information

For detailed examples see the notebooks in the use_case folder.

For a detailed documentation of all statistics and fields see the _Datenguide API.

Credits

All this builds on the great work of Datenguide and their GraphQL API datenguide/datenguide-api

The data is retrieved via the Datenguide API from the “Statistische Ämter des Bundes und der Länder”. Data being used via this package has to be credited according to the “Datenlizenz Deutschland – Namensnennung – Version 2.0”.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2019-10-07)

  • First release on PyPI.

0.1.1 (2019-10-09)

  • Cleanup of the first release regarding naming, authors and docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for datenguidepy, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size datenguidepy-0.1.1-py2.py3-none-any.whl (130.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size datenguidepy-0.1.1.tar.gz (142.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page