Skip to content

Commit 68455e3

Browse files
authored
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
1 parent a539187 commit 68455e3

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ A Python 3.6+ framework for decoding JPEG images and decoding/encoding RLE datas
1515
pip install pylibjpeg
1616
```
1717

18+
##### Installing extra requirements
19+
20+
The package can be installed with extra requirements `openjpeg` or `rle` to enable support for JPEG-2000 and Run-Length Encoding (RLE), respectively:
21+
22+
```
23+
pip install pylibjpeg[openjpeg,rle]
24+
```
25+
1826
#### Installing the development version
1927

2028
Make sure [Git](https://git-scm.com/) is installed, then

docs/release_notes/v1.4.0.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _v1.4.0:
2+
3+
1.4.0
4+
=====
5+
6+
* Made pylibjpeg-openjpeg and pylibjpeg-rle dependencies optional (using `extras_require`)

pylibjpeg/_version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
"""Version information for pynetdicom based on PEP396 and 440."""
1+
"""Version information for pylibjpeg based on PEP396 and 440."""
22

33
import re
44

55

6-
__version__ = '1.3.0'
6+
__version__ = '1.4.0'
77

88

99
VERSION_PATTERN = r"""

setup.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,11 @@
4848
"Topic :: Software Development :: Libraries",
4949
],
5050
packages = find_packages(),
51-
install_requires = ['numpy', 'pylibjpeg-openjpeg', 'pylibjpeg-rle'],
51+
extras_require = {
52+
'rle': ['pylibjpeg-rle'],
53+
'openjpeg': ['pylibjpeg-openjpeg']
54+
},
55+
install_requires = ['numpy'],
5256
include_package_data = True,
5357
zip_safe = False,
5458
python_requires = ">=3.6",

0 commit comments

Comments
 (0)