Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

3.5 KB
Raw Blame
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'

import { StepDefinition } from '../steps'

export const getDjangoInstallSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
    const { CodeBlock, Markdown, dedent } = ctx

    return [
        {
            title: 'Install the package',
            badge: 'required',
            content: (
                <>
                    <Markdown>Install the PostHog Python library using pip:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'bash',
                                file: 'Terminal',
                                code: dedent`
                                    pip install posthog
                                `,
                            },
                        ]}
                    />
                </>
            ),
        },
        {
            title: 'Configure PostHog',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        Set the PostHog project token and host in your `AppConfig` in `apps.py` so that it's available
                        everywhere:
                    </Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'python',
                                file: 'your_app/apps.py',
                                code: dedent`
                                    from django.apps import AppConfig
                                    import posthog

                                    class YourAppConfig(AppConfig):
                                        name = "your_app_name"

                                        def ready(self):
                                            posthog.api_key = '<ph_project_token>'
                                            posthog.host = '<ph_client_api_host>'
                                `,
                            },
                        ]}
                    />
                    <Markdown>
                        Next, if you haven't done so already, make sure you add your `AppConfig` to your `settings.py`
                        under `INSTALLED_APPS`:
                    </Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'python',
                                file: 'settings.py',
                                code: dedent`
                                    INSTALLED_APPS = [
                                        # other apps
                                        'your_app_name.apps.YourAppConfig',  # Add your app config
                                    ]
                                `,
                            },
                        ]}
                    />
                </>
            ),
        },
    ]
}

export const getDjangoEventStep = (ctx: OnboardingComponentsContext): StepDefinition => {
    const { snippets } = ctx

    const PythonEventCapture = snippets?.PythonEventCapture

    return {
        title: 'Send events',
        content: <>{PythonEventCapture && <PythonEventCapture />}</>,
    }
}

export const getDjangoSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => [
    ...getDjangoInstallSteps(ctx),
    getDjangoEventStep(ctx),
]

export const DjangoInstallation = createInstallation(getDjangoSteps)