feat: flask and django simple example

examples/README.md

@@ -0,0 +1,27 @@
+# Amplitude Python SDK
+
+There are some example apps of using Amplitude Python SDK.
+
+## Usage
+
+### Setup before execution
+
+1. Install Amplitude Python SDK
+   1. `pip install amplitude-analytics`
+2. Replace `YOUR API KEY` in example code with your amplitude project api key.
+
+### Using Amplitude client to track events
+
+[This example](track_example) initialized an amplitude client and tracked different types of events.
+
+### Plugin example
+
+[This example](plugin_example) demo event plugin and destination plugin usage.
+
+### Flask example
+
+[This example](flask_example) has a simple flask app.
+
+### Django example
+
+[This example](django_example) is a Django project.

examples/django_example/README.md

@@ -0,0 +1,15 @@
+# Django Amplitude example
+
+Contains a app called 'amplitude_example'. The app has one view in amplitude_example/views.py
+
+### To run this example 
+
+First install Django:
+
+`pip install django`
+
+Then:
+
+`python manage.py runserver`
+
+In your browser open link http://127.0.0.1:8000/amplitude/ to see the view page in the example and a 'Page Loaded' event will be sent.

examples/django_example/amplitude_example/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

examples/django_example/amplitude_example/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AmplitudeExampleConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'amplitude_example'

examples/django_example/amplitude_example/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

examples/django_example/amplitude_example/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

examples/django_example/amplitude_example/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+from . import views
+
+
+urlpatterns = [
+    path('', views.track_event, name='Track Page Load Event'),
+]

examples/django_example/amplitude_example/views.py

@@ -0,0 +1,11 @@
+from django.http import HttpResponse
+from amplitude import Amplitude, BaseEvent
+# Create your views here.
+
+
+client = Amplitude("YOUR API KEY")
+
+
+def track_event(request):
+    client.track(BaseEvent("Page Loaded", user_id="django_example_user"))
+    return HttpResponse("<p>Page Loaded event sent.</p>")

examples/django_example/django_example/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_example.settings')
+
+application = get_asgi_application()

examples/django_example/django_example/settings.py

@@ -0,0 +1,126 @@
+"""
+Django settings for django_example project.
+
+Generated by 'django-admin startproject' using Django 3.2.13.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-4ihk4^sn+u2jw^&orsc(l06%0xkq8oebpr9%=2sa@rfq1jn3&1'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'amplitude_example.apps.AmplitudeExampleConfig',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'django_example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'django_example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

examples/django_example/django_example/urls.py

@@ -0,0 +1,22 @@
+"""django_example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, include
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('amplitude/', include('amplitude_example.urls'))
+]

examples/django_example/django_example/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_example.settings')
+
+application = get_wsgi_application()

examples/django_example/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_example.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

examples/flask_example/README.md

@@ -0,0 +1,15 @@
+# Flask Amplitude example
+
+A simple flask app that has one page. Send a 'Page Loaded' event to Amplitude when the app page was opened.
+
+### To run this example
+
+First install flask:
+
+`pip install flask`
+
+Then:
+
+`FLASK_APP=flaskapp flask run`
+
+In your browser open link http://localhost:5000/ to see the app page and a 'Page Loaded' event will be sent.

examples/flask_example/flaskapp.py

@@ -0,0 +1,15 @@
+from flask import Flask
+from amplitude import Amplitude, BaseEvent
+
+app = Flask(__name__)
+amp_client = Amplitude("YOUR API KEY")
+
+
+@app.route("/")
+def amplitude_example_app():
+    amp_client.track(BaseEvent("Page Loaded", user_id="flask_example_user"))
+    return "<p>Page Loaded event sent.</p>"
+
+
+if __name__ == "__main__":
+    app.run()

examples/plugin_example/README.md

@@ -0,0 +1,19 @@
+# Plugin example
+
+### Event plugin example
+
+An event plugin that add a description to events' event_properties
+
+`python event_plugin.py`
+
+### Destination plugin example
+
+A customized destination plugin that post event to https://postman-echo.com/post and print the response
+
+To run this example, first install requests if needed:
+
+`pip install requests`
+
+Then:
+
+`python destination_plugin.py`

examples/plugin_example/destination_plugin.py

@@ -0,0 +1,27 @@
+import json
+import requests
+
+from amplitude import Amplitude, DestinationPlugin, PluginType, BaseEvent
+
+
+class MyDestinationPlugin(DestinationPlugin):
+
+    def __init__(self):
+        self.plugin_type = PluginType.DESTINATION
+        self.configuration = None
+        self.url = "https://postman-echo.com/post"
+
+    def setup(self, client: Amplitude):
+        super().setup(client)
+        self.configuration = client.configuration
+
+    def execute(self, event: BaseEvent) -> None:
+        event = self.timeline.process(event)
+        r = requests.post(self.url, data=json.dumps(event.get_event_body()))
+        print(r.text)
+
+
+amp_client = Amplitude("YOUR API KEY")
+amp_client.add(MyDestinationPlugin())
+amp_client.track(BaseEvent("plugin_example_event", user_id="example_user"))
+amp_client.shutdown()