FastComments.com

FastComments Python SDK


Ovo je službeni Python SDK za FastComments.

Službeni Python SDK za FastComments API

Repozitorij

Pogledaj na GitHubu


Instalacija Internal Link

Instaliraj s GitHub-a

Instaliraj izravno iz oznake izdanja (preporučeno, potpuno reproducibilno):

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

Zakači oznaku umjesto grane kako bi izgradnje bile determinističke. Isti oblik radi u requirements.txt:

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

Svako označeno GitHub Release također ima priloženi izgrađeni wheel ako radije izravno instaliraš binarni artefakt.

Sadržaj biblioteke

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

Javni vs zaštićeni API-ji

Za API klijent postoje tri klase, DefaultApi, PublicApi i ModerationApi. DefaultApi sadrži metode koje zahtijevaju vaš API ključ, a PublicApi sadrži metode koje se mogu izravno pozvati iz preglednika/mobilnog uređaja/itd. bez autentifikacije. ModerationApi pruža opsežan skup live i brzih moderacijskih API-ja. Svaka metoda ModerationApi prihvaća parametar sso i može se autentificirati putem SSO-a ili FastComments.com sesijskog kolačića.

Napomene Internal Link

Broadcast ID-ovi

Vidjet ćete da trebate proslijediti broadcast_id u nekim API pozivima. Kada primite događaje, dobit ćete natrag ovaj ID, pa ćete znati zanemariti događaj ako planirate optimistično primijeniti promjene na klijentu (što ćete vjerojatno htjeti učiniti budući da nudi najbolje korisničko iskustvo). Ovdje proslijedite UUID. ID bi trebao biti dovoljno jedinstven da se ne pojavi dvaput u istoj sesiji preglednika.

Zahtjevi Internal Link


  • Python >= 3.8

Osnovna instalacija je čista standardna biblioteka i pruža SSO alate. Generirani API klijent (DefaultApi/PublicApi/ModerationApi) zahtijeva dodatak client, 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.1.0"

Trebate pomoć?

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

Doprinosi

Doprinosi su dobrodošli! Posjetite GitHub repozitorij za smjernice za doprinos.