| Name | svix JSON |
| Version |
1.23.0
JSON |
| download |
| home_page | https://www.svix.com |
| Summary | Svix webhooks API client and webhook verification library |
| upload_time | 2024-05-03 14:15:00 |
| maintainer | None |
| docs_url | None |
| author | Svix |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
svix
diahook
webhooks
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">
<a style="text-decoration: none" href="https://www.svix.com">
<img width="120" src="https://avatars.githubusercontent.com/u/80175132?s=200&v=4" />
<p align="center">Svix - Webhooks as a service</p>
</a>
</h1>
<h2 align="center">
<a href="https://svix.com">Website</a> | <a href="https://docs.svix.com">Documentation</a> | <a href="https://svix.com/slack">Community Slack</a>
<h2>
Python library for interacting with the Svix API and verifying webhook signatures
[](https://pypi.python.org/pypi/svix/)
[](https://www.svix.com/slack/)
# Usage Documentation
You can find general usage documentation at <https://docs.svix.com>. For complete API documentation with code examples for each endpoint in all of our official client libraries head over to our API documentation site at <https://api.svix.com>.
# Language Support
<table style="table-layout:fixed; white-space: nowrap;">
<th colspan="2">⚡️ Features ⚡️</th>
<tr>
<th>Officially Supported</th>
<th>✅</th>
</tr>
<tr>
<th>API Support</th>
<th>✅</th>
</tr>
<tr>
<th>Signature Verification</th>
<th>✅</th>
</tr>
<tr>
<th>Caveats</th>
<th>None! 🚀</th>
</tr>
</table>
# Installation
```sh
pip install Svix
```
## Usage
Please refer to [the documentation](https://docs.svix.com/) or [the API reference](https://api.svix.com/docs) for more usage instructions.
### Async
```python
from svix.api import SvixAsync, ApplicationIn
svix = SvixAsync("AUTH_TOKEN")
app = await svix.application.create(ApplicationIn(name="Application name"))
```
### Sync
```python
from svix.api import Svix, ApplicationIn
svix = Svix("AUTH_TOKEN")
app = svix.application.create(ApplicationIn(name="Application name"))
```
# Development
First checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.
## Requirements
- python 3
## Installing dependencies
```sh
python -m venv .venv
pip install -r requirements.txt && pip install -r requirements-dev.txt
./scripts/generate_openapi.sh
```
## Contributing
Before opening a PR be sure to format your code!
```sh
./scripts/format.sh
```
## Running Tests
Simply run:
```sh
pytest
```
Raw data
{
"_id": null,
"home_page": "https://www.svix.com",
"name": "svix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "svix, diahook, webhooks",
"author": "Svix",
"author_email": "development@svix.com",
"download_url": "https://files.pythonhosted.org/packages/6b/4f/0b1cd803970eee270c6ca5eea8fa6eb14d09ff4609e159bac91e4b715611/svix-1.23.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <a style=\"text-decoration: none\" href=\"https://www.svix.com\">\n <img width=\"120\" src=\"https://avatars.githubusercontent.com/u/80175132?s=200&v=4\" />\n <p align=\"center\">Svix - Webhooks as a service</p>\n </a>\n</h1>\n<h2 align=\"center\">\n <a href=\"https://svix.com\">Website</a> | <a href=\"https://docs.svix.com\">Documentation</a> | <a href=\"https://svix.com/slack\">Community Slack</a>\n<h2>\n\nPython library for interacting with the Svix API and verifying webhook signatures\n\n\n[](https://pypi.python.org/pypi/svix/)\n\n[](https://www.svix.com/slack/)\n\n# Usage Documentation\n\nYou can find general usage documentation at <https://docs.svix.com>. For complete API documentation with code examples for each endpoint in all of our official client libraries head over to our API documentation site at <https://api.svix.com>.\n\n# Language Support\n\n<table style=\"table-layout:fixed; white-space: nowrap;\">\n <th colspan=\"2\">\u26a1\ufe0f Features \u26a1\ufe0f</th>\n <tr>\n <th>Officially Supported</th>\n <th>\u2705</th>\n </tr>\n <tr>\n <th>API Support</th>\n <th>\u2705</th>\n </tr>\n <tr>\n <th>Signature Verification</th>\n <th>\u2705</th>\n </tr>\n <tr>\n <th>Caveats</th>\n <th>None! \ud83d\ude80</th>\n </tr>\n</table>\n\n# Installation\n\n```sh\npip install Svix\n```\n\n## Usage\nPlease refer to [the documentation](https://docs.svix.com/) or [the API reference](https://api.svix.com/docs) for more usage instructions.\n\n### Async\n```python\nfrom svix.api import SvixAsync, ApplicationIn\n\nsvix = SvixAsync(\"AUTH_TOKEN\")\napp = await svix.application.create(ApplicationIn(name=\"Application name\"))\n```\n\n### Sync\n\n```python\nfrom svix.api import Svix, ApplicationIn\n\nsvix = Svix(\"AUTH_TOKEN\")\napp = svix.application.create(ApplicationIn(name=\"Application name\"))\n```\n\n# Development\n\nFirst checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.\n\n## Requirements\n\n - python 3\n\n## Installing dependencies\n\n```sh\npython -m venv .venv\npip install -r requirements.txt && pip install -r requirements-dev.txt\n./scripts/generate_openapi.sh\n```\n\n## Contributing\n\nBefore opening a PR be sure to format your code!\n\n```sh\n./scripts/format.sh\n```\n\n## Running Tests\n\nSimply run:\n\n```sh\npytest\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Svix webhooks API client and webhook verification library",
"version": "1.23.0",
"project_urls": {
"Homepage": "https://www.svix.com"
},
"split_keywords": [
"svix",
" diahook",
" webhooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b4f0b1cd803970eee270c6ca5eea8fa6eb14d09ff4609e159bac91e4b715611",
"md5": "95c488df4e7d6ede55da35c40e0ed65c",
"sha256": "937faa7cb39b604afc73a9cfec3bf03ef02ec41d11404e7f509f50802d30ae92"
},
"downloads": -1,
"filename": "svix-1.23.0.tar.gz",
"has_sig": false,
"md5_digest": "95c488df4e7d6ede55da35c40e0ed65c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 87727,
"upload_time": "2024-05-03T14:15:00",
"upload_time_iso_8601": "2024-05-03T14:15:00.369755Z",
"url": "https://files.pythonhosted.org/packages/6b/4f/0b1cd803970eee270c6ca5eea8fa6eb14d09ff4609e159bac91e4b715611/svix-1.23.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 14:15:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "svix"
}
