FastComments.com

FastComments Python SDK


Bu, FastComments için resmi Python SDK'sıdır.

FastComments API'si için resmi Python SDK

Depo

GitHub'da görüntüle


Kurulum Internal Link

GitHub'dan Kurulum

Bir sürüm etiketi üzerinden doğrudan kurun (önerilir, tamamen tekrarlanabilir):

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

Yapıların deterministik olmasını sağlamak için bir dal yerine etiketi sabitleyin. Aynı biçim requirements.txt içinde de çalışır:

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

Her etiketli GitHub Release ayrıca doğrudan bir ikili artefakt kurmayı tercih ederseniz eklenmiş bir wheel dosyasına sahiptir.

Kütüphane İçeriği

Bu kütüphane iki modül içerir: oluşturulan API istemcisi ve API ile çalışmayı, SSO desteği dahil, kolaylaştıran el yazısı yardımcı programları içeren temel Python kütüphanesi.

Genel vs Güvenli API'ler

API istemcisi için üç sınıf vardır: DefaultApi, PublicApi ve ModerationApi. DefaultApi, API anahtarınızı gerektiren yöntemleri içerir; PublicApi ise kimlik doğrulama gerektirmeden doğrudan bir tarayıcı/mobil cihaz vb. üzerinden yapılabilen yöntemleri içerir. ModerationApi, canlı ve hızlı denetleme API'lerinin kapsamlı bir paketini sağlar. Her ModerationApi yöntemi bir sso parametresi alır ve SSO veya bir FastComments.com oturum çerezi aracılığıyla kimlik doğrulaması yapabilir.

Notlar Internal Link

Yayın Kimlikleri

Bazı API çağrılarında bir broadcast_id geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu kimliği geri alırsınız; böylece istemcide değişiklikleri iyimser şekilde uygulamayı planlıyorsanız (muhtemelen en iyi deneyimi sunduğu için yapmak isteyeceksiniz), olayı yok saymanız gerektiğini bilirsiniz. Buraya bir UUID geçirin. Bu kimlik, bir tarayıcı oturumu içinde iki kez ortaya çıkmayacak kadar benzersiz olmalıdır.

Gereksinimler Internal Link


  • Python >= 3.8

Temel kurulum pure-stdlib'dir ve SSO yardımcı programlarını sağlar. Oluşturulan API istemcisi (DefaultApi/PublicApi/ModerationApi) client ekstra paketine ihtiyaç duyar; bu paket urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 ve typing-extensions >= 4.0.0 çeker:

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

Yardımı mı ihtiyacınız var?

Python SDK ile ilgili herhangi bir sorunla karşılaşırsanız veya sorularınız varsa, lütfen:

Katkıda Bulunma

Katkılar memnuniyetle karşılanır! Lütfen katkı yönergeleri için GitHub deposunu ziyaret edin.