FastComments.com

FastComments SDK για Python


Αυτό είναι το επίσημο Python SDK για το FastComments.

Επίσημο Python SDK για το API του FastComments

Αποθετήριο

Προβολή στο GitHub


Εγκατάσταση Internal Link

Εγκατάσταση από το GitHub

Εγκαταστήστε απευθείας από μια ετικέτα έκδοσης (συνιστάται, πλήρως αναπαραγώγιμο):

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

Καρφιτρώστε την ετικέτα αντί για ένα κλαδί ώστε οι κατασκευές να είναι καθοριστικές. Η ίδια μορφή λειτουργεί στο requirements.txt:

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

Κάθε ετικετοποιημένη GitHub Release περιλαμβάνει επίσης ένα προ-κατασκευασμένο wheel αν προτιμάτε να εγκαταστήσετε ένα δυαδικό τεχνητό αρχείο απευθείας.

Περιεχόμενα Βιβλιοθήκης

Αυτή η βιβλιοθήκη περιέχει δύο modules: τον παραγόμενο πελάτη API και τη βασική βιβλιοθήκη Python που περιέχει χειρογράφως γραμμένα βοηθητικά εργαλεία για να διευκολύνει τη χρήση του API, συμπεριλαμβανομένης της υποστήριξης SSO.

Δημόσια vs Ασφαλισμένα APIs

Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, και η PublicApi περιέχει μεθόδους που μπορούν να κληθούν απευθείας από έναν περιηγητή/συσκευή κινητής κ.λπ. χωρίς έλεγχο ταυτότητας. Η ModerationApi παρέχει μια εκτενή σειρά ζωντανών και γρήγορων APIs διαmoderation. Κάθε μέθοδος της ModerationApi δέχεται μια παράμετρο sso και μπορεί να πιστοποιηθεί μέσω SSO ή ενός cookie συνεδρίας FastComments.com.

Σημειώσεις Internal Link

Αναγνωριστικά Broadcast

Θα δείτε ότι πρέπει να περάσετε ένα broadcast_id σε ορισμένες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, οπότε θα ξέρετε να αγνοήσετε το συμβάν εάν σκοπεύετε να εφαρμόσετε αλλαγές οπτιμιστικά στην πλευρά του πελάτη (κάτι που μάλλον θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε εδώ ένα UUID. Το ID πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μία συνεδρία προγράμματος περιήγησης.

Απαιτήσεις Internal Link


  • Python >= 3.8

Η βασική εγκατάσταση είναι pure-stdlib και παρέχει τα εργαλεία SSO. Ο παραγόμενος πελάτης API (DefaultApi/PublicApi/ModerationApi) χρειάζεται το πρόσθετο client, το οποίο φέρνει το urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 και typing-extensions >= 4.0.0:

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

Χρειάζεστε βοήθεια;

Εάν αντιμετωπίσετε κάποιο πρόβλημα ή έχετε ερωτήσεις σχετικά με το Python SDK, παρακαλούμε:

Συνεισφορές

Οι συνεισφορές είναι ευπρόσδεκτες! Παρακαλούμε επισκεφθείτε το αποθετήριο στο GitHub για οδηγίες συνεισφοράς.