apitally 0.3.3

Apitally client library for Python

Your refreshingly simple REST API companion.

Apitally is a simple and affordable API monitoring and API key management solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.

🔗 apitally.io

---

Apitally client library for Python

This client library for Apitally currently supports the following Python web frameworks:

• FastAPI
• Starlette
• Flask
• Django Ninja
• Django REST Framework

Learn more about Apitally on our 🌎 website or check out the 📚 documentation.

Key features

• Middleware for different frameworks to capture metadata about API endpoints, requests and responses (no sensitive data is captured)
• Non-blocking clients that aggregate and send captured data to Apitally and optionally synchronize API key hashes in 1 minute intervals
• Functions to easily secure endpoints with API key authentication and permission checks

Install

Use pip to install and provide your framework of choice as an extra, for example:

pip install apitally[fastapi]

The available extras are: fastapi, starlette, flask, django_ninja and django_rest_framework.

Usage

Our setup guides include all the details you need to get started.

FastAPI

This is an example of how to add the Apitally middleware to a FastAPI application. For further instructions, see our setup guide for FastAPI.

from fastapi import FastAPI
from apitally.fastapi import ApitallyMiddleware

app = FastAPI()
app.add_middleware(
    ApitallyMiddleware,
    client_id="your-client-id",
    env="default",  # or "dev", "prod" etc.
)

Starlette

This is an example of how to add the Apitally middleware to a Starlette application. For further instructions, see our setup guide for Starlette.

from starlette.applications import Starlette
from apitally.starlette import ApitallyMiddleware

app = Starlette(routes=[...])
app.add_middleware(
    ApitallyMiddleware,
    client_id="your-client-id",
    env="default",  # or "dev", "prod" etc.
)

Flask

This is an example of how to add the Apitally middleware to a Flask application. For further instructions, see our setup guide for Flask.

from flask import Flask
from apitally.flask import ApitallyMiddleware

app = Flask(__name__)
app.wsgi_app = ApitallyMiddleware(
    app,
    client_id="your-client-id",
    env="default",  # or "dev", "prod" etc.
)

Django Ninja

This is an example of how to add the Apitally middleware to a Django Ninja application. For further instructions, see our setup guide for Django Ninja.

In your Django settings.py file:

MIDDLEWARE = [
    "apitally.django_ninja.ApitallyMiddleware",
    # Other middleware ...
]
APITALLY_MIDDLEWARE = {
    "client_id": "your-client-id",
    "env": "default",  # or "dev", "prod" etc.
}

Django REST Framework

This is an example of how to add the Apitally middleware to a Django REST Framework application. For further instructions, see our setup guide for Django REST Framework.

In your Django settings.py file:

MIDDLEWARE = [
    "apitally.django_rest_framework.ApitallyMiddleware",
    # Other middleware ...
]
APITALLY_MIDDLEWARE = {
    "client_id": "your-client-id",
    "env": "default",  # or "dev", "prod" etc.
}

Getting help

If you need help please create a new discussion on GitHub.

License

This library is licensed under the terms of the MIT license.