Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitally/apitally-py
Simple API monitoring & analytics for Python web applications
https://github.com/apitally/apitally-py
api api-analytics api-monitoring api-observability django-ninja django-rest-framework fastapi flask litestar monitoring python rest-api
Last synced: 19 days ago
JSON representation
Simple API monitoring & analytics for Python web applications
- Host: GitHub
- URL: https://github.com/apitally/apitally-py
- Owner: apitally
- License: mit
- Created: 2023-07-02T11:27:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-19T05:02:44.000Z (about 2 months ago)
- Last Synced: 2024-10-23T05:07:11.929Z (about 2 months ago)
- Topics: api, api-analytics, api-monitoring, api-observability, django-ninja, django-rest-framework, fastapi, flask, litestar, monitoring, python, rest-api
- Language: Python
- Homepage: https://apitally.io
- Size: 804 KB
- Stars: 39
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-litestar - `apitally` - A plugin for easy API monitoring with [Apitally](https://apitally.io/litestar) (including API traffic, errors, response times, payload sizes and uptime).<sup>*</sup> (Third-Party Extensions / Monitoring)
README
API monitoring made easy.
Apitally is a simple API monitoring & analytics tool with a focus on data privacy.
It is super easy to use for API projects in Python or Node.js and never collects sensitive data.
🔗 apitally.io
---
# Apitally client library for Python
[](https://github.com/apitally/apitally-py/actions)
[](https://codecov.io/gh/apitally/apitally-py)
[](https://pypi.org/project/apitally/)
This client library for Apitally currently supports the following Python web
frameworks:
- [FastAPI](https://docs.apitally.io/frameworks/fastapi)
- [Starlette](https://docs.apitally.io/frameworks/starlette)
- [Flask](https://docs.apitally.io/frameworks/flask)
- [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
- [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
- [Litestar](https://docs.apitally.io/frameworks/litestar)
Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
the 📚 [documentation](https://docs.apitally.io).
## 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 in
regular intervals
## Install
Use `pip` to install and provide your framework of choice as an extra, for
example:
```bash
pip install apitally[fastapi]
```
The available extras are: `fastapi`, `flask`, `django_rest_framework`,
`django_ninja`, `starlette` and `litestar`.
## Usage
Our [setup guides](https://docs.apitally.io/quickstart) 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](https://docs.apitally.io/frameworks/fastapi).
```python
from fastapi import FastAPI
from apitally.fastapi import ApitallyMiddleware
app = FastAPI()
app.add_middleware(
ApitallyMiddleware,
client_id="your-client-id",
env="dev", # or "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](https://docs.apitally.io/frameworks/flask).
```python
from flask import Flask
from apitally.flask import ApitallyMiddleware
app = Flask(__name__)
app.wsgi_app = ApitallyMiddleware(
app,
client_id="your-client-id",
env="dev", # or "prod" etc.
)
```
### Django
This is an example of how to add the Apitally middleware to a Django Ninja or
Django REST Framework application. For further instructions, see our
[setup guide for Django](https://docs.apitally.io/frameworks/django).
In your Django `settings.py` file:
```python
MIDDLEWARE = [
"apitally.django.ApitallyMiddleware",
# Other middleware ...
]
APITALLY_MIDDLEWARE = {
"client_id": "your-client-id",
"env": "dev", # or "prod" etc.
}
```
### Litestar
This is an example of how to add the Apitally plugin to a Litestar application.
For further instructions, see our
[setup guide for Litestar](https://docs.apitally.io/frameworks/litestar).
```python
from litestar import Litestar
from apitally.litestar import ApitallyPlugin
app = Litestar(
route_handlers=[...],
plugins=[
ApitallyPlugin(
client_id="your-client-id",
env="dev", # or "prod" etc.
),
]
)
```
## Getting help
If you need help please
[create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)
on GitHub or
[join our Slack workspace](https://join.slack.com/t/apitally-community/shared_invite/zt-2b3xxqhdu-9RMq2HyZbR79wtzNLoGHrg).
## License
This library is licensed under the terms of the MIT license.