FastComments.com

FastComments Python SDK

Ceci est le SDK Python officiel pour FastComments.

SDK Python officiel pour l'API FastComments

Dépôt

Voir sur GitHub


Installation Internal Link

PyPI

pip install fastcomments

Contenu de la bibliothèque

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

API publiques vs API sécurisées

Pour le client API, il existe deux classes, DefaultApi et PublicApi. DefaultApi contient des méthodes qui nécessitent votre clé API, et PublicApi contient des appels d'API qui peuvent être effectués directement depuis un navigateur, un appareil mobile, etc., sans authentification.

Notes Internal Link

Identifiants de diffusion

Vous verrez que vous devez transmettre un broadcast_id dans certaines requêtes d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permet de l'ignorer si vous prévoyez d'appliquer de façon optimiste des modifications côté client (ce que vous voudrez probablement faire puisque cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois dans une session du navigateur.

Prérequis Internal Link


  • Python >= 3.8
  • urllib3 >= 1.25.3
  • python-dateutil >= 2.8.2
  • pydantic >= 2.0.0
  • typing-extensions >= 4.0.0

Besoin d'aide ?

Si vous rencontrez des problèmes ou avez des questions au sujet du SDK Python, veuillez :

Contribuer

Les contributions sont les bienvenues ! Veuillez consulter le référentiel GitHub pour les directives de contribution.