ghrequestor

v0.1.6
A simple, resilient GitHub API client for bulk retrieval of GitHub resources
github api rate-limit retry pagination

Version License Downloads

GHRequestor

A simple, resilient GitHub API client that:

  • Is great for bulk fetching of resources from the GitHub API.
  • Retries on errors and various forms of rate-limiting.
  • Backs off as you reach your API limit.
  • Automatically fetches all pages of a multi-page resource.
  • Reports comprehensive data on number of pages fetched, retry attempts, and length of delays.

GHRequestor is a relatively low-level facility intended for traversing large graphs of GitHub resources. Its primary usecase is GHCrawler, an engine that walks subsections of GitHub collecting related resources. This not intended to replace great modules like octonode or github.

Examples

Coming...

Contributing

The project team is more than happy to take contributions and suggestions.

To start working, run npm install in the repository folder to install the required dependencies.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Metadata

  • MIT
  • Whatever
  • Jeff McAffer
  • released 11/15/2016

Downloads

Maintainers