https://github.com/techgaun/darkskyx

A Darksky.net (formerly forecast.io) weather API client for Elixir
https://github.com/techgaun/darkskyx

darksky elixir forecast weather

Last synced: 3 months ago
JSON representation

A Darksky.net (formerly forecast.io) weather API client for Elixir

• Host: GitHub
• URL: https://github.com/techgaun/darkskyx
• Owner: techgaun
• License: apache-2.0
• Created: 2016-10-03T06:00:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-12T23:38:10.000Z (almost 5 years ago)
• Last Synced: 2024-10-02T21:07:05.584Z (4 months ago)
• Topics: darksky, elixir, forecast, weather
• Language: Elixir
• Homepage:
• Size: 68.4 KB
• Stars: 12
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A Darksky.com (formerly forecast.io) API client for Elixir. (Third Party APIs)
• fucking-awesome-elixir - darkskyx - A Darksky.com (formerly forecast.io) API client for Elixir. (Third Party APIs)
• awesome-elixir - darkskyx - A Darksky.com (formerly forecast.io) API client for Elixir. (Third Party APIs)

README

        
# Darkskyx

[![Build Status](https://semaphoreci.com/api/v1/techgaun/darkskyx/branches/master/badge.svg)](https://semaphoreci.com/techgaun/darkskyx) [![Hex version](https://img.shields.io/hexpm/v/darkskyx.svg "Hex version")](https://hex.pm/packages/darkskyx) ![Hex downloads](https://img.shields.io/hexpm/dt/darkskyx.svg "Hex downloads")

> A Darksky.net weather api client for Elixir

As of March 31, 2020, Darksky has been [acquired by Apple](https://blog.darksky.net/) and the API will continue to function through the end of 2021.

## Installation

The package can be installed as:

Add `darkskyx` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:darkskyx, "~> 1.0"}]

end

```

Ensure `darkskyx` is started before your application:

```elixir

def application do

  [applications: [:darkskyx]]

end

```

## Usage

You can use darkskyx to perform forecast as well as time machine request. You will need to configure the darksky api key properly.

### configuration

The simplest would be to set darksky api key as below:

```shell

export DARKSKY_API_KEY=

```

Now, in your config.exs (or environment specific configuration), add the config block to configure Darkskyx. You can pass keyword list of `units`, `lang`, `excludes` and `extends` for the `defaults` config block which will be used to override the global default configuration. The default configuration is to use `units: auto` and `lang: en`. On top of the default configuration, you can also override the default configuration per request by passing the `%Darkskyx{}` struct configured to your liking.

```elixir

config :darkskyx, api_key: System.get_env("DARKSKY_API_KEY"),

  defaults: [

    units: "us",

    lang: "en"

  ]

```

### Examples

```elixir

Darkskyx.forecast(41.032, -94.234)

Darkskyx.forecast(41.043, -93.23432, %Darkskyx{lang: "ar"})

Darkskyx.forecast(41.032, -94.234, %Darkskyx{exclude: "daily,hourly"})

Darkskyx.time_machine(41.043, -93.23432, 13432423)

Darkskyx.time_machine(41.043, -93.23432, 13432423, %Darkskyx{lang: "ar", units: "si"})

Darkskyx.current(37, -94)

Darkskyx.current(37, -94, %Darkskyx{lang: "ar"})

```

This package only performs API call and asks consumer of this package

to perform things such as handling rate-limiting.

### Change on v1.0

All the raw api calls except `Darkskyx.current` and `Darkskyx.forecast`

now return headers for success calls like: `{:ok, body, headers}`

This gives flexibility for API consumer to handle things such as

rate limiting based on the headers.

## Author

- [Samar Acharya](https://github.com/techgaun)

## License

- See [License](LICENSE) for more details.