Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/docentyt/osm_easy_api
Python package for parsing osm diffs and communicating with the osm api.
https://github.com/docentyt/osm_easy_api
openstreetmap openstreetmap-api python
Last synced: about 7 hours ago
JSON representation
Python package for parsing osm diffs and communicating with the osm api.
- Host: GitHub
- URL: https://github.com/docentyt/osm_easy_api
- Owner: docentYT
- License: gpl-3.0
- Created: 2023-03-03T16:03:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T18:09:09.000Z (4 months ago)
- Last Synced: 2025-01-12T09:17:48.444Z (10 days ago)
- Topics: openstreetmap, openstreetmap-api, python
- Language: Python
- Homepage:
- Size: 338 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
osm_easy_api
> Python package for parsing osm diffs and communicating with the OpenStreetMap api.
### What's the point of this package?
This package was created to provide an easy way to create automated scripts and programs that use diff and/or osm api. The main advantage is the classes (data_classes) that provide data of elements (node, way, relation, OsmChange, etc.) in a readable way and the possibility to use them in diff and api without worrying about missing data or dictionaries. You can easily find nodes in diff, add a tag to them and send the corrected version to osm.
## Installation
Works on python >= 3.10. (Due to new typehints standard)
Install `osm_easy_api` from [PyPi](https://pypi.org/project/osm-easy-api/):
```
pip install osm_easy_api
```
## Documentation
You can view documentation on [github-pages](https://docentyt.github.io/osm_easy_api/osm_easy_api.html).
Documentation is build using [pdoc](https://pdoc.dev).
To run docs on your machine use preferred command: `pdoc --docformat google --no-show-source osm_easy_api !osm_easy_api.utils`.
## OAuth 2.0
Due to the deprecation of HTTP Basic Auth you need an access token to use most api endpoints. To obtain an access token we recommend using https://tools.interactivemaps.xyz/token/.
## Examples
### DIFF
#### Print trees
```py
from osm_easy_api.diff import Diff, Frequency
from osm_easy_api.data_classes import Node
# Download diff from last hour.
d = Diff(Frequency.HOUR)
# Get Meta namedtuple for diff metadata and generator that parse diff file.
meta, gen = d.get(tags="natural")
# Print all created, modified and deleted Nodes with natural=tree tag.
for action, element in gen:
if type(element) == Node and element.tags.get("natural") == "tree":
print(action, element.id)
```
#### Print incorrectly tagged single tress
```py
from osm_easy_api.diff import Diff, Frequency
from osm_easy_api.data_classes import Action, Node
d = Diff(Frequency.DAY)
meta, gen = d.get(tags="natural")
for action, element in gen:
if type(element) == Node:
if action == Action.CREATE or action == Action.MODIFY:
if element.tags.get("natural") == "wood":
print(element)
```
Example output:
```
Node(id = 10208486717, visible = None, version = 1, changeset_id = 129216075, timestamp = 2022-11-22T00:16:44Z, user_id = 17471721, tags = {'leaf_type': 'broadleaved', 'natural': 'wood'}, latitude = 48.6522286, longitude = 12.583809, )
```
### API
#### Add missing wikidata tag
```py
from osm_easy_api.api import Api
from osm_easy_api.data_classes import Node, Tags
api = Api("https://master.apis.dev.openstreetmap.org", ACCESS_TOKEN)
node = api.elements.get(Node, 4296460336) # We are getting Node with id 4296460336 where we want to add a new tag to
node.tags.add("wikidata", "Qexample") # Add a new tag to node.
my_changeset = api.changeset.create("Add missing wikidata tag", Tags({"automatic": "yes"})) # Create new changeset with description and tag
api.elements.update(node, my_changeset) # Send new version of a node to osm
api.changeset.close(my_changeset) # Close changeset.
```
## Notes
Note that the following codes do the same thing
```py
from osm_easy_api.diff import Diff, Frequency
d = Diff(Frequency.DAY)
meta, gen = d.get()
for action, element in gen:
if element.tags.get("shop") == "convenience":
print(element)
```
```py
from osm_easy_api.diff import Diff, Frequency
from osm_easy_api.data_classes import Tags
d = Diff(Frequency.DAY)
meta, gen = d.get(tags=Tags({"shop": "convenience"}))
for action, element in gen:
print(element)
```
but the second seems to be faster.
Also you can use OsmChange object if you don't want to use generator
```py
from osm_easy_api.diff import Diff, Frequency
from osm_easy_api.data_classes import Action, Node
d = Diff(Frequency.MINUTE)
osmChange = d.get(generator=False)
deleted_nodes = osmChange.get(Node, Action.DELETE)
for node in deleted_nodes:
print(node.id)
```
but it can consume large amounts of ram and use of this method is not recommended for large diff's.
## Tests
You will need to install `test-requirements.txt`. You can use tox.
To run tests manually use `python -m unittest discover`.