FastComments.com

FastComments Python SDK


Dette er den officielle Python SDK til FastComments.

Officiel Python SDK til FastComments API'en

Repository

Se på GitHub


Installation Internal Link

Installér fra GitHub

Installér direkte fra et udgivelsestag (anbefalet, fuldt reproducerbart):

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

Fastgør tagget i stedet for en gren, så builds er deterministiske. Den samme form fungerer i requirements.txt:

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

Hver tagget GitHub Release har også et bygget wheel vedhæftet, hvis du foretrækker at installere en binær artefakt direkte.

Biblioteksindhold

Dette bibliotek indeholder to moduler: den genererede API-klient og kerne‑Python‑biblioteket, som indeholder håndskrevne værktøjer for at gøre arbejdet med API’en lettere, inklusive SSO‑understøttelse.

Offentlige vs Sikrede API’er

Denne API‑klient har tre klasser, DefaultApi, PublicApi og ModerationApi. DefaultApi indeholder metoder, der kræver din API‑nøgle, og PublicApi indeholder metoder, som kan kaldes direkte fra en browser/mobil enhed osv. uden autentificering. ModerationApi leverer en omfattende suite af live‑ og hurtige moderations‑API’er. Hver ModerationApi‑metode accepterer en sso‑parameter og kan autentificere via SSO eller en FastComments.com‑sessions‑cookie.

Noter Internal Link

Broadcast-ID'er

Du vil se, at du skal sende et broadcast_id i nogle API-kald. Når du modtager hændelser, får du dette ID tilbage, så du kan ignorere hændelsen, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.

Krav Internal Link


  • Python >= 3.8

Den grundlæggende installation er ren standardbibliotek og leverer SSO‑værktøjerne. Den genererede API‑klient (DefaultApi/PublicApi/ModerationApi) kræver client‑ekstraen, som henter urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 og typing-extensions >= 4.0.0:

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

Brug for hjælp?

Hvis du støder på problemer eller har spørgsmål om Python SDK'et, så:

Bidrag

Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.