image-transformer 0.4.0

A Python project for enhancing images using various processing techniques.

---

Image Transformer

This Python application reads a .png image and generates a scalable .svg version. The .svg file can be used as a high-resolution wallpaper. The application samples the colors of each grid element (hexagon, square, etc) to reproduce the same picture.

Install

pip install image-transformer

How to use as a CLI tool ?

Example usage:

image-transformer [--help] [-g {hexagonal,square}] [-p {random,average,frequent}] [-s SIZE] image_path

Note: for more details about all the available params use the following command: image-transformer --help.

How to use in a program ?

Example usage:

from PIL import Image

from image_transformer import ImageTransformer
from image_transformer.output_builders.cairo_svg_output_builder import CairoSvgOutputBuilder
from image_transformer.image_processors.hexagonal_grid_image_processor import HexagonalGridImageProcessor
from image_transformer.pixels_processors.most_frequent_pixels_processor import MostFrequentPixelsProcessor

def main():
    hexagon_size = 13
    output_image_path = "result.svg"
    # NOTE: assuming the image exists
    my_image_path = "./testing-image.jpg"

    image = Image.open(my_image_path)

    transformer = ImageTransformer.from_pil_image(image)

    output_builder = CairoSvgOutputBuilder(image.width, image.height, output_image_path)
    image_processor = HexagonalGridImageProcessor(hexagon_size)
    pixels_processor = MostFrequentPixelsProcessor()

    # NOTE: ignore
    callback = lambda step, value: ""

    transformer.transform_and_save(
        image_processor=image_processor,
        pixels_processor=pixels_processor,
        output_builder=output_builder,
        callback=callback
    )

if __name__ == "__main__":
    main()

Examples

Original Image	Generated SVG

Development

Below are notes for development only. You don't need to give it a look unless you want to contribute or build your own library.

Materials & Notes:

This are for people who want to dig in hexagonal grids & know how to deal with it. Ignore if you only want to use the tool.

• https://www.redblobgames.com/
• https://www.geeksforgeeks.org/creating-svg-image-using-pycairo/
• https://gamedev.stackexchange.com/a/61101

Docs Building Notes

• poetry add sphinx --dev: to install sphinx.
• poetry run sphinx-apidoc -o docs/ src/: to generate the .rst files for each module. This command should be run each time you have a new module or there is some changes in one of your modules.
• poetry run sphinx-build -b html docs docs/_build: to build the documentation. Each time there is a change.

Upload to Pypi

• poetry config http-basic.pypi __token__ <api-toke>: to specify your pipy credentials.
• poetry build: build the project.
• poetry publish: to publish the builded project into pypi.