4 releases

0.1.3 Feb 16, 2021
0.1.2 Feb 14, 2021
0.1.1 Feb 1, 2021
0.1.0 Jan 31, 2021

#32 in #github-api

23 downloads per month

MIT license

36KB
885 lines

ghrs

ghrs is a simple client for GitHub v3 API. This has a simple interface and blocking I/O, it avoids complexity unlike Async I/O, so it's so easy to use. ghrs is inspired by Octocrab.

The following modules are available now.

Usage

List pull requests.

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let client = Client::new();
    let mut current_page = client
        .pulls("owner", "repo")
        .list()
        .per_page(100)
        .page(1)
        .send()?;

    // You get pull requests.
    let mut pull_requests = current_page.take_items();

    // If you want to get next pages, see here.
    while let Some(next_page) = current_page.get_next_page() {
        current_page = next_page;
        pull_requests.extend(current_page.take_items());
    }

    Ok(())
}

GitHub Enterprise

If you use ghrs for GitHub Enterprise, set base_url.

// GET `https://github.your_company.com/api/v3/repos/owner/repo/issues`
let client = ghrs::Client::new();
let mut current_page = client
    .base_url("https://github.your_company.com/api/v3")
    .token("your_token")
    .issues("owner", "repo")
    .list()
    .send()?;

Contributing

License

MIT license

Dependencies

~6MB
~144K SLoC