FastComments.com

FastComments Python SDK


Ово је званични Python SDK за FastComments.

Званични Python SDK за FastComments API

Репозиторијум

Погледајте на GitHub


Инсталација Internal Link

Инсталирање са GitHub-а

Инсталирајте директно са ознаке издања (препоручено, потпуно репродуцибилно):

pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0

Закачите ознаку уместо гране како би изградње биле детерминисане. Исти формат функционише у requirements.txt:

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

Свака ознака GitHub Release такође има прикачен готов wheel ако више волите да директно инсталирате бинарни артефакт.

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

Ова библиотека садржи два модула: генерисани API клијент и основну Python библиотеку која садржи ручно написане алате за олакшавање рада са API-јем, укључујући SSO подршку.

Јавни vs Заштићени API-ји

За API клијент постоје три класе, DefaultApi, PublicApi и ModerationApi. DefaultApi садржи методе који захтевају ваш API кључ, а PublicApi садржи методе које се могу позивати директно из прегледача/мобилног уређаја/итд. без аутентификације. ModerationApi пружа обиман сет живих и брзих API-ја за модерацију. Сваки ModerationApi метод прихвата параметар sso и може се аутентификоваћe путем SSO или FastComments.com сесијског колачића.

Напомене Internal Link


Идентификатори емитовања

Видећете да треба да проследите broadcast_id у неким API позивима. Када примате догађаје, добићете овај ID назад, тако да знате да игноришете догађај ако планирате оптимистички да примените промене на клијенту (што ћете вероватно желети да урадите јер пружа најбоље искуство). Проследите UUID овде. ID треба да буде довољно јединствен да се не појави два пута у сесији прегледача.

Захтеви 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.1.0"

Потребна помоћ?

Ако наиђете на било какве проблеме или имате питања у вези са Python SDK, молимо вас:

Допринеси

Доприноси су добродошли! Молимо посетите репозиторијум на GitHub-у за смернице о доприносу.