FastComments.com

FastComments SDK для Python


Это официальный Python SDK для FastComments.

Официальный Python SDK для API FastComments

Репозиторий

Просмотреть на GitHub


Установка Internal Link

Install from 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, если вы предпочитаете установить бинарный артефакт напрямую.

Library Contents

Эта библиотека содержит два модуля: сгенерированный API‑клиент и ядро Python‑библиотеки, которое включает написанные вручную утилиты для упрощения работы с API, включая поддержку SSO.

Public vs Secured APIs

Для API‑клиента существует три класса: DefaultApi, PublicApi и ModerationApi. DefaultApi содержит методы, требующие вашего API‑ключа, а PublicApi — методы, которые можно вызывать напрямую из браузера/мобильного устройства и т.д. без аутентификации. ModerationApi предоставляет обширный набор живых и быстрых API модерации. Каждый метод ModerationApi принимает параметр sso и может аутентифицироваться через SSO или cookie сессии FastComments.com.

Примечания Internal Link


Идентификаторы Broadcast

Вы увидите, что в некоторых вызовах API нужно передавать broadcast_id. Когда вы будете получать события, вы получите этот идентификатор обратно, чтобы знать, нужно ли игнорировать событие, если вы планируете оптимистично применять изменения на клиенте (что, вероятно, вы захотите сделать, поскольку это обеспечивает лучший пользовательский опыт). Передайте здесь UUID. Идентификатор должен быть достаточно уникальным, чтобы не появляться дважды в рамках одной сессии браузера.

Требования 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.0.0"

Нужна помощь?

Если вы столкнулись с какими-либо проблемами или у вас есть вопросы о Python SDK, пожалуйста:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.