✨ Features

• ⚡ Zero Blocking Overhead: Dispatches tracking payloads asynchronously in a background daemon thread.
• 📊 Automatic Latency & Status Tracking: Accurately measures response durations in milliseconds.
• 🚀 Dual Framework Support: Native integration for FastAPI / Starlette (ASGI) and Flask (WSGI).
• 🛡️ Fail-Safe: Tracker network drops or timeouts never interrupt or crash your user-facing API routes.
• 📦 Zero Required Dependencies: Built entirely on top of Python's standard library.

🚀 Installation

Install from PyPI:

pip install apideck-tracker

Or for local development:

pip install -e .

🔑 Get Your API Key

1. Go to https://apideck.site/ and sign in or create an account.
2. Go to your dashboard to view your unique apikey.
3. Use your apikey in your application middleware configuration.

🔧 Quick Start

1. FastAPI / Starlette

from fastapi import FastAPI
from apideck import ApiDeckMiddleware

app = FastAPI()

app.add_middleware(
    ApiDeckMiddleware,
    apikey="YOUR_API_KEY",
    tracker_url="https://apideck.site"  # Optional, defaults to https://apideck.site
)

@app.get("/")
def read_root():
    return {"message": "Hello from FastAPI!"}

2. Flask

from flask import Flask
from apideck import ApiDeck

app = Flask(__name__)

# Basic Initialization
ApiDeck(
    app,
    apikey="YOUR_API_KEY",
    tracker_url="https://apideck.site"  # Optional, defaults to https://apideck.site
)

@app.route("/")
def read_root():
    return {"message": "Hello from Flask!"}

Alternative: Flask Application Factory Pattern

from flask import Flask
from apideck import ApiDeck

tracker = ApiDeck()

def create_app():
    app = Flask(__name__)
    app.config["APIDECK_API_KEY"] = "YOUR_API_KEY"
    app.config["APIDECK_TRACKER_URL"] = "https://apideck.site"

    tracker.init_app(app)
    return app

📖 Configuration Reference

📊 Tracked Data Payload

Every request processed by the middleware sends the following JSON payload to /api/usage/log:

{
  "apikey": "your_api_key",
  "endpoint": "/api/users",
  "method": "GET",
  "status_code": 200,
  "is_success": true,
  "response_time_ms": 34,
  "ip": "127.0.0.1"
}

🧪 Testing Locally

Check out the included examples in the examples/ directory:

# FastAPI Example
python examples/fastapi_demo.py

# Flask Example
python examples/flask_demo.py

🚢 Publishing to PyPI

When you're ready to publish the SDK to the official Python Package Index:

1. Install build and twine:

   pip install build twine
   

2. Build distribution packages:

   python -m build
   

3. Upload to PyPI:

   python -m twine upload dist/*
   

📄 License

MIT © Aman Kishor