Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-flask
APItoolkit's Flask (Python) client SDK.
https://github.com/apitoolkit/apitoolkit-flask
apitoolkit apitoolkit-sdk flask python
Last synced: about 17 hours ago
JSON representation
APItoolkit's Flask (Python) client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-flask
- Owner: apitoolkit
- License: mit
- Created: 2023-09-05T07:33:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T11:53:23.000Z (2 months ago)
- Last Synced: 2024-10-03T14:38:30.719Z (about 1 month ago)
- Topics: apitoolkit, apitoolkit-sdk, flask, python
- Language: Python
- Homepage: https://apitoolkit.io/docs/sdks/python/flask
- Size: 45.9 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Flask SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://pypi.org/project/apitoolkit-flask) [](https://pypi.org/project/apitoolkit-flask) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/python/flask?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 Flask (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-flask
```
## Configuration
Next, initialize APItoolkit in your application's entry point (e.g., `main.py`), like so:
```python
from flask import Flask
from apitoolkit_flask import APIToolkit
app = Flask(__name__)
# Initialize APItoolkit
apitoolkit = APIToolkit(
api_key = "{ENTER_YOUR_API_KEY_HERE}",
debug = False,
tags = ["environment: production", "region: us-east-1"],
service_version = "v2.0"
)
@app.before_request
def before_request():
apitoolkit.beforeRequest()
@app.after_request
def after_request(response):
apitoolkit.afterRequest(response)
return response
# END Initialize APItoolkit
@app.route('/hello', methods=['GET', 'POST'])
def sample_route():
return {"Hello": "World"}
app.run(debug=True)
```
> [!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/flask?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-flask/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
