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 або cookie сесії FastComments.com.

Примітки Internal Link

Ідентифікатори трансляцій

Ви побачите, що в деяких викликах API потрібно передавати broadcast_id. Коли ви отримуватимете події, ви отримаєте цей ідентифікатор назад, тож знатимете, що слід ігнорувати подію, якщо ви плануєте оптимістично застосовувати зміни на клієнті (а ймовірно саме так ви й захочете зробити, оскільки це забезпечує найкращий досвід). Передавайте сюди UUID. Ідентифікатор має бути достатньо унікальним, щоб не з'явитися двічі в одній сесії браузера.

Вимоги Internal Link

  • Python >= 3.8

Базова установка є чистою стандартною бібліотекою та надає утиліти 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.0.0"

Потрібна допомога?

Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо Python SDK, будь ласка:

Участь

Внески вітаються! Будь ласка, відвідайте репозиторій GitHub для отримання вказівок щодо внесків.