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.0.0

Фиксирайте етикета вместо клон, за да бъдат компилациите детерминирани. Същият формат работи в requirements.txt:

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

Всеки етикетиран GitHub Release също има прикачен готов wheel, ако предпочитате да инсталирате бинарен артефакт директно.

Съдържание на библиотеката

Тази библиотека съдържа два модула: генерирания клиент за API и основната Python библиотека, която съдържа ръчно написани помощни функции за улесняване на работата с API‑то, включително поддръжка на SSO.

Публични срещу защитени API‑та

За клиентския API има три класа – DefaultApi, PublicApi и ModerationApi. DefaultApi съдържа методи, които изискват вашия API ключ, а PublicApi съдържа методи, които могат да се извикат директно от браузър/мобилно устройство и пр. без автентификация. ModerationApi предоставя обширен набор от живи и бързи модерационни API‑та. Всеки метод на ModerationApi приема параметър sso и може да се автентикира чрез SSO или FastComments.com сесийна бисквитка.

Бележки Internal Link

Идентификатори на излъчване

Ще забележите, че трябва да подадете broadcast_id в някои API заявки. Когато получите събития, ще получите този идентификатор обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като осигурява най-доброто потребителско изживяване). Подайте тук UUID. Идентификаторът трябва да е достатъчно уникален, за да не се появи два пъти в една сесия на браузъра.

Изисквания Internal Link

  • Python >= 3.8

Базовата инсталация е чисто stdlib и предоставя SSO помощни функции. Генерираният API клиент (DefaultApi/PublicApi/ModerationApi) изисква extra 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.0.0"

Нуждаете ли се от помощ?

Ако срещнете проблеми или имате въпроси относно Python SDK, моля:

Принос

Приносите са добре дошли! Моля, посетете репозитория в GitHub за указания относно приноса.