integration-python

Par posthog · skills

Intégration PostHog pour toute application Python utilisant le SDK Python

npx skills add https://github.com/posthog/skills --skill integration-python

Intégration PostHog pour Python

Cette skill vous aide à ajouter PostHog analytics à vos applications Python.

Workflow

Suivez ces étapes dans l'ordre pour compléter l'intégration :

  1. basic-integration-1.0-begin.md - PostHog Setup - Begin ← Commencez ici
  2. basic-integration-1.1-edit.md - PostHog Setup - Edit
  3. basic-integration-1.2-revise.md - PostHog Setup - Revise
  4. basic-integration-1.3-conclude.md - PostHog Setup - Conclusion

Fichiers de référence

  • references/EXAMPLE.md - Code d'exemple de projet Python
  • references/python.md - Python - docs
  • references/posthog-python.md - PostHog python SDK
  • references/identify-users.md - Identify users - docs
  • references/basic-integration-1.0-begin.md - PostHog setup - begin
  • references/basic-integration-1.1-edit.md - PostHog setup - edit
  • references/basic-integration-1.2-revise.md - PostHog setup - revise
  • references/basic-integration-1.3-conclude.md - PostHog setup - conclusion

Le projet exemple montre le pattern d'implémentation cible. Consultez la documentation pour les détails d'API.

Principes clés

  • Variables d'environnement : Utilisez toujours les variables d'environnement pour les clés PostHog. Ne les codez jamais en dur.
  • Changements minimaux : Ajoutez le code PostHog aux côtés des intégrations existantes. Ne remplacez ni ne restructurez le code existant.
  • Respectez l'exemple : Votre implémentation doit suivre les patterns du projet exemple aussi fidèlement que possible.

Directives du framework

  • Rappelez-vous que le code source est disponible dans le répertoire venv/site-packages
  • posthog est le nom du package SDK Python
  • Installez les dépendances avec pip install posthog ou pip install -r requirements.txt et N'UTILISEZ PAS de spécificateurs de version non échappés comme >= directement dans les commandes shell
  • Dans les CLIs et scripts : VOUS DEVEZ appeler posthog.shutdown() avant la sortie sinon tous les événements sont perdus
  • Utilisez toujours le constructeur de classe Posthog() (API basée sur les instances) au lieu de la configuration posthog.api_key au niveau du module
  • Incluez toujours enable_exception_autocapture=True dans le constructeur Posthog() pour suivre automatiquement les exceptions
  • NE JAMAIS envoyer d'informations personnelles (PII) dans les propriétés de l'événement capture() — pas d'emails, noms complets, numéros de téléphone, adresses physiques, adresses IP ou contenu généré par l'utilisateur
  • Les informations personnelles appartiennent aux propriétés de personne identify(), PAS aux propriétés de l'événement capture(). Les propriétés d'événement sûres sont des métadonnées comme message_length, form_type, booléens.
  • Enregistrez posthog_client.shutdown avec atexit.register() pour assurer que tous les événements sont vidés à la sortie
  • Le SDK Python N'A PAS de méthode identify() — utilisez posthog_client.set(distinct_id=user_id, properties={...}) pour définir les propriétés de personne, ou utilisez identify_context(user_id) dans un contexte

Identifier les utilisateurs

Identifiez les utilisateurs lors des événements de login et signup. Reportez-vous au code exemple et à la documentation pour le pattern identify correct pour ce framework. Si le code frontend et backend existent, passez la session côté client et le distinct ID en utilisant les headers X-POSTHOG-DISTINCT-ID et X-POSTHOG-SESSION-ID pour maintenir la corrélation.

Suivi des erreurs

Ajoutez le suivi des erreurs PostHog aux fichiers pertinents, particulièrement autour des flux utilisateur critiques et des limites d'API.

Skills similaires