# zlib-fast
<p align="center">
<a href="https://github.com/bdraco/zlib-fast/actions/workflows/ci.yml?query=branch%3Amain">
<img src="https://img.shields.io/github/actions/workflow/status/bdraco/zlib-fast/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
</a>
<a href="https://zlib-fast.readthedocs.io">
<img src="https://img.shields.io/readthedocs/zlib-fast.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
</a>
<a href="https://codecov.io/gh/bdraco/zlib-fast">
<img src="https://img.shields.io/codecov/c/github/bdraco/zlib-fast.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/zlib-fast/">
<img src="https://img.shields.io/pypi/v/zlib-fast.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
</a>
<img src="https://img.shields.io/pypi/pyversions/zlib-fast.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
<img src="https://img.shields.io/pypi/l/zlib-fast.svg?style=flat-square" alt="License">
</p>
---
**Documentation**: <a href="https://zlib-fast.readthedocs.io" target="_blank">https://zlib-fast.readthedocs.io </a>
**Source Code**: <a href="https://github.com/bdraco/zlib-fast" target="_blank">https://github.com/bdraco/zlib-fast </a>
---
A wrapper to use the fastest available zlib
zlib is be a bottleneck for creating backups with `tarfile`. `zlib-fast` replaces usage of `zlib` with [`isal`](https://github.com/pycompression/python-isal) which is a drop-in faster replacement.
Unlike the base isal implementation, this module maps zlib compression
levels for `compressobj` to their nearest `isal` equivalent which allows
it to be used as a drop in replacement with `tarfile`.
## Installation
Install this via pip (or your favourite package manager):
`pip install zlib-fast`
## Usage
Enable zlib-fast support by calling `zlib_fast.enable()`.
```python
import zlib_fast
zlib_fast.enable()
zlib_fast.disable()
```
The most common use case is for use with `tarfile` which does a late import. `enable` will only be effective for future imports of `zlib`, and will not redirect existing imports. If you need to use this module for other use cases, be sure to call `zlib_fast.enable()` before any code that loads `zlib`.
## 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/zlib-fast",
"name": "zlib-fast",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "J. Nick Koston",
"author_email": "nick@koston.org",
"download_url": "https://files.pythonhosted.org/packages/85/c9/563bd86968a221c28875c34f6bcf94f2512b9ac7830f74760aa22ed77921/zlib_fast-0.2.0.tar.gz",
"platform": null,
"description": "# zlib-fast\n\n<p align=\"center\">\n <a href=\"https://github.com/bdraco/zlib-fast/actions/workflows/ci.yml?query=branch%3Amain\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/bdraco/zlib-fast/ci.yml?branch=main&label=CI&logo=github&style=flat-square\" alt=\"CI Status\" >\n </a>\n <a href=\"https://zlib-fast.readthedocs.io\">\n <img src=\"https://img.shields.io/readthedocs/zlib-fast.svg?logo=read-the-docs&logoColor=fff&style=flat-square\" alt=\"Documentation Status\">\n </a>\n <a href=\"https://codecov.io/gh/bdraco/zlib-fast\">\n <img src=\"https://img.shields.io/codecov/c/github/bdraco/zlib-fast.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/zlib-fast/\">\n <img src=\"https://img.shields.io/pypi/v/zlib-fast.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPI Version\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/zlib-fast.svg?style=flat-square&logo=python&logoColor=fff\" alt=\"Supported Python versions\">\n <img src=\"https://img.shields.io/pypi/l/zlib-fast.svg?style=flat-square\" alt=\"License\">\n</p>\n\n---\n\n**Documentation**: <a href=\"https://zlib-fast.readthedocs.io\" target=\"_blank\">https://zlib-fast.readthedocs.io </a>\n\n**Source Code**: <a href=\"https://github.com/bdraco/zlib-fast\" target=\"_blank\">https://github.com/bdraco/zlib-fast </a>\n\n---\n\nA wrapper to use the fastest available zlib\n\nzlib is be a bottleneck for creating backups with `tarfile`. `zlib-fast` replaces usage of `zlib` with [`isal`](https://github.com/pycompression/python-isal) which is a drop-in faster replacement.\n\nUnlike the base isal implementation, this module maps zlib compression\nlevels for `compressobj` to their nearest `isal` equivalent which allows\nit to be used as a drop in replacement with `tarfile`.\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install zlib-fast`\n\n## Usage\n\nEnable zlib-fast support by calling `zlib_fast.enable()`.\n\n```python\n\nimport zlib_fast\n\nzlib_fast.enable()\nzlib_fast.disable()\n```\n\nThe most common use case is for use with `tarfile` which does a late import. `enable` will only be effective for future imports of `zlib`, and will not redirect existing imports. If you need to use this module for other use cases, be sure to call `zlib_fast.enable()` before any code that loads `zlib`.\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": "Apache Software License 2.0",
"summary": "A wrapper to use the fastest available zlib",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/bdraco/zlib-fast/issues",
"Changelog": "https://github.com/bdraco/zlib-fast/blob/main/CHANGELOG.md",
"Documentation": "https://zlib-fast.readthedocs.io",
"Homepage": "https://github.com/bdraco/zlib-fast",
"Repository": "https://github.com/bdraco/zlib-fast"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7be9ff15fc445e2ac690535e2bdf9da37f1deaef535ae8d60c641f47c282b82",
"md5": "8da158233321c248c7ae0969ab6b3db3",
"sha256": "40e4f306061904e08354dfcdff25a614709e962a87ce3a833a052d9d8e877bf4"
},
"downloads": -1,
"filename": "zlib_fast-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8da158233321c248c7ae0969ab6b3db3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 9957,
"upload_time": "2024-01-28T00:29:33",
"upload_time_iso_8601": "2024-01-28T00:29:33.101841Z",
"url": "https://files.pythonhosted.org/packages/b7/be/9ff15fc445e2ac690535e2bdf9da37f1deaef535ae8d60c641f47c282b82/zlib_fast-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85c9563bd86968a221c28875c34f6bcf94f2512b9ac7830f74760aa22ed77921",
"md5": "078a3b0bd3e22b807f240b5bcb51dbeb",
"sha256": "23c80e89518854eaea85c52db88c0551de67d3ac32d5ac5441196acfe6f8b24f"
},
"downloads": -1,
"filename": "zlib_fast-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "078a3b0bd3e22b807f240b5bcb51dbeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 9588,
"upload_time": "2024-01-28T00:29:34",
"upload_time_iso_8601": "2024-01-28T00:29:34.755523Z",
"url": "https://files.pythonhosted.org/packages/85/c9/563bd86968a221c28875c34f6bcf94f2512b9ac7830f74760aa22ed77921/zlib_fast-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 00:29:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bdraco",
"github_project": "zlib-fast",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zlib-fast"
}
JSON
