de-destatis


Namede-destatis JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/bundesAPI/destatis-api
SummaryDestatis-API
upload_time2023-06-20 22:46:43
maintainer
docs_urlNone
authorBundesAPI
requires_python>=3.6
licenseApache-2.0
keywords openapi openapi-generator destatis app api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # destatis
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

```sh
pip install deutschland[destatis]
```

### poetry install

```sh
poetry add deutschland -E destatis
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

## Usage

Import the package:
```python
from deutschland import destatis
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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**](docs/DefaultApi.md#chart2result) | **GET** /data/chart2result | 
*DefaultApi* | [**chart2table**](docs/DefaultApi.md#chart2table) | **GET** /data/chart2table | 
*DefaultApi* | [**chart2timeseries**](docs/DefaultApi.md#chart2timeseries) | **GET** /data/chart2timeseries | 
*DefaultApi* | [**cube**](docs/DefaultApi.md#cube) | **GET** /data/cube | 
*DefaultApi* | [**cube_meta**](docs/DefaultApi.md#cube_meta) | **GET** /metadata/cube | 
*DefaultApi* | [**cubefile**](docs/DefaultApi.md#cubefile) | **GET** /data/cubefile | 
*DefaultApi* | [**cubes**](docs/DefaultApi.md#cubes) | **GET** /catalogue/cubes | 
*DefaultApi* | [**cubes2statistic**](docs/DefaultApi.md#cubes2statistic) | **GET** /catalogue/cubes2statistic | 
*DefaultApi* | [**cubes2variable**](docs/DefaultApi.md#cubes2variable) | **GET** /catalogue/cubes2variable | 
*DefaultApi* | [**find**](docs/DefaultApi.md#find) | **GET** /find/find | 
*DefaultApi* | [**jobs**](docs/DefaultApi.md#jobs) | **GET** /catalogue/jobs | 
*DefaultApi* | [**logincheck**](docs/DefaultApi.md#logincheck) | **GET** /helloworld/logincheck | 
*DefaultApi* | [**map2result**](docs/DefaultApi.md#map2result) | **GET** /data/map2result | 
*DefaultApi* | [**map2table**](docs/DefaultApi.md#map2table) | **GET** /data/map2table | 
*DefaultApi* | [**map2timeseries**](docs/DefaultApi.md#map2timeseries) | **GET** /data/map2timeseries | 
*DefaultApi* | [**modifieddata**](docs/DefaultApi.md#modifieddata) | **GET** /catalogue/modifieddata | 
*DefaultApi* | [**password**](docs/DefaultApi.md#password) | **GET** /profile/password | 
*DefaultApi* | [**qualitysigns**](docs/DefaultApi.md#qualitysigns) | **GET** /catalogue/qualitysigns | 
*DefaultApi* | [**remove_result**](docs/DefaultApi.md#remove_result) | **GET** /profile/removeResult | 
*DefaultApi* | [**result**](docs/DefaultApi.md#result) | **GET** /data/result | 
*DefaultApi* | [**resultfile**](docs/DefaultApi.md#resultfile) | **GET** /data/resultfile | 
*DefaultApi* | [**results**](docs/DefaultApi.md#results) | **GET** /catalogue/results | 
*DefaultApi* | [**statistic**](docs/DefaultApi.md#statistic) | **GET** /metadata/statistic | 
*DefaultApi* | [**statistics**](docs/DefaultApi.md#statistics) | **GET** /catalogue/statistics | 
*DefaultApi* | [**statistics2variable**](docs/DefaultApi.md#statistics2variable) | **GET** /catalogue/statistics2variable | 
*DefaultApi* | [**table**](docs/DefaultApi.md#table) | **GET** /data/table | 
*DefaultApi* | [**table_meta**](docs/DefaultApi.md#table_meta) | **GET** /metadata/table | 
*DefaultApi* | [**tablefile**](docs/DefaultApi.md#tablefile) | **GET** /data/tablefile | 
*DefaultApi* | [**tables**](docs/DefaultApi.md#tables) | **GET** /catalogue/tables | 
*DefaultApi* | [**tables2statistic**](docs/DefaultApi.md#tables2statistic) | **GET** /catalogue/tables2statistic | 
*DefaultApi* | [**tables2variable**](docs/DefaultApi.md#tables2variable) | **GET** /catalogue/tables2variable | 
*DefaultApi* | [**terms**](docs/DefaultApi.md#terms) | **GET** /catalogue/terms | 
*DefaultApi* | [**timeseries**](docs/DefaultApi.md#timeseries) | **GET** /catalogue/timeseries | 
*DefaultApi* | [**timeseries2statistic**](docs/DefaultApi.md#timeseries2statistic) | **GET** /catalogue/timeseries2statistic | 
*DefaultApi* | [**timeseries2variable**](docs/DefaultApi.md#timeseries2variable) | **GET** /catalogue/timeseries2variable | 
*DefaultApi* | [**timeseries_data**](docs/DefaultApi.md#timeseries_data) | **GET** /data/timeseries | 
*DefaultApi* | [**timeseries_meta**](docs/DefaultApi.md#timeseries_meta) | **GET** /metadata/timeseries | 
*DefaultApi* | [**timeseriesfile**](docs/DefaultApi.md#timeseriesfile) | **GET** /data/timeseriesfile | 
*DefaultApi* | [**value**](docs/DefaultApi.md#value) | **GET** /metadata/value | 
*DefaultApi* | [**values**](docs/DefaultApi.md#values) | **GET** /catalogue/values | 
*DefaultApi* | [**values2variable**](docs/DefaultApi.md#values2variable) | **GET** /catalogue/values2variable | 
*DefaultApi* | [**variable**](docs/DefaultApi.md#variable) | **GET** /metadata/variable | 
*DefaultApi* | [**variables**](docs/DefaultApi.md#variables) | **GET** /catalogue/variables | 
*DefaultApi* | [**variables2statistic**](docs/DefaultApi.md#variables2statistic) | **GET** /catalogue/variables2statistic | 
*DefaultApi* | [**whoami**](docs/DefaultApi.md#whoami) | **GET** /helloworld/whoami | 


## Documentation For Models



## Documentation For Authorization

 All endpoints do not require authorization.

## Author

kontakt@bund.dev


## 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 *
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bundesAPI/destatis-api",
    "name": "de-destatis",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "OpenAPI,OpenAPI-Generator,destatis,App,API",
    "author": "BundesAPI",
    "author_email": "kontakt@bund.dev",
    "download_url": "https://files.pythonhosted.org/packages/26/98/b721fd8903488b09e1d44e1092dd103c7ef5b6fad4593f9dbead701bab29/de_destatis-0.1.0.tar.gz",
    "platform": null,
    "description": "# destatis\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 0.1.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\n```sh\npip install deutschland[destatis]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E destatis\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\n## Usage\n\nImport the package:\n```python\nfrom deutschland import destatis\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nfrom deutschland import destatis\nfrom pprint import pprint\nfrom deutschland.destatis.api import default_api\n# Defining the host is optional and defaults to https://www-genesis.destatis.de/genesisWS/rest/2020\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = destatis.Configuration(\n    host = \"https://www-genesis.destatis.de/genesisWS/rest/2020\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith destatis.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = default_api.DefaultApi(api_client)\n    username = \"GAST\" # str |  (optional) (default to \"GAST\")\n    password = \"GAST\" # str |  (optional) (default to \"GAST\")\n    name = \"name_example\" # str |  (optional)\n    area = \"free\" # str |  (optional) (default to \"free\")\n    charttype = \"0\" # str |  (optional) (default to \"0\")\n    drawpoints = \"false\" # str |  (optional) (default to \"false\")\n    zoom = \"2\" # str |  (optional) (default to \"2\")\n    focus = \"false\" # str |  (optional) (default to \"false\")\n    tops = \"false\" # str |  (optional) (default to \"false\")\n    format = \"png\" # str |  (optional) (default to \"png\")\n    language = \"de\" # str |  (optional) (default to \"de\")\n\n    try:\n        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)\n    except destatis.ApiException as e:\n        print(\"Exception when calling DefaultApi->chart2result: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://www-genesis.destatis.de/genesisWS/rest/2020*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**chart2result**](docs/DefaultApi.md#chart2result) | **GET** /data/chart2result | \n*DefaultApi* | [**chart2table**](docs/DefaultApi.md#chart2table) | **GET** /data/chart2table | \n*DefaultApi* | [**chart2timeseries**](docs/DefaultApi.md#chart2timeseries) | **GET** /data/chart2timeseries | \n*DefaultApi* | [**cube**](docs/DefaultApi.md#cube) | **GET** /data/cube | \n*DefaultApi* | [**cube_meta**](docs/DefaultApi.md#cube_meta) | **GET** /metadata/cube | \n*DefaultApi* | [**cubefile**](docs/DefaultApi.md#cubefile) | **GET** /data/cubefile | \n*DefaultApi* | [**cubes**](docs/DefaultApi.md#cubes) | **GET** /catalogue/cubes | \n*DefaultApi* | [**cubes2statistic**](docs/DefaultApi.md#cubes2statistic) | **GET** /catalogue/cubes2statistic | \n*DefaultApi* | [**cubes2variable**](docs/DefaultApi.md#cubes2variable) | **GET** /catalogue/cubes2variable | \n*DefaultApi* | [**find**](docs/DefaultApi.md#find) | **GET** /find/find | \n*DefaultApi* | [**jobs**](docs/DefaultApi.md#jobs) | **GET** /catalogue/jobs | \n*DefaultApi* | [**logincheck**](docs/DefaultApi.md#logincheck) | **GET** /helloworld/logincheck | \n*DefaultApi* | [**map2result**](docs/DefaultApi.md#map2result) | **GET** /data/map2result | \n*DefaultApi* | [**map2table**](docs/DefaultApi.md#map2table) | **GET** /data/map2table | \n*DefaultApi* | [**map2timeseries**](docs/DefaultApi.md#map2timeseries) | **GET** /data/map2timeseries | \n*DefaultApi* | [**modifieddata**](docs/DefaultApi.md#modifieddata) | **GET** /catalogue/modifieddata | \n*DefaultApi* | [**password**](docs/DefaultApi.md#password) | **GET** /profile/password | \n*DefaultApi* | [**qualitysigns**](docs/DefaultApi.md#qualitysigns) | **GET** /catalogue/qualitysigns | \n*DefaultApi* | [**remove_result**](docs/DefaultApi.md#remove_result) | **GET** /profile/removeResult | \n*DefaultApi* | [**result**](docs/DefaultApi.md#result) | **GET** /data/result | \n*DefaultApi* | [**resultfile**](docs/DefaultApi.md#resultfile) | **GET** /data/resultfile | \n*DefaultApi* | [**results**](docs/DefaultApi.md#results) | **GET** /catalogue/results | \n*DefaultApi* | [**statistic**](docs/DefaultApi.md#statistic) | **GET** /metadata/statistic | \n*DefaultApi* | [**statistics**](docs/DefaultApi.md#statistics) | **GET** /catalogue/statistics | \n*DefaultApi* | [**statistics2variable**](docs/DefaultApi.md#statistics2variable) | **GET** /catalogue/statistics2variable | \n*DefaultApi* | [**table**](docs/DefaultApi.md#table) | **GET** /data/table | \n*DefaultApi* | [**table_meta**](docs/DefaultApi.md#table_meta) | **GET** /metadata/table | \n*DefaultApi* | [**tablefile**](docs/DefaultApi.md#tablefile) | **GET** /data/tablefile | \n*DefaultApi* | [**tables**](docs/DefaultApi.md#tables) | **GET** /catalogue/tables | \n*DefaultApi* | [**tables2statistic**](docs/DefaultApi.md#tables2statistic) | **GET** /catalogue/tables2statistic | \n*DefaultApi* | [**tables2variable**](docs/DefaultApi.md#tables2variable) | **GET** /catalogue/tables2variable | \n*DefaultApi* | [**terms**](docs/DefaultApi.md#terms) | **GET** /catalogue/terms | \n*DefaultApi* | [**timeseries**](docs/DefaultApi.md#timeseries) | **GET** /catalogue/timeseries | \n*DefaultApi* | [**timeseries2statistic**](docs/DefaultApi.md#timeseries2statistic) | **GET** /catalogue/timeseries2statistic | \n*DefaultApi* | [**timeseries2variable**](docs/DefaultApi.md#timeseries2variable) | **GET** /catalogue/timeseries2variable | \n*DefaultApi* | [**timeseries_data**](docs/DefaultApi.md#timeseries_data) | **GET** /data/timeseries | \n*DefaultApi* | [**timeseries_meta**](docs/DefaultApi.md#timeseries_meta) | **GET** /metadata/timeseries | \n*DefaultApi* | [**timeseriesfile**](docs/DefaultApi.md#timeseriesfile) | **GET** /data/timeseriesfile | \n*DefaultApi* | [**value**](docs/DefaultApi.md#value) | **GET** /metadata/value | \n*DefaultApi* | [**values**](docs/DefaultApi.md#values) | **GET** /catalogue/values | \n*DefaultApi* | [**values2variable**](docs/DefaultApi.md#values2variable) | **GET** /catalogue/values2variable | \n*DefaultApi* | [**variable**](docs/DefaultApi.md#variable) | **GET** /metadata/variable | \n*DefaultApi* | [**variables**](docs/DefaultApi.md#variables) | **GET** /catalogue/variables | \n*DefaultApi* | [**variables2statistic**](docs/DefaultApi.md#variables2statistic) | **GET** /catalogue/variables2statistic | \n*DefaultApi* | [**whoami**](docs/DefaultApi.md#whoami) | **GET** /helloworld/whoami | \n\n\n## Documentation For Models\n\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\nkontakt@bund.dev\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in destatis.apis and destatis.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from deutschland.destatis.api.default_api import DefaultApi`\n- `from deutschland.destatis.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nfrom deutschland import destatis\nfrom deutschland.destatis.apis import *\nfrom deutschland.destatis.models import *\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Destatis-API",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bundesAPI/destatis-api/issues",
        "Homepage": "https://github.com/bundesAPI/destatis-api"
    },
    "split_keywords": [
        "openapi",
        "openapi-generator",
        "destatis",
        "app",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a7cac975bc52f918c023d4391032d81c5def9f0ef60e29e124653fef799deef9",
                "md5": "dfae5a20a6c577ebd3f9c88e80766f0e",
                "sha256": "f69024a8dbcbed58dcf63f7f1d0f18d5a12eed81b35657975e34131f9c618f9d"
            },
            "downloads": -1,
            "filename": "de_destatis-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dfae5a20a6c577ebd3f9c88e80766f0e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 46915,
            "upload_time": "2023-06-20T22:46:41",
            "upload_time_iso_8601": "2023-06-20T22:46:41.296579Z",
            "url": "https://files.pythonhosted.org/packages/a7/ca/c975bc52f918c023d4391032d81c5def9f0ef60e29e124653fef799deef9/de_destatis-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2698b721fd8903488b09e1d44e1092dd103c7ef5b6fad4593f9dbead701bab29",
                "md5": "a908077fba511ea1e9353a197e14df22",
                "sha256": "4637d489b72b2ea198b03a4cb10148dde316c0a999e72f43917da2943a3429d8"
            },
            "downloads": -1,
            "filename": "de_destatis-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a908077fba511ea1e9353a197e14df22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 44580,
            "upload_time": "2023-06-20T22:46:43",
            "upload_time_iso_8601": "2023-06-20T22:46:43.057407Z",
            "url": "https://files.pythonhosted.org/packages/26/98/b721fd8903488b09e1d44e1092dd103c7ef5b6fad4593f9dbead701bab29/de_destatis-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-20 22:46:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bundesAPI",
    "github_project": "destatis-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "de-destatis"
}
        
Elapsed time: 0.08166s