FastComments.com

SDK Python di FastComments


Questo è l'SDK Python ufficiale per FastComments.

SDK Python ufficiale per l'API di FastComments

Repository

Visualizza su GitHub


Installazione Internal Link

Installa da GitHub

Installa direttamente da un tag di rilascio (consigliato, completamente riproducibile):

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

Fissa il tag anziché un branch così le build sono deterministiche. Lo stesso formato funziona in requirements.txt:

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

Ogni GitHub Release ha anche un wheel compilato allegato se preferisci installare direttamente un artefatto binario.

Contenuto della Libreria

Questa libreria contiene due moduli: il client API generato e la libreria core Python che contiene utility scritte a mano per facilitare l'uso dell'API, inclusa il supporto SSO.

API Pubbliche vs Sicure

Per il client API, ci sono tre classi, DefaultApi, PublicApi e ModerationApi. La DefaultApi contiene metodi che richiedono la tua chiave API, e la PublicApi contiene metodi che possono essere chiamati direttamente da un browser/dispositivo mobile/ecc. senza autenticazione. La ModerationApi offre una vasta suite di API di moderazione in tempo reale e veloci. Ogni metodo della ModerationApi accetta un parametro sso e può autenticarsi tramite SSO o un cookie di sessione FastComments.com.

Note Internal Link

ID di Broadcast

Vedrai che devi passare un broadcast_id in alcune chiamate API. Quando ricevi eventi, otterrai indietro questo ID, così saprai di ignorare l'evento se intendi applicare i cambiamenti in modo ottimistico sul client (cosa che probabilmente vorrai fare, poiché offre la migliore esperienza). Passa un UUID qui. L'ID dovrebbe essere sufficientemente unico da non ripetersi due volte in una sessione del browser.

Requisiti Internal Link


  • Python >= 3.8

L'installazione di base è pure-stdlib e fornisce le utility SSO. Il client API generato (DefaultApi/PublicApi/ModerationApi) richiede l'extra client, che include urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 e typing-extensions >= 4.0.0:

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

Hai bisogno di aiuto?

Se riscontri problemi o hai domande sul SDK Python, per favore:

Contribuire

I contributi sono benvenuti! Visita il repository GitHub per le linee guida sui contributi.