RGBCube/GitHubWrapper
1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-07-24 23:17:43 +00:00
Code Issues Activity Actions

Cleanup README

Browse source
This commit is contained in:
RGBCube 2022-06-21 18:50:16 +03:00
parent fad5b71bf7
commit fcf2897e46
1 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.rst
View file

@ -16,16 +16,16 @@ Key Features
Installing Installing
---------- ----------
**Python 3.8 or higher** **Python 3.8 or higher is required to run the library**
To install the library, run the following command To install the library, run the following command:
.. code:: sh .. code:: sh
#Linux/macOS # On Linux or MacOS
python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
#Windows # On Windows
py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
Quick Example Quick Example
@ -38,18 +38,21 @@ Quick Example
async def main(): async def main():
client = await github.GHClient() client = await github.GHClient()
return await client.get_user(user='GithubPythonBot')
user = asyncio.run(main()) user = await client.get_user(user='GithubPythonBot')
print(user)
print(user.html_url) print(user)
print(user.html_url)
asyncio.run(main())
.. code:: sh .. code:: sh
#Output # Output
<User login: 'GithubPythonBot', id: 104489846, created_at: 2022-04-27 07:31:26> <User login: 'GithubPythonBot', id: 104489846, created_at: 2022-04-27 07:31:26>
https://github.com/GithubPythonBot https://github.com/GithubPythonBot
Links Links
----- -----
`Discord Server <https://discord.gg/DWhwsQ5TsT>`_ - `Discord Server <https://discord.gg/DWhwsQ5TsT>`_
- `GitHub API Documentation <https://docs.github.com/en/rest>`_