throttle_github3.py

import time

from github3.models import GitHubCore


def throttle_github(github_like, requests_needed):
    """Takes any github3 objects (repo, org, etc) and will throttle if there are
       not at least requests_needed requests remianing before the API starts
       throttling.  If there are not enough requests left, sleep until the window
       resets. Note this uses up one API call to get the rate limit headers, so be
       judicious in its use."""
    if not isinstance(github_like, GitHubCore):
        raise TypeError("Expected a GitHubCore object, got a {0}".format(type(github_like)))

    response = github_like._get(github_like._github_url + '/rate_limit')
    rate_limit = int(response.headers['X-RateLimit-Limit'])
    if requests_needed > rate_limit:
        raise ValueError("Maximum window for requests is {0}, given {1}".format(rate_limit, requests_needed))

    remaining_requests = int(response.headers['X-RateLimit-Remaining'])

    if remaining_requests < requests_needed:
        reset_window = int(response.headers['X-RateLimit-Reset'])
        throttle_time = reset_window - time.time()
        log.info("Throtting Github for %s seconds", throttle_time)
        time.sleep(throttle_time)