https://github.com/geocrystal/geohash

Geohash encode/decode library for pure Crystal
https://github.com/geocrystal/geohash

crystal geohash gis

Last synced: 8 months ago
JSON representation

Geohash encode/decode library for pure Crystal

• Host: GitHub
• URL: https://github.com/geocrystal/geohash
• Owner: geocrystal
• License: mit
• Created: 2022-07-31T12:48:02.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T12:50:56.000Z (over 1 year ago)
• Last Synced: 2025-01-12T05:12:37.304Z (10 months ago)
• Topics: crystal, geohash, gis
• Language: Crystal
• Homepage:
• Size: 648 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# geohash

[![Crystal CI](https://github.com/geocrystal/geohash/actions/workflows/crystal.yml/badge.svg)](https://github.com/geocrystal/geohash/actions/workflows/crystal.yml)

[![License](https://img.shields.io/github/license/geocrystal/geohash.svg)](https://github.com/geocrystal/geohash/blob/master/LICENSE)

[![GitHub release](https://img.shields.io/github/release/geocrystal/geohash.svg)](https://github.com/geocrystal/geohash/releases)

Geohash encode/decode library for pure Crystal.

A [geohash](https://en.wikipedia.org/wiki/Geohash) is a convenient way of expressing a location (anywhere in the world)

using a short alphanumeric string, with greater precision obtained with longer strings.

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     geohash:

       github: geocrystal/geohash

   ```

2. Run `shards install`

## Usage

```crystal

require "geohash"

Geohash.encode(48.669, -4.329, 5) # => "gbsuv"

Geohash.decode("gbsuv") # => {lat: 48.669, lng: -4.329}

Geohash.neighbors("gbsuv")

# =>{n: "gbsvj", ne: "gbsvn", e: "gbsuy", se: "gbsuw", s: "gbsut", sw: "gbsus", w: "gbsuu", nw: "gbsvh"}

#

# Neighbors:

# gbsvh	gbsvj gbsvn

# gbsuu	gbsuv gbsuy

# gbsus	gbsut gbsuw

Geohash.bounds("gbsuv")

# => {sw: {lat: 48.6474609375, lng: -4.3505859375}, ne: {lat: 48.69140625, lng: -4.306640625}}

```

![alt text](/assets/screenshot.png)

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer