Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-django
APItoolkit's Django (Python) client SDK.
https://github.com/apitoolkit/apitoolkit-django
apitoolkit apitoolkit-sdk django python
Last synced: about 17 hours ago
JSON representation
APItoolkit's Django (Python) client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-django
- Owner: apitoolkit
- License: mit
- Created: 2023-09-11T10:10:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-16T22:09:24.000Z (4 months ago)
- Last Synced: 2024-11-01T12:46:22.967Z (7 days ago)
- Topics: apitoolkit, apitoolkit-sdk, django, python
- Language: Python
- Homepage: https://apitoolkit.io/docs/sdks/python/django
- Size: 47.9 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Django SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://pypi.org/project/apitoolkit-django) [](https://pypi.org/project/apitoolkit-django) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/python/django?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
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](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install the SDK:
```sh
pip install apitoolkit-django
```
## Configuration
First, add the `APITOOLKIT_KEY` environment variable to your `.env` file, like so:
```sh
APITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}
```
Next, add the `APITOOLKIT_KEY` to your Django settings (`settings.py`) file, like so:
```python
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:
```python
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](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> [!IMPORTANT]
>
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/python/django?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
## 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](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-django/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
