Flask SDK
APIToolkit Flask SDK is a middleware that can be used to monitor HTTP requests, report errors and monitor outgoing requests. It is provides additional functionalities on top of the open telemetry instrumentation which creates a custom span for each request capturing details about the request including request, response bodies, headers, and more.
Table of Contents
Installation
Kindly run the command below to install the apitoolkit django sdks and necessary opentelemetry packages:
pip install apitoolkit-flask opentelemetry-distro opentelemetry-exporter-otlp
opentelemetry-bootstrap -a install
Setup Open Telemetry
Setting up open telemetry allows you to send traces, metrics and logs to the APIToolkit platform. To setup open telemetry, you need to configure the following environment variables:
OTEL_EXPORTER_OTLP_ENDPOINT="http://otelcol.apitoolkit.io:4317"
OTEL_SERVICE_NAME="my-service" # Specifies the name of the service.
OTEL_RESOURCE_ATTRIBUTES="at-project-key={ENTER_YOUR_API_KEY_HERE}" # Adds your API KEY to the resource.
OTEL_EXPORTER_OTLP_PROTOCOL="grpc" #Specifies the protocol to use for the OpenTelemetry exporter.
Then run the command below to start your server with opentelemetry instrumented:
opentelemetry-instrument flask run --app app
APItoolkit Django Configuration
After setting up open telemetry, you can now configure the apitoolkit django middleware.
Next, initialize APItoolkit in your application's entry point (e.g., main.py), like so:
from flask import Flask
from apitoolkit_flask import APIToolkit
app = Flask(__name__)
# Initialize APItoolkit
apitoolkit = APIToolkit(
service_name = "my-service",
capture_request_body = True,
capture_response_body = True,
)
@app.before_request
def before_request():
apitoolkit.beforeRequest()
@app.after_request
def after_request(response):
apitoolkit.afterRequest(response)
return response
# END Initialize APItoolkit
@app.route('/hello', methods=['GET', 'POST'])
def sample_route():
return {"Hello": "World"}
app.run(debug=True)
Contributing and Help
To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:
- Read our Contributors Guide.
- Join our community Discord Server.
- Create a new issue in this repository.
License
This repository is published under the MIT license.
Metadata
Release files for apitoolkit-flask 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| apitoolkit_flask-1.0.3.tar.gz | 4.3 kB | Without provenance | Details for apitoolkit_flask-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| apitoolkit_flask-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for apitoolkit_flask-1.0.3-py3-none-any.whl |
Total release size: 8.6 kB
Release files / apitoolkit_flask-1.0.3.tar.gz
| Download URL | apitoolkit_flask-1.0.3.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
35cd96d132838437a208a844256425db829c7d26372699ffd8af4270d052cb6f
|
|
BLAKE2b-256 checksum How to use checksums |
ae7cb0c662f9f9d97d496eda94e3858f69b3b78226abf0ebbbc51145c9ed902e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.3
|
Release files / apitoolkit_flask-1.0.3-py3-none-any.whl
| Download URL | apitoolkit_flask-1.0.3-py3-none-any.whl |
|---|---|
| Size | 4.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
454d90a0fe1526172a576e63961f2123feb5ce8bed88bfc318c67167e2077840
|
|
BLAKE2b-256 checksum How to use checksums |
1a4daae342448ff7a3a435a1a36bd5e231bdd685abba6067b3efb2d2036f1bdb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.3
|
Security for apitoolkit-flask 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.