Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.04 KB

README.md

File metadata and controls

52 lines (31 loc) · 2.04 KB
Raw

CanvasLmsApi

A simple ruby API client for CanvasLMS.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

gem install canvas_lms_api

Usage

canvas_client = CanvasLmsApi::Client.new("https://your.canvas.com", "your API Key")

Todo

-[ ] Add YARD doc -[ ] Remove Results.coalesce_results

Contributing

  1. Fork it ( https://github.com/christopher-b/canvas_lms_api/fork )
  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 a new Pull Request

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/christopher-b/canvas_lms_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 CanvasLms::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.