<commit_before># GithubAPI

[![Gem Version](https://badge.fury.io/rb/github_api.png)](http://badge.fury.io/rb/github_api)[![Build Status](https://secure.travis-ci.org/peter-murach/github.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/github.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]

[travis]: http://travis-ci.org/peter-murach/github
[gemnasium]: https://gemnasium.com/peter-murach/github
[codeclimate]: https://codeclimate.com/github/peter-murach/github

[Wiki](https://github.com/peter-murach/github/wiki) | [RDocs](http://rubydoc.info/github/peter-murach/github/master/frames)

A Ruby wrapper for the GitHub REST API v3.

Supports all the API methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern.

## Features

* Intuitive GitHub API interface navigation.
* Modular design allows for working with parts of API.
* Fully customizable including advanced middleware stack construction.
* Its comprehensive, you can request all GitHub API resources.
* Requests pagination.
* Easy error handling.
* Custom mime types specification (Status: TODO)
* Flexible arguments parsing (Status: In progress).
* Request results caching (Status: TODO)
* Fully tested with test coverage above 90% with over 1,300 specs and 700 features.

## Installation

Install the gem by issuing

```ruby
gem install github_api
```

or put it in your Gemfile and run `bundle install`

```ruby
gem "github_api"
```

## Usage

To start using the gem you can either perform direct call on the `Github`

```ruby
Github.repos.list user: 'wycats'
```<commit_msg>Update the library blurb info.<commit_after># GithubAPI

[![Gem Version](https://badge.fury.io/rb/github_api.png)](http://badge.fury.io/rb/github_api)[![Build Status](https://secure.travis-ci.org/peter-murach/github.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/github.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]

[travis]: http://travis-ci.org/peter-murach/github
[gemnasium]: https://gemnasium.com/peter-murach/github
[codeclimate]: https://codeclimate.com/github/peter-murach/github

[Wiki](https://github.com/peter-murach/github/wiki) | [RDocs](http://rubydoc.info/github/peter-murach/github/master/frames)

A Ruby wrapper for the GitHub REST API v3.

Supports all the API methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern.

## Features

* Intuitive GitHub API interface navigation.
* Modular design allows for working with parts of API.
* Fully customizable including advanced middleware stack construction.
* Its comprehensive, you can request all GitHub API resources.
* Requests pagination with convenient DSL.
* Easy error handling split for client and server type errors.
* Supports multithreaded environment.
* Custom mime types specification (Status: TODO)
* Flexible arguments parsing (Status: In progress).
* Request results caching (Status: TODO)
* Fully tested with test coverage above 90% with over 1,400 specs and 700 features.

## Installation

Install the gem by issuing

```ruby
gem install github_api
```

or put it in your Gemfile and run `bundle install`

```ruby
gem "github_api"
```

## Usage

To start using the gem you can either perform direct call on the `Github`

```ruby
Github.repos.list user: 'wycats'
```
{'fraction_non_alphanumeric': 0.12074134641591715, 'fraction_numerical': 0.007086399563913873, 'mean_word_length': 5.066115702479339, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4241582', 'n_tokens_mistral': 1221, 'n_tokens_neox': 1137, 'n_words': 365}