FastComments.com

FastComments Python SDK


To jest oficjalne SDK Pythona dla FastComments.

Oficjalne SDK Pythona dla API FastComments

Repozytorium

Zobacz na GitHub


Instalacja Internal Link

Instalacja z GitHub

Instaluj bezpośrednio z tagu wydania (zalecane, w pełni odtwarzalne):

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

Zablokuj tag zamiast gałęzi, aby kompilacje były deterministyczne. Ten sam format działa w requirements.txt:

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

Każde otagowane wydanie GitHub ma również dołączony zbudowany pakiet wheel, jeśli wolisz zainstalować binarny artefakt bezpośrednio.

Zawartość biblioteki

Ta biblioteka zawiera dwa moduły: wygenerowanego klienta API oraz podstawową bibliotekę Pythona, która zawiera ręcznie napisane narzędzia ułatwiające pracę z API, w tym obsługę SSO.

Publiczne vs zabezpieczone API

Dla klienta API dostępne są trzy klasy, DefaultApi, PublicApi i ModerationApi. DefaultApi zawiera metody wymagające klucza API, a PublicApi zawiera metody, które mogą być wywoływane bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelnienia. ModerationApi oferuje rozbudowany zestaw szybkich i bieżących API moderacji. Każda metoda ModerationApi przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub ciasteczka sesji FastComments.com.

Notatki Internal Link

Identyfikatory Broadcast

Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcast_id. Kiedy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli zamierzasz optymistycznie zastosować zmiany po stronie klienta (co prawdopodobnie będziesz chciał zrobić, ponieważ zapewnia to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, żeby nie wystąpił dwukrotnie w sesji przeglądarki.

Wymagania Internal Link


  • Python >= 3.8

Podstawowa instalacja jest czystą biblioteką standardową i zapewnia narzędzia SSO. Wygenerowany klient API (DefaultApi/PublicApi/ModerationApi) wymaga dodatkowego pakietu client, który pobiera urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 oraz typing-extensions >= 4.0.0:

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

Potrzebujesz pomocy?

Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK Pythona, prosimy:

Contributing

Wkład jest mile widziany! Proszę odwiedzić repozytorium GitHub w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.