Προσθήκη Σχολίων στην Εφαρμογή Django σας

• Python 3.10+
• Django 4.2, 5.0, 5.1, ή 5.2
• Ένα FastComments tenant ID (χρησιμοποιήστε demo για δοκιμή χωρίς λογαριασμό)
• Απαιτείται ένα API secret μόνο για Secure SSO

Install from a release tag (this project is distributed via git tags, not PyPI):

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

For server-side REST access (the admin() / public_api() helpers), add the api extra, which pulls in the SDK's generated client:

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

Add the app to INSTALLED_APPS:

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

Configure your tenant in settings.py:

import os

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

Drop the widget into any template:

{% load fastcomments %}

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

To pass the logged-in user to the widget automatically, the tags read the current user from the request. Make sure your project has both of these (they are on by default in a standard Django project):

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

Without a request in the template context, widgets render for an anonymous visitor. You can always pass a user explicitly: {% fastcomments user=some_user %}.

Κάθε widget έχει τη δική του ετικέτα. Όλα αποδεχθούν extra ορίσματα λέξεων‑κλειδιών, τα οποία ενσωματώνονται στη διαμόρφωση του widget όπως είναι (χρησιμοποιήστε κλειδιά camelCase) για οτιδήποτε δεν καλύπτεται από τα ονομαστικά ορίσματα παρακάτω.

Τα ονομαστικά ορίσματα αντιστοιχούν στα κλειδιά camelCase της διαμόρφωσης του widget:

Παραδείγματα:

{% load fastcomments %}

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

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

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

{# Η Συνεργατική συνομιλία προσδένεται σε ένα υπάρχον στοιχείο στη σελίδα #}
<article id="post-body">...</article>
{% fastcomments_collab_chat target="#post-body" %}

{# Μαζικοί μετρητές: τοποθετήστε δείκτες, στη συνέχεια ένας μαζικός φορτωτής τα γεμίζει όλα #}
{% for post in posts %}
    <a href="\{{ post.url }}">\{{ post.title }}</a>
    {% fastcomments_count_marker url_id=post.url_id %}
{% endfor %}
{% fastcomments_comment_count_bulk %}

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
    },
}

Επιλέξτε το SSO id σκόπιμα. Το id του FastComments είναι ο μόνιμος αναγνωριστής για το ιστορικό σχολίων ενός χρήστη. Το προεπιλεγμένο USER_MAP το αντιστοιχίζει στο πρωτεύον κλειδί του Django για ευκολία χωρίς ρύθμιση, αλλά τα διαδοχικά ακέραια PKs είναι αριθμήσιμα και δύσκολα να αλλάξουν αργότερα (η αλλαγή του id ενός χρήστη χωρίζει το ιστορικό του σε νέο λογαριασμό). Για οτιδήποτε πέρα από μια επίδειξη, αντιστοιχίστε το id σε μια σταθερή, αδιαφανή τιμή που επιλέγεται εκ των προτέρων (ένα UUID ή ένα αφιερωμένο δημόσιο id) και μην τοποθετείτε ποτέ ιδιωτικά δεδομένα σε αυτό. Η παράδειγμα εφαρμογή χρησιμοποιεί ένα id βασισμένο στο όνομα χρήστη για αυτόν τον λόγο.

SSO is injected automatically into {% fastcomments %}, {% fastcomments_live_chat %}, {% fastcomments_collab_chat %}, {% fastcomments_image_chat %}, and {% fastcomments_user_activity %} for the current user.

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

Custom mapping

Two higher-precedence options beat USER_MAP:

• Μια μέθοδος στο μοντέλο χρήστη σας (the Pythonic analog of an interface):

  class User(AbstractUser):
      def to_fastcomments_user_data(self):
          return {"id": self.pk, "email": self.email, "username": self.get_username()}

• Ένας παγκόσμιος mapper, a dotted path to callable(user) -> dict:

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

Precedence is USER_MAPPER > to_fastcomments_user_data() > USER_MAP.

Με το πρόσθετο [api] εγκατεστημένο, καλέστε το FastComments REST API μέσω του SDK, προ‑ρυθμισμένο με το κλειδί API και την περιοχή σας:

from fastcomments_django import admin, public_api, get_manager

admin().get_comments("YOUR_TENANT_ID", ...)     # αυθεντικοποιημένο (DefaultApi)
public_api().get_comments_public(...)            # δημόσιο (PublicApi)

# Δημιουργήστε ένα token SSO για κλήσεις API ή παράδοση πελάτη:
token = get_manager().sso().token_for(request.user)

Ορίστε το REGION για να δρομολογήσετε τα widgets και το API στην ΕΕ:

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

Αντικαταστήστε το fastcomments/widget.html τοποθετώντας το δικό σας αντίγραφο νωρίτερα στη
διαδρομή αναζήτησης προτύπων (ένα project templates/fastcomments/widget.html). Αυτό είναι
το Django αντίστοιχο του Laravel's vendor:publish --tag=fastcomments-views.

Μια εκτελέσιμη παρουσίαση βρίσκεται στο example/: μια εφαρμογή με αριστερή μπάρα + κύριο σκηνικό με μια σελίδα ανά widget και μια σελίδα σύνδεσης που εμφανίζει προ-σπόρους χρήστες demo.
Συνδεθείτε με οποιονδήποτε από αυτούς και τα widgets σχολίων και ζωντανής συνομιλίας επαληθεύουν αυτήν την ταυτότητα μέσω Secure SSO. Από αυτόν τον φάκελο:

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

Χωρίς μυστικό API επιστρέφει στον δημόσιο demo ενοικιαστή (ανώνυμο).
example/browser_smoke.py είναι ένα Playwright e2e που φορτώνει τη σελίδα σε πραγματικό πρόγραμμα περιήγησης και στέλνει ένα σχόλιο ως ο χρήστης Secure-SSO.