apitoolkit-django 1.4.3

A Django SDK for Apitoolkit integration

Django SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Django (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.

---

Table of Contents

• Installation
• Configuration
• Contributing and Help
• License

---

Installation

Kindly run the command below to install the SDK:

pip install apitoolkit-django

Configuration

First, add the APITOOLKIT_KEY environment variable to your .env file, like so:

APITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}

Next, add the APITOOLKIT_KEY to your Django settings (settings.py) file, like so:

from pathlib import Path
from dotenv import load_dotenv
import os

load_dotenv()

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

APITOOLKIT_KEY = os.getenv('APITOOLKIT_KEY')
APITOOLKIT_DEBUG = False
APITOOLKIT_TAGS= ["environment: production", "region: us-east-1"]
APITOOLKIT_SERVICE_VERSION= "v2.0"

# Application definition
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.sessions',
]

...

Then add the apitoolkit_django.APIToolkit middleware into the settings.py middleware list, like so:

MIDDLEWARE = [
    'apitoolkit_django.APIToolkit', # Initialize APItoolkit
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    ...,
]

[!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.

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.

---