datenguidepy 0.1.1

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

2. 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')

3. 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')

4. 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'})

5. 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'])

6. 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.

History