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 или cookies сеанса FastComments.com.

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

Идентификаторы вещания

Вы увидите, что в некоторых вызовах 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"

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

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

Участие в проекте

Внесения приветствуются! Пожалуйста, посетите репозиторий на GitHub для инструкций по внесению вклада.