# aiohttp-fast-zlib
<p align="center">
<a href="https://github.com/bdraco/aiohttp-fast-zlib/actions/workflows/ci.yml?query=branch%3Amain">
<img src="https://img.shields.io/github/actions/workflow/status/bdraco/aiohttp-fast-zlib/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
</a>
<a href="https://codecov.io/gh/bdraco/aiohttp-fast-zlib">
<img src="https://img.shields.io/codecov/c/github/bdraco/aiohttp-fast-zlib.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
</a>
</p>
<p align="center">
<a href="https://python-poetry.org/">
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
</a>
<a href="https://github.com/ambv/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/aiohttp-fast-zlib/">
<img src="https://img.shields.io/pypi/v/aiohttp-fast-zlib.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
</a>
<img src="https://img.shields.io/pypi/pyversions/aiohttp-fast-zlib.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
<img src="https://img.shields.io/pypi/l/aiohttp-fast-zlib.svg?style=flat-square" alt="License">
</p>
---
**Source Code**: <a href="https://github.com/bdraco/aiohttp-fast-zlib" target="_blank">https://github.com/bdraco/aiohttp-fast-zlib </a>
---
Use the fastest installed zlib compatible library with aiohttp
zlib is be a bottleneck for aiohttp, especially for websocket connections. `aiohttp-fast-zlib` replaces usage of `zlib` in `aiohttp` with `isal` or `zlib-ng` which is a drop-in faster replacement in most cases. Be sure to read the [isal](https://github.com/pycompression/python-isal) documentation and the [zlib-ng](https://github.com/pycompression/python-zlib-ng) documentation.
## Installation
Install this via pip (or your favourite package manager):
`pip install aiohttp-fast-zlib[isal]`
`pip install aiohttp-fast-zlib[zlib-ng]`
## Usage
Enable [isal](https://github.com/pycompression/python-isal) or [zlib-ng](https://github.com/pycompression/python-zlib-ng) support in aiohttp by calling `enable`
```python
import aiohttp_zlib_fast
# isal is preferred over zlib_ng if it is available
aiohttp_zlib_fast.enable()
aiohttp_zlib_fast.enable()
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- markdownlint-disable -->
<!-- markdownlint-enable -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Credits
This package was created with
[Copier](https://copier.readthedocs.io/) and the
[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
project template.
Raw data
{
"_id": null,
"home_page": "https://github.com/bdraco/aiohttp-fast-zlib",
"name": "aiohttp-fast-zlib",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "J. Nick Koston",
"author_email": "nick@koston.org",
"download_url": "https://files.pythonhosted.org/packages/4c/c8/ffd99f2740da7996f7d553ac47d17870fa5884230d430d45b45631081c75/aiohttp_fast_zlib-0.2.1.tar.gz",
"platform": null,
"description": "# aiohttp-fast-zlib\n\n<p align=\"center\">\n <a href=\"https://github.com/bdraco/aiohttp-fast-zlib/actions/workflows/ci.yml?query=branch%3Amain\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/bdraco/aiohttp-fast-zlib/ci.yml?branch=main&label=CI&logo=github&style=flat-square\" alt=\"CI Status\" >\n </a>\n <a href=\"https://codecov.io/gh/bdraco/aiohttp-fast-zlib\">\n <img src=\"https://img.shields.io/codecov/c/github/bdraco/aiohttp-fast-zlib.svg?logo=codecov&logoColor=fff&style=flat-square\" alt=\"Test coverage percentage\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://python-poetry.org/\">\n <img src=\"https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=\" alt=\"Poetry\">\n </a>\n <a href=\"https://github.com/ambv/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"black\">\n </a>\n <a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square\" alt=\"pre-commit\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/aiohttp-fast-zlib/\">\n <img src=\"https://img.shields.io/pypi/v/aiohttp-fast-zlib.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPI Version\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/aiohttp-fast-zlib.svg?style=flat-square&logo=python&logoColor=fff\" alt=\"Supported Python versions\">\n <img src=\"https://img.shields.io/pypi/l/aiohttp-fast-zlib.svg?style=flat-square\" alt=\"License\">\n</p>\n\n---\n\n**Source Code**: <a href=\"https://github.com/bdraco/aiohttp-fast-zlib\" target=\"_blank\">https://github.com/bdraco/aiohttp-fast-zlib </a>\n\n---\n\nUse the fastest installed zlib compatible library with aiohttp\n\nzlib is be a bottleneck for aiohttp, especially for websocket connections. `aiohttp-fast-zlib` replaces usage of `zlib` in `aiohttp` with `isal` or `zlib-ng` which is a drop-in faster replacement in most cases. Be sure to read the [isal](https://github.com/pycompression/python-isal) documentation and the [zlib-ng](https://github.com/pycompression/python-zlib-ng) documentation.\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install aiohttp-fast-zlib[isal]`\n`pip install aiohttp-fast-zlib[zlib-ng]`\n\n## Usage\n\nEnable [isal](https://github.com/pycompression/python-isal) or [zlib-ng](https://github.com/pycompression/python-zlib-ng) support in aiohttp by calling `enable`\n\n```python\n\nimport aiohttp_zlib_fast\n\n# isal is preferred over zlib_ng if it is available\naiohttp_zlib_fast.enable()\naiohttp_zlib_fast.enable()\n```\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- prettier-ignore-start -->\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- markdownlint-disable -->\n<!-- markdownlint-enable -->\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-end -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## Credits\n\nThis package was created with\n[Copier](https://copier.readthedocs.io/) and the\n[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)\nproject template.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Use the fastest installed zlib compatible library with aiohttp",
"version": "0.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/bdraco/aiohttp-fast-zlib/issues",
"Changelog": "https://github.com/bdraco/aiohttp-fast-zlib/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/bdraco/aiohttp-fast-zlib",
"Repository": "https://github.com/bdraco/aiohttp-fast-zlib"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d956eb63132c4b7d3781d66c96b45559c832477b3f39152e7f2c79d27aaa68f5",
"md5": "1f8cb65c3bab9cc8d381ef92e6f9ba52",
"sha256": "18861129a58b4a045c082aa5e878428f87b41bc8aaecf7af0c57ba4c7c22a02d"
},
"downloads": -1,
"filename": "aiohttp_fast_zlib-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f8cb65c3bab9cc8d381ef92e6f9ba52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 8416,
"upload_time": "2024-12-20T21:02:25",
"upload_time_iso_8601": "2024-12-20T21:02:25.245022Z",
"url": "https://files.pythonhosted.org/packages/d9/56/eb63132c4b7d3781d66c96b45559c832477b3f39152e7f2c79d27aaa68f5/aiohttp_fast_zlib-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cc8ffd99f2740da7996f7d553ac47d17870fa5884230d430d45b45631081c75",
"md5": "065ce541786414945ec1d843ad39c520",
"sha256": "f0f392ebd663e781a9e5c10646f24c26c0b9fac6293ddf8e28f37dad66ce5117"
},
"downloads": -1,
"filename": "aiohttp_fast_zlib-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "065ce541786414945ec1d843ad39c520",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 8667,
"upload_time": "2024-12-20T21:02:27",
"upload_time_iso_8601": "2024-12-20T21:02:27.582489Z",
"url": "https://files.pythonhosted.org/packages/4c/c8/ffd99f2740da7996f7d553ac47d17870fa5884230d430d45b45631081c75/aiohttp_fast_zlib-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 21:02:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bdraco",
"github_project": "aiohttp-fast-zlib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiohttp-fast-zlib"
}
JSON
