mirror of
https://gitflic.ru/project/santaspeen/gitflic.git
synced 2026-04-16 13:19:53 +00:00
Readme update
This commit is contained in:
45
README.md
45
README.md
@@ -1,2 +1,45 @@
|
||||
# gitflic
|
||||
gitflic api wrapper
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/sssr-dev/api-server/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/sssr-dev/api-server?style=for-the-badge"></a>
|
||||
<a href="https://github.com/sssr-dev/api-server/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/sssr-dev/api-server?style=for-the-badge"></a>
|
||||
<a href="https://github.com/SantaSpeen"><img src="https://github.com/SantaSpeen/gitflic/blob/master/.readme_files/magic_logo.svg" alt="magic"></a>
|
||||
<br/>
|
||||
<a href="./examples/auth_with_token_and_reg_call.py">
|
||||
<img src="https://github.com/SantaSpeen/gitflic/blob/master/.readme_files/preview.png" alt="preview ds">
|
||||
</a>
|
||||
<br/>
|
||||
</p>
|
||||
### Installation
|
||||
|
||||
Install via pip:
|
||||
|
||||
`pip install gitflic`
|
||||
|
||||
### Example:
|
||||
|
||||
All examples in [examples](./examples) dir.
|
||||
|
||||
```python
|
||||
from gitflic import Gitflic, GitflicAuth
|
||||
|
||||
token = "token_here" # https://gitflic.ru/settings/oauth/token/create
|
||||
|
||||
gf_session = GitflicAuth(token)
|
||||
gf = Gitflic(gf_session)
|
||||
|
||||
me_call = gf.call("/user/me")
|
||||
print(me_call)
|
||||
|
||||
# Register call
|
||||
gf.user = gf.reg_call("/user")
|
||||
|
||||
# Request "https://api.gitflic.ru/user/me"
|
||||
me_with_reg = gf.user("/me")
|
||||
print(me_with_reg)
|
||||
print("Is me_with_reg equals me_call:", me_with_reg == me_call)
|
||||
|
||||
# Request "https://api.gitflic.ru/user/a4189db1-3e4f-4c2e-8adf-19c58c28e61f"
|
||||
author = gf.user("/a4189db1-3e4f-4c2e-8adf-19c58c28e61f")
|
||||
print("\nAuthor: ", author)
|
||||
```
|
||||
Reference in New Issue
Block a user