Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0x7466/octoprint-api-ruby
A client library to communicate with Octoprint API in Ruby.
https://github.com/0x7466/octoprint-api-ruby
Last synced: 19 days ago
JSON representation
A client library to communicate with Octoprint API in Ruby.
- Host: GitHub
- URL: https://github.com/0x7466/octoprint-api-ruby
- Owner: 0x7466
- License: mit
- Created: 2018-03-03T13:06:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-04T09:04:54.000Z (almost 7 years ago)
- Last Synced: 2025-01-01T13:08:47.286Z (25 days ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Octoprint API Client
[](https://travis-ci.org/tobiasfeistmantl/octoprint-api-ruby)
This client library makes it easy to use the Octoprint API in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'octoprint_api'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install octoprint_api
## Usage
```ruby
require 'octoprint'
octoprint = Octoprint.new('https://my-awesome-octoprint-server.com', 'MY_S3CURE_AP1_KEY')
octoprint.api.version # => {"api"=>"YOUR API VERSION", "server"=>"YOUR SERVER VERSION"}
```
### Wanna now more about the API?
[API Reference of Octoprint](http://docs.octoprint.org/en/master/api/index.html)
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tobiasfeistmantl/octoprint-api-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the OctoprintApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tobiasfeistmantl/octoprint-api-ruby/blob/master/CODE_OF_CONDUCT.md).