hubcaps
a rust interface for github
/!\ planned API changes
The goal and motivation behind these are not to intentionally make breaking changes, but rather to adopt evolving community standards
- replace builder implementations with derive_builder crate type derivation
installation
Add the following to your Cargo.toml
filter
[]
= "0.4"
usage
Basic usage requires a user agent string (because github requires this),
optionally a flavor of hubcaps::Credentials
for making requests as a particular
github user, and a tokio_core Handle
.
For user authenticated requests you'll typically want to use
hubcaps::Credentials::Token
with a
personal access token.
extern crate hyper;
extern crate hubcaps;
extern crate tokio_core;
use Core;
use ;
Github instances define methods for accessing api services that map closely to their url structure.
As a convention, api methods that expect arguments are represented as functions that accept a struct representing those arguments with an optional builder interface for convenience of construction.
See examples directory for some getting started examples
repositories
Typically the reference point of most github services is a repository
let repo = github.repo;
With a repo instance on hand, you can access a number of sub services,
like labels
, deployments
, pulls
, issues
, releases
, and many more.
Each of this are named functions exported from the repo interface.
See examples directory for examples
branches
Branches is a service for listing repository branches
let branches = repo.branches;
labels
Labels is a service for tagging resources like issues and pulls with names which you can later group and filter on.
use LabelOptions;
let labels = repo.labels;
// create new labels
labels.create
deployments
Deployments is a service for orchestrating deployments of applications sourced from github repositories
let deployments = repo.deployments;
See examples directory for examples
pulls
Pulls is a service for issuing code change requests against a repository
let pulls = repo.pulls;
See examples directory for examples
issues
Issues is a service for tracking bugs for a repository
let issues = repo.issues;
See examples directory for examples
releases
Releases is a service for tracking changes for a stable releases of a versioned library or application
let releases = repo.releases;
gists
Gists is a service for micro repositories
let gists = github.gists;
See examples directory for examples
gists
Gists is a service for managing repository hooks
let hooks = repo.hooks;
See examples directory for examples
search
Search provides a raw string query search for indexed data. Currently only search for issues is supported
let search_issues = github.search.issues;
teams
Teams is a service for listing repository and organization teams
let teams = repo.teams;
See examples directory for examples
Doug Tangren (softprops) 2015-2017