/nhl_stats

Simple CLI to scrape NHL stats from quanthockey.com

Primary LanguageRubyMIT LicenseMIT

NHL Stats

Welcome! This gem is a simple web-scraping CLI to view selected stats of NHL players, as per the website quanthockey.com

Installation

Add this line to your application's Gemfile:

gem 'nhl_stats'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nhl_stats

Type nhl-stats into your Terminal to launch

Usage

Upon execution, the CLI will show you a list of top 50 players by all-time points.

You are then prompted to choose a number to view more information on that player, like birthplace, handed-ness, and height.

Exit the application at any prompt by typing 'exit'.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nichol88/nhl_stats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the NhlStats project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.