README.md

github-rs

Service	Status
TravisCI
DependencyCI
AppveyorCI
CodeCov
crates.io

Pure Rust bindings to the Github V3 API. If you want bindings to the V4 library see the github-graphql-rs library.

Incomplete Bindings

Please look at the endpoints docs to see which endpoints are currently covered in the API. This is for the Github V3 API.

Dependencies and Support

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

• Windows
• Linux
• MacOSX

github-rs supports rustls and rust-native-tls for TLS connectivity. rustls is used by default, but one can toggle support with Cargo features:

[dependencies.github-rs]
version = "0.6"
default-features = false
features = ["rust-native-tls"]

Since rustls depends on ring for cryptography, hardware support is limited to what ring supports, currently ARM and x86 (both 32- and 64-bit). If you're compiling for other architectures then you may use the rust-native-tls feature for maximum portability.

Minimum Compiler Version

Due to the use of certain features github-rs requires rustc version 1.18 or higher.

Project Aims

• 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.

Getting Started

Add the following to your Cargo.toml

[dependencies]
github-rs = "0.6"
serde_json = "1.0"

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

extern crate github_rs;
extern crate serde_json;
use github_rs::client::{Executor, Github};
use serde_json::Value;

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

extern crate github_rs;
extern crate serde_json;
use github_rs::client::{Executor, Github};
use serde_json::Value;

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

Hacking on the Library

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

Contributing

See CONTRIBUTING.md for more information.

License

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.

Licensing

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.