Metadata-Version: 2.4
Name: openplzapi-client
Version: 0.2.0
Summary: A client library for the OpenPLZ API project
Author-email: STÜBER SYSTEMS GmbH <opensource@stueber.de>
License: MIT License
        
        Copyright (C) 2026 STÜBER SYSTEMS
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/openpotato/openplzapi-client.py
Project-URL: Repository, https://github.com/openpotato/openplzapi-client.py.git
Project-URL: Issues, https://github.com/openpotato/openplzapi-client.py/issues
Keywords: plz,postleitzahlen,postal codes,Strassenverzeichnis,street directory
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.33.1
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Dynamic: license-file

[![PyPI Version](https://img.shields.io/pypi/v/openplzapi-client.svg)](https://pypi.python.org/pypi/openplzapi-client)
![GitHub](https://img.shields.io/github/license/openpotato/openplzapi-client.py)

# OpenPLZ API Python Client

The official [Python](https://www.python.org/) client library for direct access to the [OpenPLZ API](https://www.openplzapi.org/en).

+ Supports Python 3.10+
+ Supports all available [API endpoints](https://openplzapi.org/swagger/index.html)
+ Supports paged responses and [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457) error responses
+ Uses [Requests](https://github.com/psf/requests) as HTTP client.

## Installation

The **OpenPLZ API Python Client** is available on [PiPy](https://pypi.python.org/pypi/openplzapi-client), and installation via [pip](https://pip.pypa.io/) is the recommended way to install:

```
pip install openplzapi-client
```

## Getting started

Documentation is available in the [GitHub wiki](https://github.com/openpotato/openplzapi-client.py/wiki).

## Can I help?

Yes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit a Pull Request.
