properties_image
Project description
Why
properties
gives structure (and documentation!) to the properties you use in your
classes. properties-image
extends this to include image files.
Scope
The properties
package allows you to create strongly typed objects in a
consistent way. This allows you to hook into notifications and other libraries.
The properties-image
package contains additional image file properties with
external dependencies not included in properties
.
Goals
- Provide supplementary Property classes to the
properties
module - Allow dependency-heavy classes to be installed separately
Alternatives
Alternatives to properties
:
- traits is used by Enthought
- traitlets is used in the Jupyter project
- mypy and PEP0484 which document typing but do not include coercion or notifications
Other image libraries:
- pypng for PNG encoding/decoding
- Pillow a fork of PIL
- scikit-image for image processing
Connections
- properties
- steno3d for the client API
Installation
To install the repository, ensure that you have pip installed and run:
pip install properties_image
For the development version:
git clone https://github.com/3ptscience/properties-image.git cd properties-image pip install -e .
Examples
To include an image property, import properties
and properties_image
.
Then the image property classes will be in the ext
module. For additional examples,
see properties.
import properties import properties_image class NamedImage(properties.HasProperties): name = properties.String('Name of the image') image = properties.ext.ImagePNG('The image')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.