Python wrapper for the OSM API (requires Python >= 3.8)
Install osmapi from PyPi by using pip:
pip install osmapi
The documentation is generated using pdoc and can be viewed online.
The build the documentation locally, you can use
make docs
This project uses GitHub Pages to publish its documentation.
To update the online documentation, you need to re-generate the documentation with the above command and update the master branch of this repository.
To test this library, please create an account on the development server of OpenStreetMap (https://api06.dev.openstreetmap.org).
Check the examples directory to find more example code.
>>> import osmapi
>>> api = osmapi.OsmApi()
>>> print(api.NodeGet(123))
{u'changeset': 532907, u'uid': 14298,
u'timestamp': u'2007-09-29T09:19:17Z',
u'lon': 10.790009299999999, u'visible': True,
u'version': 1, u'user': u'Mede',
u'lat': 59.9503044, u'tag': {}, u'id': 123}>>> import osmapi
>>> api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", username = u"metaodi", password = u"*******")
>>> api.ChangesetCreate({u"comment": u"My first test"})
>>> print(api.NodeCreate({u"lon":1, u"lat":1, u"tag": {}}))
{u'changeset': 532907, u'lon': 1, u'version': 1, u'lat': 1, u'tag': {}, u'id': 164684}
>>> api.ChangesetClose()Username/Password authentication will be deprecated in July 2024 (see official OWG announcemnt for details). In order to use this library in the future, you'll need to use OAuth 2.0.
To use OAuth 2.0, you must register an application with an OpenStreetMap account, either on the
development server
or on the production server.
Once this registration is done, you'll get a client_id and a client_secret that you can use to authenticate users.
Example code using cli-oauth2 on the development server, replace OpenStreetMapDevAuth with OpenStreetMapAuth to use the production server:
import osmapi
from oauthcli import OpenStreetMapDevAuth
client_id = "<client_id>"
client_secret = "<client_secret>"
auth = OpenStreetMapDevAuth(
client_id, client_secret, ['read_prefs', 'write_map']
).auth_code()
api = osmapi.OsmApi(
api="https://api06.dev.openstreetmap.org",
session=auth.session
)
with api.Changeset({"comment": "My first test"}) as changeset_id:
print(f"Part of Changeset {changeset_id}")
node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
print(node1)An alternative way using the requests-oauthlib library can be found
in the examples.
To credit the application that supplies changes to OSM, an appid can be provided.
This is a string identifying the application.
If this is omitted "osmapi" is used.
api = osmapi.OsmApi(
api="https://api06.dev.openstreetmap.org",
appid="MyOSM Script"
)If then changesets are made using this osmapi instance, they get a tag created_by with the following content: MyOSM Script (osmapi/<version>)
Example changeset of Kort using osmapi
Scripted imports and automated edits should only be carried out by those with experience and understanding of the way the OpenStreetMap community creates maps, and only with careful planning and consultation with the local community.
See the Import/Guidelines and Automated Edits/Code of Conduct for more information.
If you want to help with the development of osmapi, you should clone this repository and install the requirements:
make deps
Better yet use the provided setup.sh script to create a virtual env and install this package in it.
You can lint the source code using this command:
make lint
And if you want to reformat the files (using the black code style) simply run:
make format
To run the tests use the following command:
make test
To create a new release, follow these steps (please respect Semantic Versioning):
- Adapt the version number in
osmapi/__init__.py - Update the CHANGELOG with the version
- Re-build the documentation (
make docs) - Create a pull request to merge develop into master (make sure the tests pass!)
- Create a new release/tag on GitHub (on the master branch)
- The publication on PyPI happens via GitHub Actions on every tagged commit
This project was orginally developed by Etienne Chové. This repository is a copy of the original code from SVN (http://svn.openstreetmap.org/applications/utils/python_lib/OsmApi/OsmApi.py), with the goal to enable easy contribution via GitHub and release of this package via PyPI.
See also the OSM wiki: http://wiki.openstreetmap.org/wiki/Osmapi
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent