{"id":18696171,"url":"https://github.com/apitoolkit/apitoolkit-django","last_synced_at":"2025-04-12T07:30:55.095Z","repository":{"id":194086082,"uuid":"689986935","full_name":"apitoolkit/apitoolkit-django","owner":"apitoolkit","description":"APItoolkit's Django (Python) client SDK.","archived":false,"fork":false,"pushed_at":"2024-07-16T22:09:24.000Z","size":49,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-01T12:46:22.967Z","etag":null,"topics":["apitoolkit","apitoolkit-sdk","django","python"],"latest_commit_sha":null,"homepage":"https://apitoolkit.io/docs/sdks/python/django","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apitoolkit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-11T10:10:44.000Z","updated_at":"2024-08-08T14:17:27.000Z","dependencies_parsed_at":"2023-09-11T16:09:35.428Z","dependency_job_id":"dee51a80-3c80-4f2a-a595-b2f8cdbd4650","html_url":"https://github.com/apitoolkit/apitoolkit-django","commit_stats":null,"previous_names":["apitoolkit/apitoolkit-django"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-django","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-django/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-django/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-django/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apitoolkit","download_url":"https://codeload.github.com/apitoolkit/apitoolkit-django/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223502195,"owners_count":17155938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apitoolkit","apitoolkit-sdk","django","python"],"created_at":"2024-11-07T11:17:25.679Z","updated_at":"2024-11-07T11:17:26.367Z","avatar_url":"https://github.com/apitoolkit.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)\n\n## Django SDK\n\n[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=django)](https://github.com/topics/apitoolkit-sdk) [![PyPI - Version](https://img.shields.io/pypi/v/apitoolkit-django)](https://pypi.org/project/apitoolkit-django) [![PyPI - Downloads](https://img.shields.io/pypi/dw/apitoolkit-django)](https://pypi.org/project/apitoolkit-django) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/python/django?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) \n\nAPItoolkit 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.\n\n\u003c/div\u003e\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Contributing and Help](#contributing-and-help)\n- [License](#license)\n\n---\n\n## Installation\n\nKindly run the command below to install the SDK:\n\n```sh\npip install apitoolkit-django\n```\n\n## Configuration\n\nFirst, add the `APITOOLKIT_KEY` environment variable to your `.env` file, like so:\n\n```sh\nAPITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}\n```\n\nNext, add the `APITOOLKIT_KEY` to your Django settings (`settings.py`) file, like so:\n\n```python\nfrom pathlib import Path\nfrom dotenv import load_dotenv\nimport os\n\nload_dotenv()\n\n# Build paths inside the project like this: BASE_DIR / 'subdir'.\nBASE_DIR = Path(__file__).resolve().parent.parent\n\nAPITOOLKIT_KEY = os.getenv('APITOOLKIT_KEY')\nAPITOOLKIT_DEBUG = False\nAPITOOLKIT_TAGS= [\"environment: production\", \"region: us-east-1\"]\nAPITOOLKIT_SERVICE_VERSION= \"v2.0\"\n\n# Application definition\nINSTALLED_APPS = [\n    'django.contrib.admin',\n    'django.contrib.auth',\n    'django.contrib.sessions',\n]\n\n...\n```\n\nThen add the `apitoolkit_django.APIToolkit` middleware into the `settings.py` middleware list, like so:\n\n```python\nMIDDLEWARE = [\n    'apitoolkit_django.APIToolkit', # Initialize APItoolkit\n    'django.middleware.security.SecurityMiddleware',\n    'django.contrib.sessions.middleware.SessionMiddleware',\n    'django.middleware.common.CommonMiddleware',\n    ...,\n]\n```\n\n\u003e [!NOTE]\n\u003e \n\u003e 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\u0026utm_medium=github\u0026utm_source=sdks_readme) generated from the APItoolkit dashboard.\n\n\u003cbr /\u003e\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e 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\u0026utm_medium=github\u0026utm_source=sdks_readme).\n\n## Contributing and Help\n\nTo contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:\n- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).\n- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme).\n- Create a [new issue](https://github.com/apitoolkit/apitoolkit-django/issues/new/choose) in this repository.\n\n## License\n\nThis repository is published under the [MIT](LICENSE) license.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n    \n\u003ca href=\"https://apitoolkit.io?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true\" width=\"40\" /\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapitoolkit%2Fapitoolkit-django","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapitoolkit%2Fapitoolkit-django","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapitoolkit%2Fapitoolkit-django/lists"}