Metadata-Version: 2.4
Name: aioplaces
Version: 0.1.1
Summary: Async Nominatim and Wikidata client with typed place parsing
Author: Snuffy2
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/Snuffy2/aioplaces
Project-URL: Documentation, https://aioplaces.readthedocs.io
Project-URL: Repository, https://github.com/Snuffy2/aioplaces
Project-URL: Issues, https://github.com/Snuffy2/aioplaces/issues
Keywords: nominatim,openstreetmap,geocoding,asyncio,wikidata
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Typing :: Typed
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp<4,>=3.13
Requires-Dist: cachetools>=6
Requires-Dist: yarl>=1.20
Provides-Extra: docs
Requires-Dist: sphinx<10,>=9; extra == "docs"
Requires-Dist: sphinx-rtd-theme<4,>=3; extra == "docs"
Requires-Dist: myst-parser<6,>=5; extra == "docs"
Dynamic: license-file

# aioplaces
[![Documentation][docs-shield]][docs]

aioplaces is a standalone asynchronous Python client for Nominatim reverse
geocoding and OSM feature lookup, Wikidata entity retrieval, and typed parsing
of Nominatim place responses. Python 3.14 or newer is required.

## Documentation

- Read the Docs: <https://aioplaces.readthedocs.io>

The documentation covers installation, quick start examples, client configuration,
API reference, upstream usage policies, and development.

## Releases

The publish workflow uses
PyPI Trusted Publishing: stable GitHub Releases go to PyPI and prereleases go
to TestPyPI.

## Origin and license

Extracted from the [Places Home Assistant integration](https://github.com/custom-components/places).
Credit belongs to the Places contributors. Licensed under GPL-3.0-only; see
[LICENSE](LICENSE).

[docs]: https://aioplaces.readthedocs.io
[docs-shield]: https://app.readthedocs.org/projects/aioplaces/badge/?version=latest&style=for-the-badge

## Endpoint diagnostics

The [scripts README](scripts/README.md) documents manual tools for testing
aioplaces client methods and inspecting raw Nominatim and Wikidata responses.

# Changelog

## [0.1.1](https://github.com/Snuffy2/aioplaces/compare/v0.1.0...v0.1.1) (2026-10-11)


### Features

* add library and upstream endpoint diagnostic scripts ([#11](https://github.com/Snuffy2/aioplaces/issues/11)) ([91bf92b](https://github.com/Snuffy2/aioplaces/commit/91bf92b60276751dad125ce016ed8ffeef65e846))


### Bug Fixes

* align beta release package version and explain validation failures ([b19139d](https://github.com/Snuffy2/aioplaces/commit/b19139df1396ce65f1974a5386d392a891c9f8e1))
* **ci:** bootstrap release-please from v0.1.0 ([#5](https://github.com/Snuffy2/aioplaces/issues/5)) ([14e9219](https://github.com/Snuffy2/aioplaces/commit/14e9219e0f7a90d3fada536ef69038b5c5715e5e))
* derive prerelease package versions from release tags ([#9](https://github.com/Snuffy2/aioplaces/issues/9)) ([b19139d](https://github.com/Snuffy2/aioplaces/commit/b19139df1396ce65f1974a5386d392a891c9f8e1))


### Documentation

* add Read the Docs site and API reference ([#6](https://github.com/Snuffy2/aioplaces/issues/6)) ([a64f7db](https://github.com/Snuffy2/aioplaces/commit/a64f7db8a67088801b265475b822237da77a4b87))
* simplify README and link to Read the Docs ([#8](https://github.com/Snuffy2/aioplaces/issues/8)) ([bfc5919](https://github.com/Snuffy2/aioplaces/commit/bfc59196887048bf4f6fadfcbd4269cb87dc1791))


### Miscellaneous Chores

* **ci:** update setup-uv to v10.2.0 ([#7](https://github.com/Snuffy2/aioplaces/issues/7)) ([b6d92cc](https://github.com/Snuffy2/aioplaces/commit/b6d92cc2e346eb2488d756800cac87fa2e118590))
* release 0.1.1 ([dc2c5c7](https://github.com/Snuffy2/aioplaces/commit/dc2c5c7d6cd0eb7a025035f70940c78555f8a6e3))
* remove obsolete and unused repository configuration ([#10](https://github.com/Snuffy2/aioplaces/issues/10)) ([bf3d9e2](https://github.com/Snuffy2/aioplaces/commit/bf3d9e272f3a15e20838d8ff51ccb8874918b653))


### Continuous Integration

* replace Dependabot auto-merge helper with Python ([#4](https://github.com/Snuffy2/aioplaces/issues/4)) ([c63d73b](https://github.com/Snuffy2/aioplaces/commit/c63d73b6e9842a1e01e69b71ef816372e3e576f6))

## 0.1.0

- Initial standalone async Nominatim/Wikidata client and typed Places response parser.
