Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-pyramid
python pyramid sdk
https://github.com/apitoolkit/apitoolkit-pyramid
Last synced: about 17 hours ago
JSON representation
python pyramid sdk
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-pyramid
- Owner: apitoolkit
- License: mit
- Created: 2024-04-01T20:31:59.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-03T08:45:01.000Z (7 months ago)
- Last Synced: 2024-04-03T22:44:19.378Z (7 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Pyramid SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://pypi.org/project/apitoolkit-pyramid) [](https://pypi.org/project/apitoolkit-pyramid) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/python/pyramid?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 Pyramid (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-pyramid
```
## Configuration
Next, add the `APITOOLKIT_KEY` variable to your settings, like so:
```python
settings = {
"APITOOLKIT_KEY" = "{ENTER_YOUR_API_KEY_HERE}"
"APITOOLKIT_DEBUG" = False
"APITOOLKIT_TAGS" = ["environment: production", "region: us-east-1"]
"APITOOLKIT_SERVICE_VERSION" = "v2.0"
"APITOOLKIT_ROUTES_WHITELIST" = ["/api/first", "/api/second"]
"APITOOLKIT_IGNORE_HTTP_CODES" = [404, 429]
}
```
Then, initialize APItoolkit in your application's entry point (e.g., `app.py`), like so:
```python
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import view_config
@view_config(
route_name='home'
)
def home(request):
return Response('Welcome!')
if __name__ == '__main__':
setting = {"APITOOLKIT_KEY": "{ENTER_YOUR_API_KEY_HERE}"}
with Configurator(settings=setting) as config:
# Initialize APItoolkit
config.add_tween("apitoolkit_pyramid.APIToolkit")
config.add_route('home', '/')
config.scan()
app = config.make_wsgi_app()
server = make_server('0.0.0.0', 6543, app)
server.serve_forever()
```
> [!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/pyramid?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-pyramid/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
