generated from bundesAPI/api-doc-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:bundesAPI/bundestag-tagesordnung-api
- Loading branch information
Showing
32 changed files
with
5,482 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.gitignore | ||
.gitlab-ci.yml | ||
.openapi-generator-ignore | ||
.travis.yml | ||
README.md | ||
bundestag_tagesordnung/__init__.py | ||
bundestag_tagesordnung/api/__init__.py | ||
bundestag_tagesordnung/api/default_api.py | ||
bundestag_tagesordnung/api_client.py | ||
bundestag_tagesordnung/apis/__init__.py | ||
bundestag_tagesordnung/configuration.py | ||
bundestag_tagesordnung/exceptions.py | ||
bundestag_tagesordnung/model/__init__.py | ||
bundestag_tagesordnung/model_utils.py | ||
bundestag_tagesordnung/models/__init__.py | ||
bundestag_tagesordnung/rest.py | ||
create_doc.py | ||
docs/DefaultApi.md | ||
git_push.sh | ||
pyproject.toml | ||
rename_generated_code.py | ||
requirements.txt | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
test/__init__.py | ||
test/test_default_api.py | ||
tox.ini |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
6.1.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# bundestag-tagesordnung | ||
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.0 | ||
- Package version: 1.0.0 | ||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen | ||
|
||
## Requirements. | ||
|
||
Python >= 3.6 | ||
|
||
## Installation & Usage | ||
### pip install | ||
|
||
```sh | ||
pip install deutschland[bundestag_tagesordnung] | ||
``` | ||
|
||
### poetry install | ||
|
||
```sh | ||
poetry add deutschland -E bundestag_tagesordnung | ||
``` | ||
|
||
### 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 bundestag_tagesordnung | ||
``` | ||
|
||
## Getting Started | ||
|
||
Please follow the [installation procedure](#installation--usage) and then run the following: | ||
|
||
```python | ||
|
||
import time | ||
from deutschland import bundestag_tagesordnung | ||
from pprint import pprint | ||
from deutschland.bundestag_tagesordnung.api import default_api | ||
# Defining the host is optional and defaults to https://api.hutt.io | ||
# See configuration.py for a list of all supported configuration parameters. | ||
configuration = bundestag_tagesordnung.Configuration( | ||
host = "https://api.hutt.io" | ||
) | ||
|
||
|
||
|
||
# Enter a context with an instance of the API client | ||
with bundestag_tagesordnung.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = default_api.DefaultApi(api_client) | ||
year = 1 # int | Das Jahr, für das Tagesordnungen abgerufen werden sollen (optional) (optional) | ||
week = 1 # int | Die Kalenderwoche, für die Tagesordnungen abgerufen werden sollen (optional; kann mit Jahr kombiniert werden) (optional) | ||
|
||
try: | ||
# Tagesordnungen im CSV-Format abrufen | ||
api_response = api_instance.bt_to_csv_get(year=year, week=week) | ||
pprint(api_response) | ||
except bundestag_tagesordnung.ApiException as e: | ||
print("Exception when calling DefaultApi->bt_to_csv_get: %s\n" % e) | ||
``` | ||
|
||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *https://api.hutt.io* | ||
|
||
Class | Method | HTTP request | Description | ||
------------ | ------------- | ------------- | ------------- | ||
*DefaultApi* | [**bt_to_csv_get**](docs/DefaultApi.md#bt_to_csv_get) | **GET** /bt-to/csv | Tagesordnungen im CSV-Format abrufen | ||
*DefaultApi* | [**bt_to_ical_get**](docs/DefaultApi.md#bt_to_ical_get) | **GET** /bt-to/ical | Tagesordnungen im iCal-Format abrufen | ||
*DefaultApi* | [**bt_to_json_get**](docs/DefaultApi.md#bt_to_json_get) | **GET** /bt-to/json | Tagesordnungen im JSON-Format abrufen | ||
*DefaultApi* | [**bt_to_xml_get**](docs/DefaultApi.md#bt_to_xml_get) | **GET** /bt-to/xml | Tagesordnungen im XML-Format abrufen | ||
|
||
|
||
## Documentation For Models | ||
|
||
|
||
|
||
## Documentation For Authorization | ||
|
||
All endpoints do not require authorization. | ||
|
||
## Author | ||
|
||
[email protected] | ||
|
||
|
||
## Notes for Large OpenAPI documents | ||
If the OpenAPI document is large, imports in bundestag_tagesordnung.apis and bundestag_tagesordnung.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.bundestag_tagesordnung.api.default_api import DefaultApi` | ||
- `from deutschland.bundestag_tagesordnung.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 bundestag_tagesordnung | ||
from deutschland.bundestag_tagesordnung.apis import * | ||
from deutschland.bundestag_tagesordnung.models import * | ||
``` | ||
|
30 changes: 30 additions & 0 deletions
30
python-client/deutschland/bundestag_tagesordnung/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# flake8: noqa | ||
|
||
""" | ||
Tagesordnungen API | ||
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 | ||
The version of the OpenAPI document: 1.0.0 | ||
Contact: [email protected] | ||
Generated by: https://openapi-generator.tech | ||
""" | ||
|
||
|
||
__version__ = "1.0.0" | ||
|
||
# import ApiClient | ||
from deutschland.bundestag_tagesordnung.api_client import ApiClient | ||
|
||
# import Configuration | ||
from deutschland.bundestag_tagesordnung.configuration import Configuration | ||
|
||
# import exceptions | ||
from deutschland.bundestag_tagesordnung.exceptions import ( | ||
ApiAttributeError, | ||
ApiException, | ||
ApiKeyError, | ||
ApiTypeError, | ||
ApiValueError, | ||
OpenApiException, | ||
) |
3 changes: 3 additions & 0 deletions
3
python-client/deutschland/bundestag_tagesordnung/api/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# do not import all apis into this module because that uses a lot of memory and stack frames | ||
# if you need the ability to import all apis from one package, import them with | ||
# from deutschland.bundestag_tagesordnung.apis import DefaultApi |
Oops, something went wrong.