Metadata-Version: 2.4
Name: nways-maps
Version: 1.1.0
Summary: N-Ways Maps Platform API client (generated from the OpenAPI files).
Author-email: N-WAYS LIMITED <hello@nways.ng>
License-Expression: Apache-2.0
Project-URL: Homepage, https://nways.ng/developers
Project-URL: Documentation, https://nways.ng/developers/client-libraries
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Dynamic: license-file

# nways-maps (Python)

The N-Ways Maps Platform API client for Python 3.8+ (standard library only): one method per API operation (geocoding, postcodes, places,
routes, the route matrix, fares, static maps, fleet tracking…), your key in the `X-NWays-Api-Key` header, and errors
with the HTTP status, the `reason` and `Retry-After`. Generated from the N-Ways OpenAPI files.

Docs: https://nways.ng/developers/client-libraries · API reference: https://nways.ng/developers/reference

## Install

```sh
pip install nways-maps
```

## Example

```python
import os
from nways_maps import ApiError, Client

nways = Client(api_key=os.environ["NWAYS_API_KEY"])
try:
    answer = nways.geocode(q="Allen Avenue, Ikeja", limit=3)
    print(answer["results"][0]["name"])
except ApiError as e:
    print(e.status, e.reason, e.retry_after)
```

Keep server keys (restricted to your servers' IP addresses) out of web pages and apps.

## Licence

The client's code is licensed under the [Apache License, Version 2.0](LICENSE) (`Apache-2.0`), Copyright 2026
N-WAYS LIMITED; see [NOTICE](NOTICE).

The licence covers the code, not the data the API returns. N-Ways maps and data are built on OpenStreetMap,
© OpenStreetMap contributors, available under the [Open Database License (ODbL)](https://www.openstreetmap.org/copyright);
credit "N-Ways · © OpenStreetMap contributors" wherever you show them. Using the API needs an N-Ways API key and is
governed by the [N-Ways Maps Platform terms](https://nways.ng/developers/terms).
