diff --git a/README.rst b/README.rst index fbe5f4e..5c8c430 100644 --- a/README.rst +++ b/README.rst @@ -6,71 +6,87 @@ format as specified at http://netpbm.sourceforge.net/doc/. The following Netpbm and Portable FloatMap formats are supported: -* PBM (bi-level) -* PGM (grayscale) -* PPM (color) -* PAM (arbitrary) -* XV thumbnail (RGB332, read-only) -* Pf (float32 grayscale, read-only) -* PF (float32 RGB, read-only) -* PF4 (float32 RGBA, read-only) -* PGX (signed grayscale, read-only) +- PBM (bi-level) +- PGM (grayscale) +- PPM (color) +- PAM (arbitrary) +- XV thumbnail (RGB332, read-only) +- Pf (float32 grayscale, read-only) +- PF (float32 RGB, read-only) +- PF4 (float32 RGBA, read-only) +- PGX (signed grayscale, read-only) No gamma correction is performed. Only one image per file is supported. The PGX format is specified in ITU-T Rec. T.803. -:Author: - `Christoph Gohlke `_ - -:Organization: - Laboratory for Fluorescence Dynamics, University of California, Irvine - +:Author: `Christoph Gohlke `_ :License: BSD 3-Clause - -:Version: 2022.2.2 +:Version: 2022.9.1 Requirements ------------ + This release has been tested with the following requirements and dependencies (other versions may work): -* `CPython 3.8.10, 3.9.10, 3.10.2 64-bit `_ -* `Numpy 1.21.5 `_ -* `Matplotlib 3.4.3 `_ (optional) +- `CPython 3.8.10, 3.9.13, 3.10.6, 3.11.0rc1 `_ +- `NumPy 1.22.4 `_ +- `Matplotlib 3.5.3 `_ (optional) Revisions --------- + +2022.9.1 + +- Update metadata. + 2022.2.2 - Add type hints. - Support reading PF4 RGBA FloatMaps. - Drop support for Python 3.7 and numpy < 1.19 (NEP29). + +- Add type hints. +- Support reading PF4 RGBA FloatMaps. +- Drop support for Python 3.7 and numpy < 1.19 (NEP29). + 2021.6.6 - Fix unclosed file warnings. - Support reading PGX JPEG2000 reference images. + +- Fix unclosed file warnings. +- Support reading PGX JPEG2000 reference images. + 2020.10.18 - Disallow comments after last value in PNM headers. + +- Disallow comments after last value in PNM headers. + 2020.9.18 - Remove support for Python 3.6 (NEP 29). - Support os.PathLike file names. + +- Remove support for Python 3.6 (NEP 29). +- Support os.PathLike file names. + 2020.1.1 - Fix reading tightly packed P1 format and ASCII data with inline comments. - Remove support for Python 2.7 and 3.5. - Update copyright. + +- Fix reading tightly packed P1 format and ASCII data with inline comments. +- Remove support for Python 2.7 and 3.5. +- Update copyright. + 2018.10.18 - Move netpbmfile.py into netpbmfile package. + +- Move netpbmfile.py into netpbmfile package. + 2018.02.18 - Support reading Portable FloatMaps. - Style fixes. + +- Support reading Portable FloatMaps. +- Style fixes. + 2016.02.24 - Use 'fromdata' classmethod to initialize from data. - Support 'with' statement. - Scale RGB images to maxval for display. - Make keyword arguments explicit. - Support numpy 1.10. + +- Use fromdata classmethod to initialize from data. +- Support with statement. +- Scale RGB images to maxval for display. +- Make keyword arguments explicit. +- Support numpy 1.10. Examples -------- + Save a numpy array to a Netpbm file in grayscale format: >>> data = numpy.array([[0, 1], [65534, 65535]], dtype='uint16') @@ -96,5 +112,6 @@ dtype('>u2') 65535 b'P5' -To view the image stored in a Netpbm file from a command line, run -``python -m netpbmfile _tmp.pgm``. +View the image stored in a Netpbm file from a command line:: + + ``python -m netpbmfile _tmp.pgm``.