Skip to content

Quentinchampenois/grist-ruby

Repository files navigation

Tests suite

Grist

Grist ruby library to interact with Grist API.

Installation

Add this line to your application's Gemfile:

    gem "grist", git: "https://github.com/quentinchampenois/grist.git"

First release will be published on RubyGems

Examples

List all organizations

require "faraday"
require "grist"

client = Grist::Client.new(url: "http://localhost:8484", token: "API_TOKEN")
puts client.organizations

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/quentinchampenois/grist.

License

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

Code of Conduct

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