Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiendv/geojson
The missing GeoJSON utilities for OpenStreetMap
https://github.com/hiendv/geojson
geojson hacktoberfest openstreetmap openstreetmap-relation
Last synced: about 1 month ago
JSON representation
The missing GeoJSON utilities for OpenStreetMap
- Host: GitHub
- URL: https://github.com/hiendv/geojson
- Owner: hiendv
- License: mit
- Created: 2020-07-31T04:05:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T10:04:29.000Z (over 4 years ago)
- Last Synced: 2024-06-20T02:06:21.026Z (6 months ago)
- Topics: geojson, hacktoberfest, openstreetmap, openstreetmap-relation
- Language: Go
- Homepage:
- Size: 887 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GeoJSON
The missing GeoJSON utilities for OpenStreetMap
[](https://travis-ci.org/github/hiendv/geojson)
[](https://codecov.io/gh/hiendv/geojson)
[](https://pkg.go.dev/github.com/hiendv/geojson)
[](https://goreportcard.com/report/github.com/hiendv/geojson)
[](https://github.com/hiendv/geojson/blob/master/LICENSE)
---
## Why this?
Because existing tools cannot solve below problems *efficiently*
- Building an OSM object in GeoJSON format with sub-areas separated. [osmtogeojson](https://github.com/tyrasd/osmtogeojson) or [polygons.openstreetmap.fr](http://polygons.openstreetmap.fr/get_geojson.py?id=relation_id) won't work because they don't include inner boundaries.
- Tags and metadata normalization
- Optional D3-compatibility. It doesn't follow common convetion like [winding order from GeoJSON’s RFC 7946](https://github.com/d3/d3-geo#d3-geo)
These above problems keep showing up and bugging me because my work is closely related. So if you share the same concerns, this tool is for you.
## Accuracy and Legal Disclaimer
The accuracy of information provided by the tool solely depends on [OpenStreetMap](https://www.openstreetmap.org/) data.
I do not accept any responsibility or liability for the accuracy, content, completeness, legality, or reliability of the information provided by the tool or contained on the website.
## Docs
### Installation
**go version >= go1.13**
```
GO111MODULE=on go get -u github.com/hiendv/geojson/cmd/geojson
```
### Example
#### List all [New York](https://www.openstreetmap.org/relation/61320) sub-areas
```bash
geojson subarea 61320
```
```
2020-08-05T14:41:57.087+0700 INFO fetching sub-areas {"parent": 61320}
2020-08-05T14:42:06.126+0700 INFO writing {"path": "geojson/61320.geojson"}
2020-08-05T14:42:06.127+0700 INFO sub-areas handled {"total": 62}
```
The difference with existing tools can be demonstrated with two visualization below
#### hiendv/geojson
#### polygons.openstreetmap.fr
*(after manual correction and right-hand-rule fixing)*
### Usage
```sh
geojson --help
```
```
NAME:
GeoJSON - Utilities for OpenStreetMap GeoJSON
USAGE:
geojson [global options] command [command options] [arguments...]
VERSION:
0.1.1
AUTHOR:
Hien Dao
COMMANDS:
serve serve the web server
subarea list all sub-areas of an OpenStreetMap object
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--out value, -o value specify the directory of outputs (default: "./geo")
--verbose enable verbose logging with DEBUG level (default: false)
--help, -h show help (default: false)
--version, -v print the version (default: false)
COPYRIGHT:
Copyright © 2020 Hien Dao. All Rights Reserved.
```
**Notice**: To print outputs to *stdout*, specify `--out` as an empty string
```
geojson --out "" command [command options] [arguments...]
```
#### subarea
```sh
geojson subarea --help
```
```
NAME:
geojson subarea - list all sub-areas of an OpenStreetMap object
USAGE:
geojson subarea [command options] [arguments...]
OPTIONS:
--raw, -r leave tags in unfornalized form (UNF) (default: false)
--separated, -s leave sub-areas unmerged (default: false)
--rewind rewind the output - counter to RFC 7946 (default: false)
--help, -h show help (default: false)
```
#### serve
```sh
geojson serve --help
```
```
NAME:
geojson serve - serve the web server
USAGE:
geojson serve [command options] [arguments...]
OPTIONS:
--address value, --addr value set the serving address (default: "127.0.0.1:8181")
--origin value set the CORS origin (default: "*")
--rate value set request-per-second for rate-limiting (default: 10)
--rate-burst value set burst size (concurrent requests) for rate-limiting (default: 5)
--rate-ttl value set the rate limit TTL for inactive sessions (default: "2m")
--prefix value set static fs handler base path (default: "/static")
--help, -h show help (default: false)
```
### API
#### Rate-limiting
The rate-limiting will be specified by `--rate`, `--rtate-burst`, `--rate-ttl` parameters.
Default values should be 10 requests/second with a concurrent value of 5 and time-to-live for inactive sessions of 2 minutes.
#### List sub-areas of an OpenStreetMap relation [GET /api/v1/subareas/{id}{?rewind}]
+ Parameters
+ id (number, required) - ID of an OpenStreetMap relation.
+ rewind (optional) - Rewinding the requested GeoJSON
+ Response 200 (application/json)
+ Attributes
- code (number)
- message (string)
- data (string)
Example
```
GET /api/v1/subareas/61320?rewind HTTP/1.1
Host: localhost:8181
User-Agent: curl/7.68.0
Accept: */*
HTTP/1.1 200 OK
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Origin: *
Content-Type: application/json
X-Content-Type-Options: nosniff
Date: Wed, 19 Aug 2020 16:25:13 GMT
Content-Length: 58
{"code":0,"message":"","data":"/static/geo/61320-rewind.geojson"}
```
#### GeoJSON of an OpenStreetMap relation [GET /{prefix}/{out}/{filename}.geojson]
Example
```
GET /static/geo/61320.geojson HTTP/1.1
Host: localhost:8181
User-Agent: curl/7.68.0
Accept: */*
HTTP/1.1 200 OK
Accept-Ranges: bytes
Content-Length: 1298442
Content-Type: text/plain; charset=utf-8
Last-Modified: Wed, 19 Aug 2020 11:47:13 GMT
Date: Wed, 19 Aug 2020 16:37:00 GMT
{"type":"FeatureCollection","features":[{"id":"relation/962876","type":"Feature","geometry":{...}}]}
```
## Development
### Prerequisites
- go version go1.11 for [modules support](https://blog.golang.org/using-go-modules)
### Running and Building
```sh
go run cmd/geojson/main.go --help
go run cmd/geojson/main.go subarea --help
go run cmd/geojson/main.go serve --help
go build -o geojson cmd/geojson/main.go
```
### Linting & Formatting
```sh
### Format
gofumpt -w -s ./
### Lint
golangci-lint run ./...
```
### Testing
```sh
go test -race ./...
```
## Contribution
Issues and PRs are welcome !
## License
[MIT](./LICENSE) © 2020 Hien Dao