Make rle and openjpeg requirements optional (#66)

* Make rle and openjpeg requirements optional * Update version and add release note * Fix package name in module docstring
pydicom · Jan 4, 2022 · 68455e3 · 68455e3
1 parent a539187
commit 68455e3
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,14 @@ A Python 3.6+ framework for decoding JPEG images and decoding/encoding RLE datas
 pip install pylibjpeg
 ```
 
+##### Installing extra requirements
+
+The package can be installed with extra requirements `openjpeg` or `rle` to enable support for JPEG-2000 and Run-Length Encoding (RLE), respectively:
+
+```
+pip install pylibjpeg[openjpeg,rle]
+```
+
 #### Installing the development version
 
 Make sure [Git](https://git-scm.com/) is installed, then

diff --git a/docs/release_notes/v1.4.0.rst b/docs/release_notes/v1.4.0.rst
@@ -0,0 +1,6 @@
+.. _v1.4.0:
+
+1.4.0
+=====
+
+* Made pylibjpeg-openjpeg and pylibjpeg-rle dependencies optional (using `extras_require`)
diff --git a/pylibjpeg/_version.py b/pylibjpeg/_version.py
@@ -1,9 +1,9 @@
-"""Version information for pynetdicom based on PEP396 and 440."""
+"""Version information for pylibjpeg based on PEP396 and 440."""
 
 import re
 
 
-__version__ = '1.3.0'
+__version__ = '1.4.0'
 
 
 VERSION_PATTERN = r"""

diff --git a/setup.py b/setup.py
@@ -48,7 +48,11 @@
         "Topic :: Software Development :: Libraries",
     ],
     packages = find_packages(),
-    install_requires = ['numpy', 'pylibjpeg-openjpeg', 'pylibjpeg-rle'],
+    extras_require = {
+        'rle': ['pylibjpeg-rle'],
+        'openjpeg': ['pylibjpeg-openjpeg']
+    },
+    install_requires = ['numpy'],
     include_package_data = True,
     zip_safe = False,
     python_requires = ">=3.6",