The FastComments Python SDK. You can use this to build secure and scalable backend applications that interact with FastComments, or build reactive client applications.
pip install fastcomments-pythonThis library contains two modules: the generated API client and the core Python library which contains hand-written utilities to make working with the API easier, including SSO support.
For the API client, there are two classes, DefaultApi and PublicApi. The DefaultApi contains methods that require your API key, and PublicApi contains API calls that can be made directly from a browser/mobile device/etc without authentication.
Important: You must set your API key on the Configuration before making authenticated requests. If you don't, requests will fail with a 401 error.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Create and configure the API client
config = Configuration()
config.host = "https://fastcomments.com/api"
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Create the API instance with the configured client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Now you can make authenticated API calls
try:
# Example: Add an SSO user
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failedPublic endpoints don't require authentication:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")The SDK includes utilities for generating secure SSO tokens:
from sso import FastCommentsSSO, SecureSSOUserData
# Create user data
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Create SSO instance with your API secret
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Generate the SSO token
sso_token = sso.create_token()
# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")For simple SSO (less secure, for testing):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()- 401 "missing-api-key" error: Make sure you set
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}before creating the DefaultApi instance. - Wrong API class: Use
DefaultApifor server-side authenticated requests,PublicApifor client-side/public requests. - Import errors: Make sure you're importing from the correct module:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
# Set up environment variables
export FASTCOMMENTS_API_KEY="your-api-key"
export FASTCOMMENTS_TENANT_ID="your-tenant-id"
# Run tests
pytest tests/To regenerate the API client from the latest OpenAPI specification:
./update.shThis will:
- Download the latest OpenAPI spec from a running FastComments server (or use local openapi.yaml)
- Generate the Python client code
- Flatten the directory structure
- Clean up redundant configuration files
You'll see you're supposed to pass a broadcast_id in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
MIT