| Name | apitoolkit-python JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | A share python sdk for python web frameworks |
| upload_time | 2024-07-08 14:12:49 |
| maintainer | None |
| docs_url | None |
| author | APIToolkit |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
## Python SDKs Shared Code
[](https://github.com/topics/apitoolkit-sdk) [](https://pypi.org/project/apitoolkit-python) [](https://pypi.org/project/apitoolkit-python) [](https://discord.gg/dEB6EjQnKB) [](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks)
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Python application with APItoolkit, you can use any of the [existing Python framework SDKs](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks) or directly use this `apitoolkit-python` package (the shared code for all the Python SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.
</div>
---
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install this package:
```sh
pip install apitoolkit-python
```
## Configuration
Next, initialize APItoolkit in your application's entry point (e.g., `app.py`), like so:
```py
from apitoolkit_python import APIToolkit, report_error, observe_request
apitoolkit = APIToolkit(
api_key="{ENTER_YOUR_API_KEY_HERE}",
debug=False,
tags=["environment: production", "region: us-east-1"],
service_version="v2.0"
)
...
```
> [!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_source=github-sdks) generated from the APItoolkit dashboard.
> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [Python SDK documentation](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks).
## Contributing and Help
To contribute to the development of this PROJECT 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://discord.gg/dEB6EjQnKB).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-python/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
<div align="center">
<a href="https://apitoolkit.io?utm_source=github-sdks" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true" width="40" /></a>
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "apitoolkit-python",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "APIToolkit",
"author_email": "hello@apitoolkit.io",
"download_url": "https://files.pythonhosted.org/packages/fc/1e/cbfd5d544cc1960e54a59fb17e88fdbbddd84b3ed2e0ae056da83726f5e9/apitoolkit-python-0.1.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n\n\n\n## Python SDKs Shared Code\n\n[](https://github.com/topics/apitoolkit-sdk) [](https://pypi.org/project/apitoolkit-python) [](https://pypi.org/project/apitoolkit-python) [](https://discord.gg/dEB6EjQnKB) [](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks) \n\nAPItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Python application with APItoolkit, you can use any of the [existing Python framework SDKs](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks) or directly use this `apitoolkit-python` package (the shared code for all the Python SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.\n\n</div>\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 this package:\n\n```sh\npip install apitoolkit-python\n```\n\n## Configuration\n\nNext, initialize APItoolkit in your application's entry point (e.g., `app.py`), like so:\n\n```py\nfrom apitoolkit_python import APIToolkit, report_error, observe_request\n\napitoolkit = APIToolkit(\n api_key=\"{ENTER_YOUR_API_KEY_HERE}\",\n debug=False,\n tags=[\"environment: production\", \"region: us-east-1\"],\n service_version=\"v2.0\"\n)\n\n...\n```\n\n> [!NOTE]\n> \n> - 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_source=github-sdks) generated from the APItoolkit dashboard.\n> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [Python SDK documentation](https://apitoolkit.io/docs/sdks/python?utm_source=github-sdks).\n\n## Contributing and Help\n\nTo contribute to the development of this PROJECT 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://discord.gg/dEB6EjQnKB).\n- Create a [new issue](https://github.com/apitoolkit/apitoolkit-python/issues/new/choose) in this repository.\n\n## License\n\nThis repository is published under the [MIT](LICENSE) license.\n\n---\n\n<div align=\"center\">\n \n<a href=\"https://apitoolkit.io?utm_source=github-sdks\" target=\"_blank\" rel=\"noopener noreferrer\"><img src=\"https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true\" width=\"40\" /></a>\n\n</div>\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A share python sdk for python web frameworks",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be552aa5fee14d5f6e4a54f856cca477b2c529a15b7cfa750d42639a7d50e415",
"md5": "33c5035cc0c8c294be7ad94673ba7b23",
"sha256": "c79ab835a77beb8f654aff4b6fc6c1198de1d1bebfc9cd5af23524e69200a5a8"
},
"downloads": -1,
"filename": "apitoolkit_python-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33c5035cc0c8c294be7ad94673ba7b23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5490,
"upload_time": "2024-07-08T14:12:47",
"upload_time_iso_8601": "2024-07-08T14:12:47.622650Z",
"url": "https://files.pythonhosted.org/packages/be/55/2aa5fee14d5f6e4a54f856cca477b2c529a15b7cfa750d42639a7d50e415/apitoolkit_python-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc1ecbfd5d544cc1960e54a59fb17e88fdbbddd84b3ed2e0ae056da83726f5e9",
"md5": "7b643642b83937c75fee8b7d5b874fd3",
"sha256": "936e4a1768cbbdd529458efd7b443e33bff53cceae32c202bf577885f2f92956"
},
"downloads": -1,
"filename": "apitoolkit-python-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7b643642b83937c75fee8b7d5b874fd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5189,
"upload_time": "2024-07-08T14:12:49",
"upload_time_iso_8601": "2024-07-08T14:12:49.289871Z",
"url": "https://files.pythonhosted.org/packages/fc/1e/cbfd5d544cc1960e54a59fb17e88fdbbddd84b3ed2e0ae056da83726f5e9/apitoolkit-python-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 14:12:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "apitoolkit-python"
}
