No commit activity in last 3 years
No release in over 3 years
Plotly features added as needed. Uses Python Library as a reference https://github.com/plotly/plotly.py/tree/master/plotly/plotly
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

~> 1.11
~> 10.0
 Project Readme

Plotlyrb

Use plotly to graph your data.

Currently only supports plot_image, create_grid, and create_plot_from_grid.

  • plot_image generates an image for your plot
  • create_grid creates grid data accessible through the web interface
  • create_plot_from_grid creates a plot based on the JSON representation of a grid

See the python reference for details on what you can plot.

Installation

Add this line to your application's Gemfile:

gem 'plotlyrb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install plotlyrb

Usage

require 'plotlyrb'

# NOTE: data argument must be an array of traces
data = [
  {
    :x => ['2013-10-04 22:23:00', '2013-11-04 22:23:00', '2013-12-04 22:23:00'],
    :y => [1, 3, 6],
    :type => 'scatter',
    :mode => 'markers',
    :name => 'Andrew M'
  },
  {
    :x => ['2013-10-04 22:23:00', '2013-11-04 22:23:00', '2013-12-04 22:23:00'],
    :y => [3, 4, 9],
    :type => 'scatter',
    :name => 'Andrew N'
  }
]

layout = {
  :xaxis => { :title => 'times' },
  :yaxis => { :title => 'pokemon caught', :range => [0, 10] },
}

plot_spec = {
  :figure => {:data => data, :layout => layout},
  :format => :svg
}

plotly = Plotlyrb::ApiV2.auth_plotly('username', 'super secret API key')

plotly.plot_image(plot_spec, '/path/to/plot.svg')

TODO

  • Support height and width
  • Test more plot types
  • Use data structures/abstractions for plot types, data, etc. ?

Development

After checking out the repo, run bin/setup to install dependencies. 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.

If bundle exec rake release hangs after pushing changes and tags, you may need to kill it and authenticate against rubygems.org before trying again. First, make sure you have a rubygems account and have been added as an owner of the gem. Then you may authenticate from the command line by doing the following (sourced from stack overflow of course)

curl -u <rubygems-handle> https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plotlyrb. 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.