feat: make isal optional and installed only as an extra (#7)

bdraco · Jan 4, 2024 · 0b5754b · 0b5754b
1 parent a82a022
commit 0b5754b
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -42,10 +42,14 @@ If `isal` is available, this library will try to use `isal`, and will fallback t
 
 ## Installation
 
-Install this via pip (or your favourite package manager):
+Install this via pip (or your favorite package manager):
 
 `pip install aiohttp-zlib-ng`
 
+To install the optional `isal` speed up:
+
+`pip install aiohttp-zlib-ng[isal]`
+
 ## Usage
 
 Enable [zlib-ng](https://github.com/pycompression/python-zlib-ng) support in aiohttp by calling `enable_zlib_ng`

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,12 +25,16 @@ packages = [
 python = "^3.8"
 aiohttp = ">=3.8.5"
 zlib-ng = ">=0.3.0"
-isal = {markers = "platform_machine == \"x86_64\" or platform_machine == \"AMD64\" or platform_machine == \"aarch64\" or platform_machine == \"arm64\"", version = ">=1.5.3"}
+isal = {version = ">=1.5.3", optional = true, markers = "platform_machine == \"x86_64\" or platform_machine == \"AMD64\" or platform_machine == \"aarch64\" or platform_machine == \"arm64\""}
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0"
 pytest-cov = "^3.0"
 
+
+[tool.poetry.extras]
+isal = ["isal"]
+
 [tool.semantic_release]
 branch = "main"
 version_toml = ["pyproject.toml:tool.poetry.version"]