FastComments.com

FastComments Python SDK


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

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

Репозиторий

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


Установка Internal Link


PyPI

pip install fastcomments

Содержимое библиотеки

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

Публичные vs Защищённые API

Для клиента API существуют два класса, DefaultApi и PublicApi. DefaultApi содержит методы, для которых требуется ваш API-ключ, а PublicApi содержит вызовы API, которые можно выполнять напрямую из браузера/мобильного устройства и т.д. без аутентификации.

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


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

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

Требования Internal Link


  • Python >= 3.8
  • urllib3 >= 1.25.3
  • python-dateutil >= 2.8.2
  • pydantic >= 2.0.0
  • typing-extensions >= 4.0.0

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

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

Contributing

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