mirror of
https://github.com/RGBCube/GitHubWrapper
synced 2025-07-24 23:17:43 +00:00
Changed README to markdown from reStructuredText
This commit is contained in:
parent
ce65016fa3
commit
ce197a71b4
2 changed files with 52 additions and 58 deletions
52
README.md
Normal file
52
README.md
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
# GitHub API Wrapper
|
||||||
|
|
||||||
|
[](https://discord.gg/DWhwsQ5TsT)
|
||||||
|
|
||||||
|
Easy to use Python wrapper for the **GitHub API**.
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
- Modern Pythonic Interface
|
||||||
|
- Easy to use
|
||||||
|
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
|
||||||
|
**Python 3.8 or higher is required to run the library**
|
||||||
|
|
||||||
|
To install the library, run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# On Linux or MacOS
|
||||||
|
python3 -m pip install -U github
|
||||||
|
|
||||||
|
# On Windows
|
||||||
|
py -m pip install -U github
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- ## Quick Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import github
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
client = await github.GHClient()
|
||||||
|
|
||||||
|
user = await client.get_user(user='GithubPythonBot')
|
||||||
|
|
||||||
|
print(user)
|
||||||
|
print(user.html_url)
|
||||||
|
|
||||||
|
asyncio.run(main())
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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>`_
|
||||||
|
- `GitHub API Documentation <https://docs.github.com/en/rest>`_
|
58
README.rst
58
README.rst
|
@ -1,58 +0,0 @@
|
||||||
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 is required to run the library**
|
|
||||||
|
|
||||||
To install the library, run the following command:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
# On Linux or MacOS
|
|
||||||
python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
|
|
||||||
|
|
||||||
# On 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()
|
|
||||||
|
|
||||||
user = await client.get_user(user='GithubPythonBot')
|
|
||||||
|
|
||||||
print(user)
|
|
||||||
print(user.html_url)
|
|
||||||
|
|
||||||
asyncio.run(main())
|
|
||||||
|
|
||||||
.. 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>`_
|
|
||||||
- `GitHub API Documentation <https://docs.github.com/en/rest>`_
|
|
Loading…
Add table
Add a link
Reference in a new issue