diff --git a/.readme_files/magic_logo.svg b/.readme_files/magic_logo.svg new file mode 100644 index 0000000..9ce5652 --- /dev/null +++ b/.readme_files/magic_logo.svg @@ -0,0 +1,40 @@ + + MADE WITH: MAGIC + + + + + + + + + + + + + + + + + + + + + + + + + + MAGIC BY + + + SantaSpeen + + + \ No newline at end of file diff --git a/.readme_files/preview.png b/.readme_files/preview.png new file mode 100644 index 0000000..f72f5f7 Binary files /dev/null and b/.readme_files/preview.png differ diff --git a/README.md b/README.md index 9fbf5ca..ccf9e7a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # gitflic -gitflic api wrapper + +

+ GitHub license + GitHub stars + magic +
+ + preview ds + +
+

+### 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) +``` \ No newline at end of file