FastComments.com

Dodajte komentare u svoju Django aplikaciju


Ovo je zvanični Django paket za FastComments.

Komponente za komentarisanje u realnom vremenu i chat sa sigurnim SSO putem šablonskih tagova.

Repository

View on GitHub


Zahtjevi Internal Link


  • Python 3.10+
  • Django 4.2, 5.0, 5.1 ili 5.2
  • FastComments ID najemnika (koristite demo da ga isprobate bez računa)
  • API tajna je potrebna samo za Secure SSO

Instalacija Internal Link

Instalirajte s oznakom izdanja (ovaj projekt se distribuira putem git oznaka, a ne putem PyPI):

pip install "git+https://github.com/fastcomments/fastcomments-django.git@v0.1.0"

Za REST pristup na serveru (pomoćne funkcije admin() / public_api()), dodajte dodatak api, koji učitava generisanog klijenta SDK‑a:

pip install "fastcomments-django[api] @ git+https://github.com/fastcomments/fastcomments-django.git@v0.1.0"

Dodajte aplikaciju u INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "fastcomments_django",
]

Brzi početak Internal Link


Konfigurišite vaš tenant u settings.py:

import os

FASTCOMMENTS = {
    "TENANT_ID": os.environ.get("FASTCOMMENTS_TENANT_ID", "demo"),
}

Ubacite widget u bilo koji šablon:

{% load fastcomments %}

{% fastcomments url_id="my-page" %}

Preduvjeti za automatski SSO Internal Link

Da biste automatski prenijeli prijavljenog korisnika u widget, tagovi čitaju trenutnog korisnika iz zahtjeva. Provjerite da vaš projekt ima oba navedena elementa (oni su podrazumijevano uključeni u standardnom Django projektu):

  • django.template.context_processors.request u TEMPLATES["OPTIONS"]["context_processors"]
  • django.contrib.auth.middleware.AuthenticationMiddleware u MIDDLEWARE

Bez zahtjeva u kontekstu šablona, widgeti se renderuju za anonimnog posjetitelja. Uvijek možete eksplicitno proslijediti korisnika: {% fastcomments user=some_user %}.

Oznake widgeta Internal Link

Svaki vidžet ima svoju oznaku. Svi oni prihvataju **extra ključne argumente, koji se spajaju u konfiguraciju vidžeta takvom kakvom je (koristite camelCase ključeve) za sve što nije pokriveno imenovanim argumentima ispod.

OznakaVidžet
{% fastcomments %}Komentari
{% fastcomments_live_chat %}Živi chat
{% fastcomments_comment_count %}Značka broja komentara
{% fastcomments_comment_count_bulk %} + {% fastcomments_count_marker %}Grupni brojači komentara
{% fastcomments_collab_chat target="#el" %}Kolaborativni (inline) chat
{% fastcomments_image_chat target="#el" %}Chat za anotaciju slika
{% fastcomments_recent_comments %}Nedavni komentari
{% fastcomments_recent_discussions %}Nedavne rasprave
{% fastcomments_reviews_summary %}Sažetak recenzija
{% fastcomments_top_pages %}Najviše diskutovane stranice
{% fastcomments_user_activity user_id="..." %}Tok aktivnosti korisnika

Imenovani argumenti mapiraju na camelCase konfiguracijske ključeve vidžeta:

ArgumentConfig keyOznake
url_idurlIdcomments, live chat, comment count, collab/image chat, recent comments, reviews summary
urlurlcomments, live chat, collab/image chat
readonlyreadonlycomments, live chat, collab/image chat
localelocalecomments, live chat, collab/image chat, user activity
has_dark_backgroundhasDarkBackgroundall
default_sort_directiondefaultSortDirectioncomments, live chat, collab/image chat
number_onlynumberOnlycomment count
is_liveisLivecomment count
countcountrecent comments, recent discussions
target(querySelector, not sent)collab chat, image chat
chat_square_percentagechatSquarePercentageimage chat
user_iduserIduser activity

Primjeri:

{% load fastcomments %}

{% fastcomments url_id="my-page" locale="en_us" default_sort_direction="MR" %}

{% fastcomments_live_chat url_id="room-1" %}

Komentari: {% fastcomments_comment_count url_id="my-page" number_only=True %}

{# Kolaborativni chat se prilaže postojećem elementu na stranici #}
<article id="post-body">...</article>
{% fastcomments_collab_chat target="#post-body" %}

{# Grupni brojači: postavite markere, a zatim jedan grupni učitač popuni sve #}
{% for post in posts %}
    <a href="\{{ post.url }}">\{{ post.title }}</a>
    {% fastcomments_count_marker url_id=post.url_id %}
{% endfor %}
{% fastcomments_comment_count_bulk %}

SSO (Jedinstvena prijava) Internal Link

Enable SSO and choose a mode in settings.py. Secure SSO signs the user server-side with HMAC-SHA256 using your API secret and is recommended.

FASTCOMMENTS = {
    "TENANT_ID": os.environ["FASTCOMMENTS_TENANT_ID"],
    "API_KEY": os.environ["FASTCOMMENTS_API_KEY"],   # your API secret; signs Secure SSO
    "SSO": {
        "ENABLED": True,
        "MODE": "secure",                            # "secure" | "simple"
        # Map FastComments fields to your user model. Values may be an attribute
        # name, a dotted path ("profile.avatar_url"), a callable(user), or None.
        "USER_MAP": {
            "id": "id",
            "email": "email",
            "username": "username",
            "avatar": None,
            "display_name": None,
            "website_url": None,
        },
        "IS_ADMIN": lambda user: user.is_staff,      # callable(user) -> bool, or dotted path
        "IS_MODERATOR": None,
        "GROUP_IDS": None,                           # callable(user) -> list, or dotted path
    },
}

Izaberite SSO id namjerno. FastComments id je trajni identifikator za historiju komentara korisnika. Zadani USER_MAP mapira ga na vaš primarni ključ iz Django‑a za zero‑config praktičnost, ali sekvencijalni integer PK‑ovi su enumerabilni i teško je mijenjati kasnije (promjena id‑a korisnika razdvaja njihovu historiju u novi račun). Za sve osim demonstracije, mapirajte id na stabilnu, neprozirnu vrijednost odabranu unaprijed (UUID ili posvećeni javni id), i nikada ne stavljajte privatne podatke u njega. Primjer aplikacije koristi id baziran na korisničkom imenu iz ovog razloga.

SSO se automatski ubacuje u {% fastcomments %}, {% fastcomments_live_chat %}, {% fastcomments_collab_chat %}, {% fastcomments_image_chat %} i {% fastcomments_user_activity %} za trenutnog korisnika.

Login/logout URLs shown to signed-out visitors default to reverse("login") / reverse("logout"); override them with SSO["LOGIN_URL"] / SSO["LOGOUT_URL"].

Prilagođeno mapiranje

Dve opcije višeg prioriteta nadjačavaju USER_MAP:

  • Metod na vašem modelu korisnika (Python‑ski analog interfejsa):

    class User(AbstractUser):
        def to_fastcomments_user_data(self):
            return {"id": self.pk, "email": self.email, "username": self.get_username()}
  • Globalni mapper, putanja odvojena tačkama do callable(user) -> dict:

    FASTCOMMENTS = {"SSO": {"USER_MAPPER": "myapp.sso.map_user"}}

Prioritet je USER_MAPPER > to_fastcomments_user_data() > USER_MAP.

Pristup API-ju na serverskoj strani Internal Link

Sa instaliranim dodatkom [api], pozovite FastComments REST API putem SDK‑a, prekonfigurisanim sa vašim API ključem i regionom:

from fastcomments_django import admin, public_api, get_manager

admin().get_comments("YOUR_TENANT_ID", ...)     # autentifikovan (DefaultApi)
public_api().get_comments_public(...)            # javni (PublicApi)

# Generišite SSO token za API pozive ili prenosa klijenta:
token = get_manager().sso().token_for(request.user)

EU regija Internal Link

Postavite REGION da usmjerite widgete i API prema EU:

FASTCOMMENTS = {"TENANT_ID": "...", "REGION": "eu"}

Prilagođavanje embed markup-a Internal Link


Zamenite fastcomments/widget.html tako što ćete postaviti svoju kopiju ranije u putanju pretrage šablona (projekat templates/fastcomments/widget.html). Ovo je Django analog Laravel‑ovog vendor:publish --tag=fastcomments-views.

Referenca postavki Internal Link

KljučPodrazumevanoOpis
TENANT_ID""Vaš FastComments tenant ID (demo za testiranje).
API_KEY""Vaš API tajni ključ. Potpisuje Secure SSO i autentificira admin().
REGIONNoneNone za SAD, "eu" za EU regiju.
SSO.ENABLEDFalseUključite SSO.
SSO.MODE"secure""secure" (HMAC) ili "simple" (nepotpisano).
SSO.LOGIN_URL / SSO.LOGOUT_URLNonePrikazuje se odjavljenim posjetiteljima; podrazumijevano na reverse("login"/"logout").
SSO.USER_MAPid/email/usernameFastComments polje do korisničkog atributa/puteva/funkcije.
SSO.IS_ADMIN / IS_MODERATOR / GROUP_IDSNonecallable(user) ili putu s tačkama.
SSO.USER_MAPPERNonePut s tačkama do callable(user) -> dict; najviši prioritet.
WIDGET_DEFAULTS{}Konfiguracija spajana u svaki widget (camelCase ključevi).

Primjer projekta Internal Link

A runnable showcase lives in example/: a left-rail + main-stage app with a page per widget and a sign-in page listing pre-seeded demo users.
Prijavite se kao bilo koji od njih i widgeti za komentare i live‑chat autentifikuju taj identitet putem Secure SSO.
Iz tog direktorija:

python manage.py migrate
# Use your own tenant to see Secure SSO in action (an API secret enables it):
FASTCOMMENTS_TENANT_ID=... FASTCOMMENTS_API_KEY=... python manage.py runserver

Bez API tajne vraća se na javnog demo tenant (anoniman).
example/browser_smoke.py je Playwright e2e koji učitava stranicu u pravom pretraživaču i objavljuje komentar kao Secure-SSO korisnik.

Need Help?

If you encounter any issues or have questions about the Django Package, please:

Contributing

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