RGBCube/GitHubWrapper
1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-10-31 05:52:45 +00:00
Code Issues Activity Actions
No description
185 commits 3 branches 0 tags 631 KiB
Find a file
Var 75cc05927f
Update .readthedocs.yaml
2022-05-16 11:51:03 +05:30
assets Added asset 2022-05-01 18:10:02 +01:00
docs Black format 2022-05-11 11:34:51 +05:30
github forgot version change 2022-05-11 11:46:24 +05:30
.gitignore fix dpcs 2022-05-02 00:14:09 +05:30
.readthedocs.yaml Update .readthedocs.yaml 2022-05-16 11:51:03 +05:30
LICENSE Update LICENSE 2022-04-27 12:41:55 +05:30
pyproject.toml Add pyproject for black formatting 2022-04-30 02:25:25 -04:00
README.rst README 2022-05-03 16:08:38 +05:30
requirements.txt . 2022-05-02 21:55:45 +05:30
setup.cfg Add .cfg 2022-04-27 22:07:17 +05:30
setup.py Black format 2022-05-11 11:34:51 +05:30

README.rst 

Github API Wrapper
==================

.. image:: https://discord.com/api/guilds/963406460107235328/widget.png
  :target: https://discord.gg/DWhwsQ5TsT
  :alt: Discord Server Invite

Easy to use Python wrapper for the **Github API**.

Key Features
------------
- Modern Pythonic Interface
- Easy to use


Installing
----------

**Python 3.8 or higher**

To install the library, run the following command

.. code:: sh

  #Linux/macOS
  python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
  
  #Windows
  py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
  
Quick Example
-------------
  
.. code:: py
  
  import github
  import asyncio
  
  async def main():
    client = await github.GHClient()
    return await client.get_user(user='GithubPythonBot')

  user = asyncio.run(main())
  print(user)
  print(user.html_url)

.. code:: sh
  #Output
  <User login: 'GithubPythonBot', id: 104489846, created_at: 2022-04-27 07:31:26>
  https://github.com/GithubPythonBot

  
Links
-----
`Discord Server <https://discord.gg/DWhwsQ5TsT>`_