Skip to content

Overview

Async PyOctocat

Async PyOctocat is a Python library for asynchronous interaction with GitHub API. I was pushed to create this library by the lack of an actively maintained and well documented asynchronous library that would allow quick and efficient high-level interaction with Github from code. I sincerely hope that one day this library can be said to be actively maintained and well documented.

Install#

1
pip install async_py_octocat

Features#

Due to the extensiveness of the Github API, functionalities require incremental implementation, and at this point PyOctocat is far from having all endpoints finished. Check Features Status section in our documentation to learn about features which are already available.

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import asyncio

from async_py_octocat import GitHub

gh_username: str = "Your Username"
gh_token_full: str = "ghp_..."  # your token


async def main():
    async with GitHub(gh_username, gh_token_full) as client:
        # by default .user() method returns currently authenticated user
        currently_authenticated = await client.user()
        print(currently_authenticated)

        # to get other user just pass username as first argument
        other_user = await client.user("Other User name")
        print(other_user)

        # to download repository owned by some user you can use
        # previously acquired User object
        repo = await currently_authenticated.repository("repo_name")
        print(repo)


if __name__ == "__main__":
    asyncio.run(main())

For full tutorial check out Quick Start section in our docs.

Documentation#

Online documentation is available at argmaster.github.io/async-py-octocat/

To build docs locally run

1
tox -e docs
Last update: July 3, 2022
Created: July 3, 2022