|
| 1 | +# mudab |
| 2 | +Meeres-Monitoringdaten von Küstenbundesländern und Forschungseinrichtungen |
| 3 | + |
| 4 | + |
| 5 | +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 6 | + |
| 7 | +- API version: 1.0.0 |
| 8 | +- Package version: 0.1.0 |
| 9 | +- Build package: org.openapitools.codegen.languages.PythonClientCodegen |
| 10 | + |
| 11 | +## Requirements. |
| 12 | + |
| 13 | +Python >= 3.6 |
| 14 | + |
| 15 | +## Installation & Usage |
| 16 | +### pip install |
| 17 | + |
| 18 | +```sh |
| 19 | +pip install deutschland[mudab] |
| 20 | +``` |
| 21 | + |
| 22 | +### poetry install |
| 23 | + |
| 24 | +```sh |
| 25 | +poetry add deutschland -E mudab |
| 26 | +``` |
| 27 | + |
| 28 | +### Setuptools |
| 29 | + |
| 30 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 31 | + |
| 32 | +```sh |
| 33 | +python setup.py install --user |
| 34 | +``` |
| 35 | +(or `sudo python setup.py install` to install the package for all users) |
| 36 | + |
| 37 | +## Usage |
| 38 | + |
| 39 | +Import the package: |
| 40 | +```python |
| 41 | +from deutschland import mudab |
| 42 | +``` |
| 43 | + |
| 44 | +## Getting Started |
| 45 | + |
| 46 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 47 | + |
| 48 | +```python |
| 49 | + |
| 50 | +import time |
| 51 | +from deutschland import mudab |
| 52 | +from pprint import pprint |
| 53 | +from deutschland.mudab.api import default_api |
| 54 | +from deutschland.mudab.model.filter_request import FilterRequest |
| 55 | +from deutschland.mudab.model.inline_response200 import InlineResponse200 |
| 56 | +from deutschland.mudab.model.inline_response2001 import InlineResponse2001 |
| 57 | +from deutschland.mudab.model.inline_response2002 import InlineResponse2002 |
| 58 | +from deutschland.mudab.model.inline_response2003 import InlineResponse2003 |
| 59 | +from deutschland.mudab.model.inline_response2004 import InlineResponse2004 |
| 60 | +from deutschland.mudab.model.inline_response2005 import InlineResponse2005 |
| 61 | +from deutschland.mudab.model.inline_response2006 import InlineResponse2006 |
| 62 | +from deutschland.mudab.model.inline_response2007 import InlineResponse2007 |
| 63 | +from deutschland.mudab.model.inline_response2008 import InlineResponse2008 |
| 64 | +# Defining the host is optional and defaults to https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements |
| 65 | +# See configuration.py for a list of all supported configuration parameters. |
| 66 | +configuration = mudab.Configuration( |
| 67 | + host = "https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements" |
| 68 | +) |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +# Enter a context with an instance of the API client |
| 73 | +with mudab.ApiClient(configuration) as api_client: |
| 74 | + # Create an instance of the API class |
| 75 | + api_instance = default_api.DefaultApi(api_client) |
| 76 | + filter_request = FilterRequest( |
| 77 | + filter=Filter( |
| 78 | + _or=FilterAction( |
| 79 | + col="col_example", |
| 80 | + op="op_example", |
| 81 | + value="value_example", |
| 82 | + ), |
| 83 | + _and=FilterAction( |
| 84 | + col="col_example", |
| 85 | + op="op_example", |
| 86 | + value="value_example", |
| 87 | + ), |
| 88 | + ), |
| 89 | + range=Range( |
| 90 | + _from=1, |
| 91 | + count=1, |
| 92 | + ), |
| 93 | + orderby=Orderby( |
| 94 | + col="col_example", |
| 95 | + dir="asc", |
| 96 | + ), |
| 97 | + ) # FilterRequest | (optional) |
| 98 | + |
| 99 | + try: |
| 100 | + # Liste aller Messstationen |
| 101 | + api_response = api_instance.list_mess_stationen(filter_request=filter_request) |
| 102 | + pprint(api_response) |
| 103 | + except mudab.ApiException as e: |
| 104 | + print("Exception when calling DefaultApi->list_mess_stationen: %s\n" % e) |
| 105 | +``` |
| 106 | + |
| 107 | +## Documentation for API Endpoints |
| 108 | + |
| 109 | +All URIs are relative to *https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements* |
| 110 | + |
| 111 | +Class | Method | HTTP request | Description |
| 112 | +------------ | ------------- | ------------- | ------------- |
| 113 | +*DefaultApi* | [**list_mess_stationen**](docs/DefaultApi.md#list_mess_stationen) | **POST** /STATION_SMALL | Liste aller Messstationen |
| 114 | +*DefaultApi* | [**list_parameter**](docs/DefaultApi.md#list_parameter) | **POST** /MV_PARAMETER | Liste aller Parameter |
| 115 | +*DefaultApi* | [**list_parameter_values**](docs/DefaultApi.md#list_parameter_values) | **POST** /MV_STATION_MSMNT | Liste aller Messwerte |
| 116 | +*DefaultApi* | [**list_parameters_biologie**](docs/DefaultApi.md#list_parameters_biologie) | **POST** /MV_PARAMETER_BIOLOGIE | Liste aller Parameter im Biologie Kompartiment |
| 117 | +*DefaultApi* | [**list_parameters_biota**](docs/DefaultApi.md#list_parameters_biota) | **POST** /MV_PARAMETER_BIOTA | Liste aller Parameter im Biota Kompartiment |
| 118 | +*DefaultApi* | [**list_parameters_sediment**](docs/DefaultApi.md#list_parameters_sediment) | **POST** /MV_PARAMETER_SEDIMENT | Liste aller Parameter im Sediment Kompartiment |
| 119 | +*DefaultApi* | [**list_parameters_wasser**](docs/DefaultApi.md#list_parameters_wasser) | **POST** /MV_PARAMETER_WASSER | Liste aller Parameter im Wasser Kompartiment |
| 120 | +*DefaultApi* | [**list_plc_stations**](docs/DefaultApi.md#list_plc_stations) | **POST** /V_PLC_STATION | Liste aller HELCOM PLC Stationen |
| 121 | +*DefaultApi* | [**list_projekt_stationen**](docs/DefaultApi.md#list_projekt_stationen) | **POST** /PROJECTSTATION_SMALL | Liste aller Projekt Stationen |
| 122 | + |
| 123 | + |
| 124 | +## Documentation For Models |
| 125 | + |
| 126 | + - [Compartment](docs/Compartment.md) |
| 127 | + - [Filter](docs/Filter.md) |
| 128 | + - [FilterAction](docs/FilterAction.md) |
| 129 | + - [FilterRequest](docs/FilterRequest.md) |
| 130 | + - [HelcomPLCStation](docs/HelcomPLCStation.md) |
| 131 | + - [InlineResponse200](docs/InlineResponse200.md) |
| 132 | + - [InlineResponse2001](docs/InlineResponse2001.md) |
| 133 | + - [InlineResponse2002](docs/InlineResponse2002.md) |
| 134 | + - [InlineResponse2003](docs/InlineResponse2003.md) |
| 135 | + - [InlineResponse2004](docs/InlineResponse2004.md) |
| 136 | + - [InlineResponse2005](docs/InlineResponse2005.md) |
| 137 | + - [InlineResponse2006](docs/InlineResponse2006.md) |
| 138 | + - [InlineResponse2007](docs/InlineResponse2007.md) |
| 139 | + - [InlineResponse2008](docs/InlineResponse2008.md) |
| 140 | + - [Messstation](docs/Messstation.md) |
| 141 | + - [Orderby](docs/Orderby.md) |
| 142 | + - [Parameter](docs/Parameter.md) |
| 143 | + - [ParameterValue](docs/ParameterValue.md) |
| 144 | + - [ProjectStation](docs/ProjectStation.md) |
| 145 | + - [Range](docs/Range.md) |
| 146 | + |
| 147 | + |
| 148 | +## Documentation For Authorization |
| 149 | + |
| 150 | + All endpoints do not require authorization. |
| 151 | + |
| 152 | +## Author |
| 153 | + |
| 154 | +kontakt@bund.dev |
| 155 | + |
| 156 | + |
| 157 | +## Notes for Large OpenAPI documents |
| 158 | +If the OpenAPI document is large, imports in mudab.apis and mudab.models may fail with a |
| 159 | +RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: |
| 160 | + |
| 161 | +Solution 1: |
| 162 | +Use specific imports for apis and models like: |
| 163 | +- `from deutschland.mudab.api.default_api import DefaultApi` |
| 164 | +- `from deutschland.mudab.model.pet import Pet` |
| 165 | + |
| 166 | +Solution 2: |
| 167 | +Before importing the package, adjust the maximum recursion limit as shown below: |
| 168 | +``` |
| 169 | +import sys |
| 170 | +sys.setrecursionlimit(1500) |
| 171 | +from deutschland import mudab |
| 172 | +from deutschland.mudab.apis import * |
| 173 | +from deutschland.mudab.models import * |
| 174 | +``` |
| 175 | + |
0 commit comments