https://github.com/markfchavez/github_client-ruby
Ruby wrapper for GitHub API
https://github.com/markfchavez/github_client-ruby
Last synced: over 1 year ago
JSON representation
Ruby wrapper for GitHub API
- Host: GitHub
- URL: https://github.com/markfchavez/github_client-ruby
- Owner: MarkFChavez
- License: mit
- Created: 2019-02-03T08:22:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-09T12:20:36.000Z (over 7 years ago)
- Last Synced: 2025-03-07T11:19:04.169Z (over 1 year ago)
- Language: Ruby
- Size: 106 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GithubClient
Ruby wrapper for GitHub API.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'github_client'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install github_client
### Initialize the Client
```ruby
client = GithubClient.new(
host: "https://api.github.com",
access_token: "access token",
)
```
### Or, apply it globally
```ruby
GithubClient.configure do |config|
config.host = "https://api.github.com"
config.access_token = "your access token"
end
```
## Usage
See `spec/acceptance` for usage.
## 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/MarkFChavez/github_client-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 GithubClient::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/github_client-ruby/blob/master/CODE_OF_CONDUCT.md).