https://github.com/hyperoslo/yr

Yr makes it easy to get weather forecast from Yr.no.
https://github.com/hyperoslo/yr

Last synced: 12 months ago
JSON representation

Yr makes it easy to get weather forecast from Yr.no.

• Host: GitHub
• URL: https://github.com/hyperoslo/yr
• Owner: hyperoslo
• License: other
• Created: 2014-10-30T09:45:24.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-11-25T08:53:35.000Z (over 11 years ago)
• Last Synced: 2025-02-24T05:13:38.473Z (over 1 year ago)
• Language: Ruby
• Size: 33 MB
• Stars: 5
• Watchers: 15
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.md

Awesome Lists containing this project

README

          
# Yr

[![Gem Version](https://img.shields.io/gem/v/yr.svg?style=flat)](https://rubygems.org/gems/yr)

[![Build Status](https://img.shields.io/travis/hyperoslo/yr.svg?style=flat)](https://travis-ci.org/hyperoslo/yr)

[![Dependency Status](https://img.shields.io/gemnasium/hyperoslo/yr.svg?style=flat)](https://gemnasium.com/hyperoslo/yr)

[![Code Climate](https://img.shields.io/codeclimate/github/hyperoslo/yr.svg?style=flat)](https://codeclimate.com/github/hyperoslo/yr)

[![Coverage Status](https://img.shields.io/coveralls/hyperoslo/yr.svg?style=flat)](https://coveralls.io/r/hyperoslo/yr)

Yr makes it easy to get weather forecast from Yr.no.

## Installation

Add this line to your application's Gemfile:

    gem 'yr'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install yr

## Usage

```

oslo = Yr::Place.find "Oslo"

oslo.forecast.days.each do |day|

  p day.name

  p day.date

  p day.temperature.value

end

```

If you are using Rails, all the weather symbols are included in the assets

pipeline, both svg and png formats. This means you can do something like this

if you want to display an icon `<%= image_tag day.symbol.svg %>` or

`<%= image_tag day.symbol.png %>`.

PNG files are included in several sizes, which you can specify like this

`<%= image_tag day.symbol.png(size: 100) %>`.

The supported png sizes are:

* 30px

* 38px

* 48px (default)

* 100px

* 200px

## 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 new Pull Request

## Credits

Hyper made this. We're a digital communications agency with a passion for good code,

and if you're using this library we probably want to hire you.

Also thanks to https://github.com/Hakon/yr_api for inspiration and some code.

## License

Yr is available under the MIT license. See the LICENSE file for more info.