Caution
This is a WIP tool that is very unstable and not fully optimised, use at your own care! This README will also be reworked.
OverScry is a tool designed to simplify the process of generating Overpass queries from a YML structure file. By taking a structured YML input that defines specific geographical data and search parameters, OverScry automatically converts it into a valid Overpass query. Overall it makes it easier for both beginners and experts to leverage Overpass API capabilities without needing to understand how to write complex raw queries.
Tip
There is a web version of the tool available, no installation required, just your browser. Check it out here
Installing the tool can currently only be done via Go and Docker.
You need to have Go installed. You can then install using:
go install github.com/kkrypt0nn/overscry@latestYou can run the tool from the published Docker image using:
docker run -v .:/data -it kkrypt0nn/overscry gen --settings /data/_examples/housenumber.ymlAfter installing you can run the tool with
overscry --helpThis will give you the list of commands and their respective flags.
You can then simply generate a query with
overscry gen --settings _examples/housenumber.ymlThe YML file for the settings has the following example structure
version: "0.0.7-dev"
author: "Krypton (@kkrypt0nn)"
description: "A query to get apartments with 2 levels"
node:
building:
value: apartments
levels:
value: 2More details about the supported fields is available here.
Note
A lot of work is put into so that more arguments and features/tags are supported. Please be patient for upcoming changes.
OverScry works on the following platforms:
- Linux
- macOS
- Windows
- Browser (via WebAssembly) - See https://overscry.krypton.ninja/online/
- Docker
- Android
If you encounter issues while using OverScry, consider the following:
- Ensure you are running the latest version
- Join my Discord server here
- Use the GitHub issue tracker
People may contribute by following the Contributing Guidelines and
the Code of Conduct once the tool is out of pre-releases, so once v0.1.0 comes out.
This tool was made with 💜 by Krypton and is under the MIT License.