FastComments.com

FastComments Python SDK

Ово је званични Python SDK за FastComments.

Званични Python SDK за FastComments API

Репозиторијум

Погледај на GitHub


Инсталација Internal Link

Install from GitHub

Instalirajte direktno sa oznake izdanja (preporučeno, potpuno reproduktivno):

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

Zakačite 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.0.0

Svako označeno GitHub Release također ima priložen izgrađeni wheel ako radije instalirate binarni artefakt direktno.

Library Contents

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

Public vs Secured APIs

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 pozvati direktno iz pregledača/mobilnog uređaja itd. bez autentifikacije. ModerationApi pruža opsežan skup API‑ja za brzu i trenutnu moderaciju. Svaka metoda ModerationApi prihvata sso parametar i može se autentifikovati putem SSO‑a ili FastComments.com sesijske kolačiće.

Белешке 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, pa ćete znati da zanemarite događaj ako planirate optimistično primijeniti promjene na klijentu (što ćete vjerovatno htjeti, jer to pruža najbolje iskustvo). Proslijedite ovdje UUID. ID treba da bude dovoljno jedinstven da se ne pojavi dva puta tokom sesije preglednika.

Захтеви Internal Link


  • Python >= 3.8

Osnovna instalacija je čista standardna biblioteka i pruža SSO alate. Generisani API klijent (DefaultApi/PublicApi/ModerationApi) zahtijeva 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! Posjetite GitHub repozitorij za smjernice o doprinosu.