Popularity
7.4
Growing
Activity
1.5
-
86
8
45

Monthly Downloads: 2,381
Programming language: Elixir
License: MIT License
Tags: Geolocation    

geocoder alternatives and similar packages

Based on the "Geolocation" category

Do you think we are missing an alternative of geocoder or a related project?

Add another 'Geolocation' Package

README

Geocoder Build Status Inline docs Coverage Status

A simple, efficient geocoder/reverse geocoder with a built-in cache.

Is it extensible? Yes. Is it any good? Absolutely.

Installation

Keep calm and add Geocoder to your mix.exs dependencies:

def deps do
  [{:geocoder, "~> 1.0"}]
end

Update your mix dependencies:

mix deps.get

Configuration

All configuration below is optional. Sane defaults are set so you don't need to think too hard.

Set pool configuration:

config :geocoder, :worker_pool_config, size: 4, max_overflow: 2

Set provider configuration:

config :geocoder, :worker,
  # OpenStreetMaps or OpenCageData are other supported providers
  provider: Geocoder.Providers.GoogleMaps,
  key: System.get_env("GEOCODER_GOOGLE_API_KEY")

Note that OpenStreetMaps is the only provider that does not require an API key to operate. All other providers require an API key that you'll need to provide.

If you need to set a proxy (or any other option supported by HTTPoison.get/3):

config :geocoder, Geocoder.Worker, [
  httpoison_options: [proxy: "my.proxy.server:3128", proxy_auth: {"username", "password"}]
]

Let's rumble!

Usage

{:ok, coordinates } = Geocoder.call("Toronto, ON")
{:ok, coordinates } = Geocoder.call({43.653226, -79.383184})

coordinates.location.formatted_address

You can pass options to the function that will be passed to the geocoder provider, for example:

Geocoder.call(address: "Toronto, ON", language: "es", key: "...", ...)

See here and here for a list of supported parameters for the default geocoder provider (Geocoder.Provider.GoogleMaps).

And you're done! How simple was that?

Development

Right now, geocoder supports three providers (i.e. sources):

  • Geocoder.Providers.GoogleMaps
  • Geocoder.Providers.OpenCageData
  • Geocoder.Providers.OpenStreetMaps

To run the tests for these, and any future providers, you'll want to pass a PROVIDER environment variable:

PROVIDER=google mix test

By default, the tests run on OpenStreetMaps.

Copyright (c) 2019, Kash Nouroozi.

The source code is licensed under the [MIT License](LICENSE.md).


*Note that all licence references and agreements mentioned in the geocoder README section above are relevant to that project's source code only.