FastComments.com

FastComments Python SDK


To je uradni Python SDK za FastComments.

Uradni Python SDK za FastComments API

Repozitorij

Ogled na GitHubu


Namestitev Internal Link

Namestitev s GitHub-a

Namestite neposredno iz oznake izdaj (priporočeno, popolnoma reproducibilno):

pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0

Zakažite oznako namesto veje, da so gradnje določljive. Enak zapis deluje v requirements.txt:

fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0

Vsaka označena GitHub izdaja ima tudi priloženo zgrajeno wheel, če raje neposredno namestite binarni artefakt.

Vsebina knjižnice

Ta knjižnica vsebuje dva modula: ustvarjenega API odjemalca in jedrno Python knjižnico, ki vsebuje ročno napisane pripomočke, ki olajšajo delo z API-jem, vključno s podporo za SSO.

Javni in zaščiteni API-ji

Za API odjemalca so na voljo trije razredi, DefaultApi, PublicApi in ModerationApi. DefaultApi vsebuje metode, ki zahtevajo vaš API ključ, PublicApi vsebuje metode, ki jih je mogoče izvesti neposredno iz brskalnika/mobilne naprave itd. brez avtentikacije. ModerationApi ponuja obsežen nabor živo in hitro moderiranje API-jev. Vsaka metoda ModerationApi sprejme parameter sso in se lahko avtenticira prek SSO ali FastComments.com seje piškotka.

Opombe Internal Link

ID-ji za broadcast

V nekaterih API klicih boste opazili, da morate posredovati broadcast_id. Ko prejmete dogodke, boste to ID dobili nazaj, tako da boste vedeli, da morate dogodek ignorirati, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli storiti, saj zagotavlja najboljšo izkušnjo). Tukaj posredujte UUID. ID naj bo dovolj enoličen, da se v isti seji brskalnika ne pojavi dvakrat.

Zahteve Internal Link


  • Python >= 3.8

Osnovna namestitev je čista standardna knjižnica in zagotavlja SSO pripomočke. Generiran API odjemalec (DefaultApi/PublicApi/ModerationApi) potrebuje dodatni paket client, ki potegne urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 in typing-extensions >= 4.0.0:

pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"

Potrebujete pomoč?

Če naletite na težave ali imate vprašanja glede Python SDK, prosimo:

Prispevanje

Prispevki so dobrodošli! Obiščite repozitorij na GitHubu za smernice glede prispevkov.