diff --git a/README.md b/README.md index 34e4f8e..266e1f4 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,16 @@ __pip install donationalerts-api -U__ ![DA API](https://github.com/Fsoky/Donation-Alerts-API-Python/blob/main/images/logo-api.jpg) ## πŸ”₯ ΠŸΡ€ΠΎΡΡ‚ΠΎΠΉ ΠΏΡ€ΠΈΠΌΠ΅Ρ€ Ρ€Π°Π±ΠΎΡ‚Ρ‹ -Π’ этом ΠΏΡ€ΠΈΠΌΠ΅Ρ€Π΅ ΠΌΡ‹ логинимся Π² нашСм ΠΏΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠΈ с ΠΎΠΏΡ€Π΅Π΄Π΅Π»Π΅Π½Π½Ρ‹ΠΌΠΈ ΠΏΡ€Π°Π²Π°ΠΌΠΈ, ΠΏΠΎΠ»ΡƒΡ‡Π°Π΅ΠΌ _access_token_, послС Π² ΠΏΡ€Π΅ΠΌΠ΅Π½Π½ΠΎΠΉ `user` ΠΌΡ‹ ΠΏΠΎΠ»ΡƒΡ‡Π°Π΅ΠΌ JSON-ΠΎΠ±ΡŠΠ΅ΠΊΡ‚, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ содСрТится информация, Π² ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½ΠΎΠΉ `donation_list` Ρ‚ΠΎΠΆΠ΅ хранится информация, Ρ‚ΠΎΠ»ΡŒΠΊΠΎ ΡƒΠΆΠ΅ другая. И Ρ‚Π΅ΠΏΠ΅Ρ€ΡŒ Π²ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅ΠΌ Π½Π°ΡˆΡƒ ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½ΡƒΡŽ `user` +Π’ этом ΠΏΡ€ΠΈΠΌΠ΅Ρ€Π΅ ΠΌΡ‹ логинимся Π² нашСм ΠΏΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠΈ с ΠΎΠΏΡ€Π΅Π΄Π΅Π»Π΅Π½Π½Ρ‹ΠΌΠΈ ΠΏΡ€Π°Π²Π°ΠΌΠΈ, ΠΏΠΎΠ»ΡƒΡ‡Π°Π΅ΠΌ _access_token_, послС Π² ΠΏΡ€Π΅ΠΌΠ΅Π½Π½ΠΎΠΉ `user` ΠΌΡ‹ ΠΏΠΎΠ»ΡƒΡ‡Π°Π΅ΠΌ JSON-ΠΎΠ±ΡŠΠ΅ΠΊΡ‚, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ содСрТится информация, Π² ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½ΠΎΠΉ `donations` Ρ‚ΠΎΠΆΠ΅ хранится информация, Ρ‚ΠΎΠ»ΡŒΠΊΠΎ ΡƒΠΆΠ΅ другая. И Ρ‚Π΅ΠΏΠ΅Ρ€ΡŒ Π²ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅ΠΌ Π½Π°ΡˆΡƒ ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½ΡƒΡŽ `user` -`DonationAlertsApi` - основной класс для Ρ€Π°Π±ΠΎΡ‚Ρ‹ с DA API, Π½Π° Π²Ρ…ΠΎΠ΄ ΠΏΡ€ΠΈΠ½ΠΈΠΌΠ°Π΅Ρ‚ _client_id_, _client_secret_, _redirect_url_, _scopes_ \ +`DonationAlertsApi` - основной класс для Ρ€Π°Π±ΠΎΡ‚Ρ‹ с DA API, Π½Π° Π²Ρ…ΠΎΠ΄ ΠΏΡ€ΠΈΠ½ΠΈΠΌΠ°Π΅Ρ‚ _client_id_, _client_secret_, _redirect_uri_, _scopes_ \ `Scopes` - ΠΏΠΎΠ·Π²ΠΎΠ»ΠΈΡ‚ Π²Π°ΠΌ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ ряд ΠΏΡ€Π°Π² Π² ΡƒΠ΄ΠΎΠ±Π½ΠΎΠΌ Ρ„ΠΎΡ€ΠΌΠ°Ρ‚Π΅, всС ΠΏΡ€Π°Π²Π° ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΠΎΡΠΌΠΎΡ‚Ρ€Π΅Ρ‚ΡŒ Π² [ΠΎΡ„. Π΄ΠΎΠΊΡƒΠΌΠ΅Π½Ρ‚Π°Ρ†ΠΈΠΈ](https://www.donationalerts.com/apidoc#authorization__scopes), Ρ‚Π°ΠΊΠΆΠ΅ ΠΈΠΌΠ΅Π΅Ρ‚ Π°Ρ‚Ρ€ΠΈΠ±ΡƒΡ‚ _ALL_SCOPES_ для ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‡ΠΈ всСх ΠΏΡ€Π°Π² сразу (Scopes.ALL_SCOPES) -```python -from flask import Flask, redirect -from donationalerts_api import DonationAlertsApi, Scopes +```py +from flask import Flask, redirect, request + +from donationalerts_api import DonationAlertsApi +from donationalerts_api.modules import Scopes app = Flask(__name__) api = DonationAlertsApi("client id", "client secret", "http://127.0.0.1:5000/login", [Scopes.USER_SHOW, Scopes.DONATION_INDEX]) @@ -29,13 +31,13 @@ def index(): @app.route("/login", methods=["get"]) def login(): - code = api.get_code() + code = request.args.get("code") # ΠŸΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ Π½ΡƒΠΆΠ½Ρ‹ΠΉ ΠΊΠΎΠ΄ для access token access_token = api.get_access_token(code) - user = api.get_user(access_token) - donation_list = api.get_donations(access_token) + user = api.user(access_token) + donations = api.donations_list(access_token) # ΠŸΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ список Π΄ΠΎΠ½Π°Ρ‚ΠΎΠ² - return user + return user.objects # Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ JSON object if __name__ == "__main__": app.run(debug=True) @@ -46,14 +48,18 @@ if __name__ == "__main__": ![Π’ΠžΠšΠ•Π](https://github.com/Fsoky/Donation-Alerts-API-Python/blob/main/images/example_alert_2.png) -```python +```py from donationalerts_api import Alert alert = Alert("token") @alert.event() def new_donation(event): - print(event) + """ ΠŸΡ€ΠΈΠΌΠ΅Ρ€ обращСния + event.username - ΠΏΠΎΠ»ΡƒΡ‡Π°Π΅Ρ‚ Π½ΠΈΠΊΠ½Π΅ΠΉΠΌ Π΄ΠΎΠ½Π°Ρ‚Π΅Ρ€Π° + event.objects - Π²Π΅Ρ€Π½ΡƒΡ‚ΡŒ JSON object + """ + print(event) # Π’Ρ‹Π²Π΅Π΄Π΅Ρ‚ всС доступныС Π°Ρ‚Ρ€ΠΈΠ±ΡƒΡ‚Ρ‹, ΠΊ ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΌ ΠΌΠΎΠΆΠ½ΠΎ ΠΎΠ±Ρ€Π°Ρ‚ΠΈΡ‚ΡŒΡΡ ``` ВсС ΠΏΡ€ΠΈΠΌΠ΅Ρ€Ρ‹ Π²Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΠΎΡΠΌΠΎΡ‚Ρ€Π΅Ρ‚ΡŒ Π² ΠΏΠ°ΠΏΠΊΠ΅ [Examples](https://github.com/Fsoky/Donation-Alerts-API-Python/tree/main/examples) \