unisights 0.0.1b1

Add your description here

Unisights Python SDK

Unisights Python SDK provides a lightweight event collection endpoint for Python web frameworks. It allows your backend to receive analytics events from the Unisights client SDK and process them using a custom handler.

The package exposes a single POST API endpoint that receives event payloads and forwards them to your handler for processing.

Supported frameworks:

• FastAPI
• Flask
• Django
• ASGI-compatible frameworks (Starlette, Quart, etc.)

---

Features

• Simple event ingestion endpoint
• Works with multiple Python frameworks
• Async + sync handler support
• Framework-agnostic core
• Easy integration with analytics pipelines (Kafka, DB, queue, etc.)

---

Installation

pip install unisights

---

Event Payload Example

The endpoint expects a JSON payload.

{
  "type": "event",
  "name": "page_view",
  "session_id": "abc123",
  "timestamp": 1710000000,
  "data": {
    "url": "/home",
    "referrer": "google.com"
  }
}

---

FastAPI Integration

from fastapi import FastAPI
from unisights.fastapi import unisights_fastapi

app = FastAPI()

async def handler(payload, request):
    print(payload)

app.include_router(
    unisights_fastapi("/collect/event", handler)
)

Start server:

uvicorn main:app --reload

Endpoint:

POST /collect/event

---

Flask Integration

from flask import Flask
from unisights.flask import unisights_flask

app = Flask(__name__)

async def handler(payload, request):
    print(payload)

app.register_blueprint(
    unisights_flask("/collect/event", handler)
)

app.run()

Endpoint:

POST /collect/event

---

Django Integration

Add the route in your Django project.

from django.urls import path
from unisights.django import unisights_django

async def handler(payload, request):
    print(payload)

urlpatterns = [
    path("collect/event", unisights_django(handler))
]

Endpoint:

POST /collect/event

---

Using with Message Queues or Databases

Your handler can forward events to any system.

Example: Kafka

async def handler(payload, request):
    kafka_producer.send("analytics-events", payload)

Example: Save to database

async def handler(payload, request):
    db.events.insert_one(payload)

---

Project Structure

unisights/
├── collector.py
├── fastapi.py
├── flask.py
├── django.py
└── asgi.py

• collector.py → Core event processor
• fastapi.py → FastAPI adapter
• flask.py → Flask adapter
• django.py → Django adapter
• asgi.py → Generic ASGI middleware

---

Development

Clone repository:

git clone https://github.com/pradeeparul/unisights
cd unisights-python

Install dependencies:

pip install -e .

Build package:

python -m build

Publish to PyPI:

twine upload dist/*

---

License

MIT License

---

Links

GitHub https://github.com/pradeeparul/unisights