pycimg 2.0.8

Python extension for the CImg library.

README

pycimg is a python extension for the CImg library.

The package contains a single class CImg that provides access to the image processing methods of the CImg library.

Pixel data of CImg objects can be accessed as a numpy array.

Vice versa new CImg objects can be created from pixel data in a numpy array or an image file. Supported file formats are png, jpeg, tiff, bmp, and cimg.

from pycimg import CImg
import numpy as np

# Load image from file
img = CImg('test/test.png')
img.display()

# Access pixel data as numpy array
arr = img.asarray()
# Set pixels in upper left 100 x 100 px rectangle
arr[:,:,0:99,0:99] = 0
# Pixel data is shared with the image instance
img.display()

# Create image from numpy array
img = CImg(np.random.randn(100,100))

Features

• Access pixel data as a numpy array.

• Builtin support for reading/writing png, jpeg, and tiff image formats.

Installation

Install pycimg by running:

pip install pycimg

Local development

This project uses uv for dependency management. Install uv, then run:

uv sync --dev
conan profile detect --force
conan install . --build=missing
uv run pip install -e . -C "skbuild.cmake.args=-DCMAKE_TOOLCHAIN_FILE:FILEPATH=conan_toolchain.cmake"

Run tests with:

uv run pytest --cov=pycimg tests/

Release workflow

This project uses python-semantic-release to automatically bump the version based on commit messages when changes are merged to master:

• fix: ... commits increment the patch version (e.g. 2.0.2 → 2.0.3)

• feat: ... commits increment the minor version (e.g. 2.0.2 → 2.1.0)

• BREAKING CHANGE: ... commits increment the major version (e.g. 2.0.2 → 3.0.0)

Steps to publish a new release:

1. Merge the feature branch into master.

2. The CI semantic_release job bumps the version, commits, and pushes a new v* tag.

3. On GitHub, create a Release from the newly pushed tag.

4. The CI upload_pypi job publishes the built wheels and source distribution to PyPI.

Documentation

See readthedocs.

License

The project is licensed under the GPL3 license.