FastComments.com

FastComments 파이썬 SDK


이것은 FastComments의 공식 Python SDK입니다.

FastComments API용 공식 Python SDK

저장소

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 클라이언트와 API 사용을 더 쉽게 만들기 위한 수작업 유틸리티를 포함한 핵심 Python 라이브러리이며, SSO 지원도 포함됩니다.

공개 API와 보안 API

API 클라이언트에는 DefaultApi, PublicApi, ModerationApi 세 가지 클래스가 있습니다. DefaultApi는 API 키가 필요한 메서드를 포함하고, PublicApi는 인증 없이 브라우저/모바일 장치 등에서 직접 호출할 수 있는 메서드를 포함합니다. ModerationApi는 실시간 및 빠른 검토를 위한 광범위한 API 모음을 제공합니다. 모든 ModerationApi 메서드는 sso 매개변수를 받아 SSO 또는 FastComments.com 세션 쿠키를 통해 인증할 수 있습니다.

참고사항 Internal Link

브로드캐스트 ID

일부 API 호출에서는 broadcast_id를 전달해야 합니다. 이벤트를 수신하면 이 ID가 다시 돌아오므로, 클라이언트에서 변경을 낙관적으로 적용하려는 경우(이는 대체로 가장 좋은 경험을 제공하므로 아마 그렇게 하게 될 것입니다) 해당 이벤트를 무시해야 하는지 알 수 있습니다. 여기에는 UUID를 전달하세요. 이 ID는 브라우저 세션 내에서 두 번 발생하지 않을 만큼 충분히 고유해야 합니다.

요구사항 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.1.0"

도움이 필요하신가요?

Python SDK에 관해 문제가 발생하거나 질문이 있는 경우, 다음을 이용해 주세요:

기여

기여는 환영합니다! 기여 지침은 GitHub 저장소를 방문해 주세요.