Things to do

• Broader exception handling
• Unit test Resource class
• Pagination
• Unit test exception handling using requests-mock
• Convert style to pep8 and enforce style on future code
• Write docs (maybe just the README)
• pep8 linting in CI
• Code coverage
• Maybe wrapper class parity with octokit.rb?

/cc @octokit/ucsd-octokit-py

If the endpoint has an attribute that is named the same as any of the properties of Resource they cannot be accessed using the dot operator. For example:

c = octokit.Client()

c.current_user.name

At the moment, our Client is subclassing Resource. Resource is our workhorse that performs all the logic for querying the GitHub API for data. To address the issue of global state we created a wrapper around Session that maintains the state for the Client and we pass this session around through the Resource tree. While this addresses functionality needs, this is hacky and couples state to Session instead of Client. Ideally, it should be the case that Client maintains state while at the same time being able to enhance the functionality of the API, such as pagination and rate limiting.

Design

• Structure and design

HTTP Idioms

• Post
• Put
• Head
• Delete

Configurability

• Make 'https://api.github.com' configurable in the code

Test

• Write test for each of the idioms

/cc @howeik @tchangg