Skip to content

Latest commit

 

History

History
167 lines (130 loc) · 7.95 KB

README.md

File metadata and controls

167 lines (130 loc) · 7.95 KB

destatis

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bundesAPI/deutschland.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bundesAPI/deutschland.git)

Then import the package:

from deutschland import destatis

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

from deutschland import destatis

Getting Started

Please follow the installation procedure and then run the following:

import time
from deutschland import destatis
from pprint import pprint
from deutschland.destatis.api import default_api
# Defining the host is optional and defaults to https://www-genesis.destatis.de/genesisWS/rest/2020
# See configuration.py for a list of all supported configuration parameters.
configuration = destatis.Configuration(
    host = "https://www-genesis.destatis.de/genesisWS/rest/2020"
)



# Enter a context with an instance of the API client
with destatis.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    username = "GAST" # str |  (optional) (default to "GAST")
password = "GAST" # str |  (optional) (default to "GAST")
name = "name_example" # str |  (optional)
area = "free" # str |  (optional) (default to "free")
charttype = "0" # str |  (optional) (default to "0")
drawpoints = "false" # str |  (optional) (default to "false")
zoom = "2" # str |  (optional) (default to "2")
focus = "false" # str |  (optional) (default to "false")
tops = "false" # str |  (optional) (default to "false")
format = "png" # str |  (optional) (default to "png")
language = "de" # str |  (optional) (default to "de")

    try:
        api_instance.chart2result(username=username, password=password, name=name, area=area, charttype=charttype, drawpoints=drawpoints, zoom=zoom, focus=focus, tops=tops, format=format, language=language)
    except destatis.ApiException as e:
        print("Exception when calling DefaultApi->chart2result: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://www-genesis.destatis.de/genesisWS/rest/2020

Class Method HTTP request Description
DefaultApi chart2result GET /data/chart2result
DefaultApi chart2table GET /data/chart2table
DefaultApi chart2timeseries GET /data/chart2timeseries
DefaultApi cube GET /data/cube
DefaultApi cube_meta GET /metadata/cube
DefaultApi cubefile GET /data/cubefile
DefaultApi cubes GET /catalogue/cubes
DefaultApi cubes2statistic GET /catalogue/cubes2statistic
DefaultApi cubes2variable GET /catalogue/cubes2variable
DefaultApi find GET /find/find
DefaultApi jobs GET /catalogue/jobs
DefaultApi logincheck GET /helloworld/logincheck
DefaultApi map2result GET /data/map2result
DefaultApi map2table GET /data/map2table
DefaultApi map2timeseries GET /data/map2timeseries
DefaultApi modifieddata GET /catalogue/modifieddata
DefaultApi password GET /profile/password
DefaultApi qualitysigns GET /catalogue/qualitysigns
DefaultApi remove_result GET /profile/removeResult
DefaultApi result GET /data/result
DefaultApi resultfile GET /data/resultfile
DefaultApi results GET /catalogue/results
DefaultApi statistic GET /metadata/statistic
DefaultApi statistics GET /catalogue/statistics
DefaultApi statistics2variable GET /catalogue/statistics2variable
DefaultApi table GET /data/table
DefaultApi table_meta GET /metadata/table
DefaultApi tablefile GET /data/tablefile
DefaultApi tables GET /catalogue/tables
DefaultApi tables2statistic GET /catalogue/tables2statistic
DefaultApi tables2variable GET /catalogue/tables2variable
DefaultApi terms GET /catalogue/terms
DefaultApi timeseries GET /catalogue/timeseries
DefaultApi timeseries2statistic GET /catalogue/timeseries2statistic
DefaultApi timeseries2variable GET /catalogue/timeseries2variable
DefaultApi timeseries_data GET /data/timeseries
DefaultApi timeseries_meta GET /metadata/timeseries
DefaultApi timeseriesfile GET /data/timeseriesfile
DefaultApi value GET /metadata/value
DefaultApi values GET /catalogue/values
DefaultApi values2variable GET /catalogue/values2variable
DefaultApi variable GET /metadata/variable
DefaultApi variables GET /catalogue/variables
DefaultApi variables2statistic GET /catalogue/variables2statistic
DefaultApi whoami GET /helloworld/whoami

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in destatis.apis and destatis.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from deutschland.destatis.api.default_api import DefaultApi
  • from deutschland.destatis.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
from deutschland import destatis
from deutschland.destatis.apis import *
from deutschland.destatis.models import *