FastComments.com

FastComments Python SDK


Ово је званични Python SDK за FastComments.

Званични Python SDK за FastComments API

Репозиторијум

Погледајте на GitHub


Инсталација Internal Link

Install from GitHub

Instalirajte direktno sa oznakom izdanja (preporučeno, potpuno reprodukovano):

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

Zakačite oznaku umesto grane kako bi izgradnje bile determinističke. Isti format radi u requirements.txt:

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

Svaka označena GitHub Release takođe ima priloženi izgrađeni wheel ako više volite da instalirate binarni artefakt direktno.

Library Contents

Ova biblioteka sadrži dva modula: generisani API klijent i osnovnu Python biblioteku koja sadrži ručno napisane alate za olakšavanje rada sa API‑jem, uključujući SSO podršku.

Public vs Secured APIs

Za API klijent postoje tri klase, DefaultApi, PublicApi i ModerationApi. DefaultApi sadrži metode koje zahtevaju vaš API ključ, a PublicApi sadrži metode koje se mogu pozvati direktno iz pregledača/mobilnog uređaja/itd. bez autentifikacije. ModerationApi pruža opsežan skup live i brzih API‑ja za moderaciju. Svaka metoda ModerationApi prihvata parametar sso i može se autentifikovati putem SSO ili FastComments.com sesijskog kolačića.

Напомене Internal Link

Broadcast IDs

Videćete da treba da prosledite broadcast_id u nekim API pozivima. Kada primite događaje, dobićete ovaj ID nazad, pa ćete znati da ignorišete događaj ako planirate da optimistično primenite izmene na klijentu (što ćete verovatno želeti, jer pruža najbolje iskustvo). Prosledite ovde UUID. ID treba da bude dovoljno jedinstven da se ne pojavi dva puta u okviru jedne sesije pregledača.

Захтеви Internal Link


  • Python >= 3.8

Osnovna instalacija je čista standardna biblioteka i pruža SSO alate. Generisani API klijent (DefaultApi/PublicApi/ModerationApi) zahteva client dodatak, koji povlači urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0, i typing-extensions >= 4.0.0:

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

Потребна помоћ?

Ако наиђете на било какве проблеме или имате питања у вези са Python SDK, молимо вас:

Допринеси

Доприноси су добродошли! Молимо посетите репозиторијум на GitHub-у за смернице о доприносу.