FastComments.com

FastComments Python SDK

Ovo je zvanični Python SDK za FastComments.

Zvanični Python SDK za FastComments API

Repozitorijum

Pogledajte na GitHub-u


Instalacija Internal Link

Instalacija sa GitHub-a

Instalirajte direktno iz taga verzije (preporučeno, potpuno reprodukovano):

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

Fiksirajte tag umesto grane kako bi izgradnje bile determinističke. Isti oblik radi u requirements.txt:

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

Svaki označeni GitHub Release takođe ima priloženu izgrađenu wheel datoteku ako više volite da instalirate binarni artefakt direktno.

Sadržaj biblioteke

Ova biblioteka sadrži dva modula: generisani API klijent i osnovnu Python biblioteku koja sadrži ručno napisane alate za olakšavanje rada sa API‑jem, uključujući SSO podršku.

Javna vs Zaštićena API‑ja

Za API klijent postoje tri klase, DefaultApi, PublicApi i ModerationApi. DefaultApi sadrži metode koje zahtevaju vaš API ključ, dok PublicApi sadrži metode koje se mogu pozvati direktno iz pregledača/mobilnog uređaja/itd. bez autentifikacije. ModerationApi pruža opsežan skup live i brzih API‑ja za moderaciju. Svaka metoda ModerationApi prihvata sso parametar i može se autentifikovati putem SSO‑a ili FastComments.com kolačića sesije.

Napomene Internal Link


Broadcast ID-ovi

Videćete da treba da prosledite broadcast_id u nekim API pozivima. Kada primite događaje, dobićete ovaj ID nazad, tako da ćete znati da ignorišete događaj ako planirate optimistično primeniti izmene na klijentu (što ćete verovatno želeti, jer pruža najbolje iskustvo). Prosledite ovde UUID. ID bi trebalo da bude dovoljno jedinstven da se ne pojavi dvaput tokom sesije u pregledaču.

Zahtevi Internal Link

  • Python >= 3.8

Osnovna instalacija je čisto standardna biblioteka i pruža SSO alate. Generisani API klijent (DefaultApi/PublicApi/ModerationApi) zahteva client dodatak, koji povlači urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 i typing-extensions >= 4.0.0:

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

Trebate pomoć?

Ako naiđete na bilo kakve probleme ili imate pitanja u vezi Python SDK-a, molimo vas:

Doprinosi

Doprinosi su dobrodošli! Molimo posetite GitHub repozitorijum za smernice za doprinos.