pyautotrace 0.0.5

Python bindings for AutoTrace.

PyAutoTrace

Python bindings for AutoTrace.

Requirements

• Python 3.10 or higher

Installation

Install PyAutoTrace using your package manager of choice.

python -m pip install pyautotrace

uv add pyautotrace

Usage

import numpy as np
from autotrace import Bitmap, VectorFormat
from PIL import Image

# Load an image.
image = np.asarray(Image.open("image.jpeg").convert("RGB"))

# Create a bitmap.
bitmap = Bitmap(image)

# Trace the bitmap.
vector = bitmap.trace()

# Save the vector as an SVG.
vector.save("image.svg")

# Get an SVG as a byte string.
svg = vector.encode(VectorFormat.SVG)

Building

If you wish to build the package from source, the easiest way to do so is with uv. Clone the repository and run the following commands inside the project directory.

# Clone the AutoTrace submodule.
git submodule update --init

# If you're on Windows, extract the GLib headers archive.
Expand-Archive "third-party\autotrace\distribute\win\3rdparty\glib-dev_2.34.3-1_win64.zip" -DestinationPath "third-party\glib"

# If you're on macOS, install GLib with Homebrew.
brew install glib

# Build the package with uv.
uv build

On Linux and macOS compilation requires GLib, pkg-config, and unzip to be installed on your system, which most Linux distributions include by default. You can install GLib on macOS with brew install glib.

On Windows, in order to compile the generated C code, you will need to have Visual C++ Build Tools or another C/C++ compiler installed.

TODO

• Tests
• Documentation

License

This project is licensed under the LGPLv2.1 license.

This project depends on the AutoTrace project, which is licensed under the LGPLv2.1 license. AutoTrace, and by extension this project, requires the presence of GLib to compile, which is licensed under the LGPLv2.1 license, but this project does not depend on GLib to run.

This project contains code that replaces portions of AutoTrace and GLib, defined in overrides.cpp. Some of the implementations were taken directly from, or are based on, the source code of their respective libraries.