Metadata-Version: 2.1
Name: farbfeld
Version: 0.2.2
Summary: Library for reading/writing farbfeld images.
Home-page: https://github.com/jmp/farbfeld
Author: Jarkko Piiroinen
Author-email: jmp@python.mail.kapsi.fi
License: MIT
Description: # farbfeld.py
        
        [![Build Status](https://travis-ci.org/jmp/farbfeld.svg?branch=master)](https://travis-ci.org/jmp/farbfeld)
        [![codecov](https://codecov.io/gh/jmp/farbfeld/branch/master/graph/badge.svg)](https://codecov.io/gh/jmp/farbfeld)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/jmp/farbfeld.svg)](https://lgtm.com/projects/g/jmp/farbfeld/context:python)
        [![PyPI version](https://badge.fury.io/py/farbfeld.svg)](https://badge.fury.io/py/farbfeld)
        
        This is a small Python module for reading and writing pixel data
        from farbfeld images (https://tools.suckless.org/farbfeld/).
        
        ## Installation
        
        The module is available on PyPI: https://pypi.org/project/farbfeld/
        
        You can install it with `pip`:
        
            pip install farbfeld
        
        ## Usage
        
        To read an image, open the desired file and read the pixels
        from it using `farbfeld.read`:
        
        ```python
        import farbfeld
        
        with open('image.ff', 'rb') as f:
            data = farbfeld.read(f)
        ```
        
        Note that since farbfeld stores pixel components as 16-bit
        unsigned integers, you may have to normalize them or scale
        them to a different range (e.g. 8-bit). For example, using
        NumPy and Matplotlib:
        
        ```python
        import farbfeld
        import numpy as np
        import matplotlib.pyplot as plt
        
        with open('image.ff', 'rb') as f:
            data = farbfeld.read(f)
            data_8bit = np.array(data).astype(np.uint8)
            plt.imshow(data_8bit, interpolation='nearest')
            plt.show()
        ```
        
        To write a farbfeld image, open the desired file and write the pixels
        into it using `farbfeld.write`:
        
        ```python
        import farbfeld
        
        # An example 2x2 image
        data = [
            [[1, 2, 3, 4], [5, 6, 7, 8]],
            [[9, 10, 11, 12], [13, 14, 15, 16]],
        ]
        
        with open('image.ff', 'wb') as f:
            farbfeld.write(f, data)
        ```
        
        ## Source code
        
        The source code is available on GitHub:
        https://github.com/jmp/farbfeld
        
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Graphics
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
