https://github.com/ent8r/notesreview-api
API for searching OpenStreetMap notes
https://github.com/ent8r/notesreview-api
Last synced: 3 days ago
JSON representation
API for searching OpenStreetMap notes
- Host: GitHub
- URL: https://github.com/ent8r/notesreview-api
- Owner: ENT8R
- Created: 2020-10-16T17:55:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-28T16:03:58.000Z (about 1 year ago)
- Last Synced: 2025-04-04T19:11:20.862Z (26 days ago)
- Language: Python
- Homepage: https://notesreview.kongruent.xyz/docs
- Size: 101 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# notesreview-api
> API and backend for [notesreview](https://github.com/ENT8R/notesreview)
## Scripts
#### `delete.py`
```sh
# Deletes all notes that are not included in the notes dump
python scripts/delete.py notes.osn
```
---
#### `import.py`
```sh
# Imports all notes from the notes dump
python scripts/import.py notes.osn
```
---
#### `indices.py`
```sh
# Creates all necessary indices for the database
python scripts/indices.py
```
---
#### `update.py`
```sh
# Updates the database by querying the OSM Notes API
# in order to receive the latest notes
# since a given date of the last check
python scripts/update.py
```
## Notes Dump
##### Download
```sh
# Download and extract the notes dump
# (hosted on https://planet.openstreetmap.org/ or any other mirror)
# ${URL} needs to be replaced with the location of the notes dump
curl -o notes.osn.bz2 ${URL} && bzip2 -d notes.osn.bz2
```
##### XML Structure
The structure of the notes dump follows this scheme:
```xml
${comment|optional}
```