de-digitale-verwaltung


Namede-digitale-verwaltung JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/bundesAPI/digitale-verwaltung-api
SummaryAPI zum Digitalisierungsfortschritt der öffentlichen Verwaltung
upload_time2024-05-22 08:35:47
maintainerNone
docs_urlNone
authorBundesAPI
requires_python>=3.6
licenseApache-2.0
keywords openapi openapi-generator digitale-verwaltung app api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # digitale-verwaltung
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: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

```sh
pip install deutschland[digitale_verwaltung]
```

### poetry install

```sh
poetry add deutschland -E digitale_verwaltung
```

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

## Getting Started

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

```python

import time
from deutschland import digitale_verwaltung
from pprint import pprint
from deutschland.digitale_verwaltung.api import ars_api
from deutschland.digitale_verwaltung.model.page_ars_dto import PageArsDto
# Defining the host is optional and defaults to https://dashboard-daten.digitale-verwaltung.de/api
# See configuration.py for a list of all supported configuration parameters.
configuration = digitale_verwaltung.Configuration(
    host = "https://dashboard-daten.digitale-verwaltung.de/api"
)



# Enter a context with an instance of the API client
with digitale_verwaltung.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ars_api.ARSApi(api_client)
    order = "asc" # str | Gibt an, wie die Ergebnismenge sortiert werden soll. (optional) (default to "asc")
    page = "0" # str | Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0. (optional) (default to "0")
    size = "100" # str | Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf. (optional) (default to "100")

    try:
        # Informationen zu Gebietskörperschaften in Deutschland
        api_response = api_instance.find_all1(order=order, page=page, size=size)
        pprint(api_response)
    except digitale_verwaltung.ApiException as e:
        print("Exception when calling ARSApi->find_all1: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://dashboard-daten.digitale-verwaltung.de/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ARSApi* | [**find_all1**](docs/ARSApi.md#find_all1) | **GET** /v1/ars | Informationen zu Gebietskörperschaften in Deutschland
*DataApi* | [**find_all**](docs/DataApi.md#find_all) | **GET** /v1/data | Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten
*DataApi* | [**find_by_filter**](docs/DataApi.md#find_by_filter) | **GET** /v1/data/{ars} | Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten eingeschränkt auf Gebietskörperschaften


## Documentation For Models

 - [ArsDto](docs/ArsDto.md)
 - [DvDataDto](docs/DvDataDto.md)
 - [PageArsDto](docs/PageArsDto.md)
 - [PageDvDataDto](docs/PageDvDataDto.md)
 - [PageableObject](docs/PageableObject.md)
 - [SortObject](docs/SortObject.md)


## 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 digitale_verwaltung.apis and digitale_verwaltung.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.digitale_verwaltung.api.default_api import DefaultApi`
- `from deutschland.digitale_verwaltung.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 digitale_verwaltung
from deutschland.digitale_verwaltung.apis import *
from deutschland.digitale_verwaltung.models import *
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bundesAPI/digitale-verwaltung-api",
    "name": "de-digitale-verwaltung",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, digitale-verwaltung, App, API",
    "author": "BundesAPI",
    "author_email": "kontakt@bund.dev",
    "download_url": "https://files.pythonhosted.org/packages/f2/1f/43e5ed5519b6428c5886cea10407bc216c626aa9eb5728b20a949606060c/de_digitale_verwaltung-1.0.0.tar.gz",
    "platform": null,
    "description": "# digitale-verwaltung\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: 1.0.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[digitale_verwaltung]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E digitale_verwaltung\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 digitale_verwaltung\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 digitale_verwaltung\nfrom pprint import pprint\nfrom deutschland.digitale_verwaltung.api import ars_api\nfrom deutschland.digitale_verwaltung.model.page_ars_dto import PageArsDto\n# Defining the host is optional and defaults to https://dashboard-daten.digitale-verwaltung.de/api\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = digitale_verwaltung.Configuration(\n    host = \"https://dashboard-daten.digitale-verwaltung.de/api\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith digitale_verwaltung.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = ars_api.ARSApi(api_client)\n    order = \"asc\" # str | Gibt an, wie die Ergebnismenge sortiert werden soll. (optional) (default to \"asc\")\n    page = \"0\" # str | Gibt an, welche Seite der Ergebnismenge zur\u00fcckgegeben werden soll. Die erste Seite entspricht dem Wert 0. (optional) (default to \"0\")\n    size = \"100\" # str | Gibt an, wie gro\u00df die Ergebnismenge f\u00fcr die abgefragte Seite maximal sein darf. (optional) (default to \"100\")\n\n    try:\n        # Informationen zu Gebietsk\u00f6rperschaften in Deutschland\n        api_response = api_instance.find_all1(order=order, page=page, size=size)\n        pprint(api_response)\n    except digitale_verwaltung.ApiException as e:\n        print(\"Exception when calling ARSApi->find_all1: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://dashboard-daten.digitale-verwaltung.de/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ARSApi* | [**find_all1**](docs/ARSApi.md#find_all1) | **GET** /v1/ars | Informationen zu Gebietsk\u00f6rperschaften in Deutschland\n*DataApi* | [**find_all**](docs/DataApi.md#find_all) | **GET** /v1/data | Informationen zu OZG-Leistungen und deren zugeh\u00f6rigen Onlinediensten\n*DataApi* | [**find_by_filter**](docs/DataApi.md#find_by_filter) | **GET** /v1/data/{ars} | Informationen zu OZG-Leistungen und deren zugeh\u00f6rigen Onlinediensten eingeschr\u00e4nkt auf Gebietsk\u00f6rperschaften\n\n\n## Documentation For Models\n\n - [ArsDto](docs/ArsDto.md)\n - [DvDataDto](docs/DvDataDto.md)\n - [PageArsDto](docs/PageArsDto.md)\n - [PageDvDataDto](docs/PageDvDataDto.md)\n - [PageableObject](docs/PageableObject.md)\n - [SortObject](docs/SortObject.md)\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 digitale_verwaltung.apis and digitale_verwaltung.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.digitale_verwaltung.api.default_api import DefaultApi`\n- `from deutschland.digitale_verwaltung.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 digitale_verwaltung\nfrom deutschland.digitale_verwaltung.apis import *\nfrom deutschland.digitale_verwaltung.models import *\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "API zum Digitalisierungsfortschritt der \u00f6ffentlichen Verwaltung",
    "version": "1.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bundesAPI/digitale-verwaltung-api/issues",
        "Homepage": "https://github.com/bundesAPI/digitale-verwaltung-api"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " digitale-verwaltung",
        " app",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f6d6a9a4e61a72e754160f6e54464af7a8e44a3db82e068ac24fe01096da26f",
                "md5": "1f30800f83227b3c37a3bffdfeccedbb",
                "sha256": "f6bdbb5ee71575f9bc3524d3f880ed3775d9d09674ab7579580390c3c526cd39"
            },
            "downloads": -1,
            "filename": "de_digitale_verwaltung-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f30800f83227b3c37a3bffdfeccedbb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 61612,
            "upload_time": "2024-05-22T08:35:45",
            "upload_time_iso_8601": "2024-05-22T08:35:45.955677Z",
            "url": "https://files.pythonhosted.org/packages/6f/6d/6a9a4e61a72e754160f6e54464af7a8e44a3db82e068ac24fe01096da26f/de_digitale_verwaltung-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f21f43e5ed5519b6428c5886cea10407bc216c626aa9eb5728b20a949606060c",
                "md5": "0aa63d0c11073b2e024f9007b2836a7f",
                "sha256": "2ed727932bb3cf634cf32727d60e42da25b4997213104edea96a240a881e7084"
            },
            "downloads": -1,
            "filename": "de_digitale_verwaltung-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0aa63d0c11073b2e024f9007b2836a7f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 42624,
            "upload_time": "2024-05-22T08:35:47",
            "upload_time_iso_8601": "2024-05-22T08:35:47.859035Z",
            "url": "https://files.pythonhosted.org/packages/f2/1f/43e5ed5519b6428c5886cea10407bc216c626aa9eb5728b20a949606060c/de_digitale_verwaltung-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-22 08:35:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bundesAPI",
    "github_project": "digitale-verwaltung-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "de-digitale-verwaltung"
}
        
Elapsed time: 0.24273s