Skip to content

Commit 672d926

Browse files
committed
Add notes on how to list python-isal as a dependency
1 parent 0e62277 commit 672d926

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,25 @@ installation options check the `documentation
9999

100100
.. _differences-with-zlib-and-gzip-modules:
101101

102+
python-isal as a dependency in your project
103+
-------------------------------------------
104+
105+
Python-isal supports a limited amount of platforms for which wheels have been
106+
made available. To prevent your users from running into issues when installing
107+
your project please list a python-isal dependency as follows.
108+
109+
``setup.cfg``::
110+
111+
install_requires =
112+
isal; platform.python_implementation == 'CPython' and (platform.machine == "x86_64" or platform.machine == "AMD64")
113+
114+
``setup.py``::
115+
116+
extras_require={
117+
":platform.python_implementation == 'CPython' and "
118+
"(platform.machine == 'x86_64' or platform.machine == 'AMD64')": ['isal']
119+
},
120+
102121
Differences with zlib and gzip modules
103122
--------------------------------------
104123

0 commit comments

Comments
 (0)