APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Pyramid (Python) application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.
Kindly run the command below to install the SDK:
pip install apitoolkit-pyramidNext, add the APITOOLKIT_KEY variable to your settings, like so:
settings = {
"APITOOLKIT_KEY" = "{ENTER_YOUR_API_KEY_HERE}"
"APITOOLKIT_DEBUG" = False
"APITOOLKIT_TAGS" = ["environment: production", "region: us-east-1"]
"APITOOLKIT_SERVICE_VERSION" = "v2.0"
"APITOOLKIT_ROUTES_WHITELIST" = ["/api/first", "/api/second"]
"APITOOLKIT_IGNORE_HTTP_CODES" = [404, 429]
}Then, initialize APItoolkit in your application's entry point (e.g., app.py), like so:
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import view_config
@view_config(
route_name='home'
)
def home(request):
return Response('Welcome!')
if __name__ == '__main__':
setting = {"APITOOLKIT_KEY": "{ENTER_YOUR_API_KEY_HERE}"}
with Configurator(settings=setting) as config:
# Initialize APItoolkit
config.add_tween("apitoolkit_pyramid.APIToolkit")
config.add_route('home', '/')
config.scan()
app = config.make_wsgi_app()
server = make_server('0.0.0.0', 6543, app)
server.serve_forever()Note
The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.
Important
To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.
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.
This repository is published under the MIT license.
