Separate documentation for generic agithub use and GitHub client specific use
Change generic examples to functional code that runs
Create new "Specific REST APIs" section
Fix malformed markdown
Add extensibility example
Pull details about headers and body parameters out of semantics section into dedicated parameters section
Originally, the Client.request() method did not pass the response
headers back to the user, to avoid unnecessary distraction. But,
obviously, the headers will often be needed for further processing.
Therefore, we make them available as the Github.getheaders() method.
- Client.request()
stash away the headers of the last response in self.headers
- Github.getheaders()
retrieve the headers from the client
agithub has really come a long way since its introduction, and the
README needs to reflect the new state of things better. Instead of being
a quick stop-gap to help me grasp the Github API, it is featureful ---
and perhaps even robust.
I'm not working with Python or the Github API right now, so this project
has fallen into disrepair. However, I'm confidient that /you/ could fix
it. :-)