Service	Status
TravisCI
DependencyCI
AppveyorCI
CodeCov
crates.io

Pure Rust bindings to the Github API

Please look at the endpoints docs to see which endpoints are currently covered in the API.

github-rs is intended to work on all tier 1 supported Rust systems:

• Windows
• Linux
• MacOSX

• Have a robust API where everything is error handled properly to avoid panics of any kind. A library is the base of an application and should be a solid foundation to be built upon
• Cover all Github stable endpoints. Anything that's deprecated and beta should be obtained only through configuration for those features. As deprecated endpoints are removed from Github so too should they be removed from this library.
• Having stability as part of the API. As such effort will be taken to make sure this code compiles on stable Rust, rather than nightly.
• Ease of use. The complexity should be hidden from those not hacking on the code itself.
• Documentation of everything so not only is it easy to hack on but finding out how to use the library should be easy to find.

Add the following to your Cargo.toml

[dependencies]
github-rs = "0.5"

Then in your lib.rs or main.rs file add:

extern crate github_rs
use github_rs::client::Github;

Now you can start making queries. Here's a small example to get your user information:

extern crate github_rs;
use github_rs::client::Github;

fn main() {
    let client = Github::new("API TOKEN");
    let me = client.get()
                   .user()
                   .execute();
    match me {
        Ok((headers, status, json)) => {
            println!("{}", headers);
            println!("{}", status);
            if let Some(json) = json{
                println!("{}", json);
            }
        },
        Err(e) => println!("{}", e)
    }
}

• GitHub API Reference Docs
• See the design docs for more information.

See CONTRIBUTING.md for more information.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.