FastComments.com

SDK Python FastComments


Ceci est le SDK Python officiel pour FastComments.

SDK Python officiel pour l'API FastComments

Repository

Voir sur GitHub


Installation Internal Link

Installer depuis GitHub

Installez directement à partir d'une balise de version (recommandé, entièrement reproductible) :

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

Épinglez la balise plutôt qu'une branche afin que les builds soient déterministes. Le même format fonctionne dans requirements.txt :

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

Chaque version balisée GitHub Release possède également une roue compilée attachée si vous préférez installer directement un artefact binaire.

Contenu de la bibliothèque

Cette bibliothèque contient deux modules : le client API généré et la bibliothèque principale Python qui contient des utilitaires écrits à la main pour faciliter le travail avec l'API, y compris le support SSO.

API publiques vs sécurisées

Pour le client API, il existe trois classes, DefaultApi, PublicApi et ModerationApi. Le DefaultApi contient des méthodes qui nécessitent votre clé API, et le PublicApi contient des méthodes qui peuvent être appelées directement depuis un navigateur/appareil mobile/etc. sans authentification. Le ModerationApi fournit une suite étendue d'API de modération en temps réel et rapides. Chaque méthode du ModerationApi accepte un paramètre sso et peut s'authentifier via SSO ou un cookie de session FastComments.com.

Remarques Internal Link

Identifiants de diffusion

Vous verrez que vous devez transmettre un broadcast_id dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permettra d'ignorer l'événement si vous prévoyez d'appliquer de manière optimiste des modifications côté client (ce que vous voudrez probablement faire car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.

Prérequis Internal Link


  • Python >= 3.8

L'installation de base est pure‑stdlib et fournit les utilitaires SSO. Le client API généré (DefaultApi/PublicApi/ModerationApi) nécessite l'extra client, qui récupère urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 et typing-extensions >= 4.0.0 :

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


Besoin d'aide ?

Si vous rencontrez des problèmes ou avez des questions concernant le SDK Python, veuillez :

Contribuer

Les contributions sont les bienvenues ! Veuillez consulter le dépôt GitHub pour les consignes de contribution.