mixpanel / flask-tracking-proxy

Example Python Flask application to proxy tracking requests to Mixpanel's API
10 stars 3 forks source link

Mixpanel Flask Proxy Example

An example Flask application that serves as a proxy to Mixpanel's Ingestion API and JavaScript library endpoints. To learn more, visit our Self-Hosted Tracking Docs.

:warning: This is meant to be used for demonstration purposes only. You should not run this in production without making changes to the deployment.

Installation

There are a few ways you can use this repo to deploy a server that can be use to proxy Mixpanel API requests. Again, this should only be used for testing purposes. You'll want to make your own customizations and productionalize the deploy before going live.

Option 1: One-click Deploy

Option 2: Docker Image

Assuming you have Docker installed on your system, you can do the following:

  1. Clone the repo
  2. Build the Docker image: docker build -t mixpanel-proxy .
  3. Run a container using the image: docker run -d -p 5000:5000 mixpanel-proxy
  4. Visit http://localhost:5000

Option 3: Run the Flask application directly

  1. Clone the repo
  2. Install dependencies pip install -r requirements.txt
  3. Start the app python flask_proxy/app.py
  4. Visit http://localhost:5000

Running Tests

  1. Clone the repo
  2. Install dependencies pip install -r requirements.txt
  3. Run tests pytest