rel 2023.1

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,12 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2023.1 - 2023/06/25
+
+- Add `asyncTrace` and `skimageTrace`
+- Raise OSError "svgtrace.trace/ asyncTrace is not supported in Windows Jupyter Notebooks"
+- Documentation: Add Tutorials
+
 ## 2023.0.1 - 2023/03/12
 
 - Raise `FileNotFoundError` when input does not exist

README.md

@@ -16,7 +16,6 @@
 Leverage playwright and the imagetrace.js library to trace a bitmap to SVG in
 python
 
-- [Example](#example)
 - [Documentation](#documentation)
 - [Install With PIP](#install-with-pip)
 - [Language information](#language-information)
@@ -49,45 +48,13 @@ python
 	- [Support](#support)
 	- [Rationale](#rationale)
 
-## Example
-
-Convert the following files:
-<div>
-<img src="tests/data/logo-bw.png" alt="Screenshot 1" width="300">
-<img src="tests/data/logo.png" alt="Screenshot 2" width="300">
-</div>
-
-```python
-"""Test the image tracer."""
-from pathlib import Path
-
-from svgtrace import trace
-
-THISDIR = str(Path(__file__).resolve().parent)
-logoFile = f"{THISDIR}/data/logo"
-
-Path(f"{logoFile}-bw.svg").write_text(trace(f"{logoFile}-bw.png", True), encoding="utf-8")
-
-Path(f"{logoFile}.svg").write_text(trace(f"{logoFile}.png"), encoding="utf-8")
-
-```
-
-Output
-
-<div>
-<img src="tests/data/logo-bw.svg" alt="Screenshot 1" width="300">
-<img src="tests/data/logo.svg" alt="Screenshot 2" width="300">
-</div>
-
 ## Documentation
 
 A high-level overview of how the documentation is organized organized will help you know
 where to look for certain things:
 
-<!--
 - [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get
   started using the software. Start here if you’re new.
--->
 - The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
   machinery. This documentation describes how to use the classes and functions at a lower level
   and assume that you have a good high-level understanding of the software.

documentation/reference/svgtrace/index.md

@@ -6,11 +6,70 @@ Svgtrace
 > Auto-generated documentation for [svgtrace](../../../svgtrace/__init__.py) module.
 
 - [Svgtrace](#svgtrace)
+  - [asyncTrace](#asynctrace)
+  - [skimageTrace](#skimagetrace)
   - [trace](#trace)
 
+## asyncTrace
+
+[Show source in __init__.py:41](../../../svgtrace/__init__.py#L41)
+
+Do a trace of an image on the filesystem using the playwright library.
+
+#### Arguments
+
+- `filename` *str* - The location of the file on the filesystem, use an
+absolute filepath for this
+- `blackAndWhite` *bool, optional* - Trace a black and white SVG. Defaults to False.
+- `mode` *str, optional* - Set the mode. See https://github.com/jankovicsandras/imagetracerjs
+for more information. Defaults to "default".
+
+#### Returns
+
+- `str` - SVG string
+
+#### Raises
+
+FileNotFoundError f"{filename} does not exist!"
+OSError "svgtrace.trace/ asyncTrace is not supported in Windows Jupyter Notebooks"
+
+#### Signature
+
+```python
+async def asyncTrace(
+    filename: str, blackAndWhite: bool = False, mode: str = "default"
+) -> str:
+    ...
+```
+
+
+
+## skimageTrace
+
+[Show source in __init__.py:98](../../../svgtrace/__init__.py#L98)
+
+Do a trace of an pillow image using the skimage library.
+
+#### Arguments
+
+- `image` *Image.Image* - pillow image to trace
+
+#### Returns
+
+- `str` - SVG string
+
+#### Signature
+
+```python
+def skimageTrace(image: Image.Image) -> str:
+    ...
+```
+
+
+
 ## trace
 
-[Show source in __init__.py:17](../../../svgtrace/__init__.py#L17)
+[Show source in __init__.py:22](../../../svgtrace/__init__.py#L22)
 
 Do a trace of an image on the filesystem using the playwright library.
 

documentation/tutorials/README.md

@@ -0,0 +1,65 @@
+<!-- omit in toc -->
+# Tutorial
+
+See below for a step-by-step tutorial on how to use svgtrace
+
+- [Using the `trace` function](#using-the-trace-function)
+- [Using the `asyncTrace` function](#using-the-asynctrace-function)
+- [Using the `skimageTrace` function](#using-the-skimagetrace-function)
+
+## Using the `trace` function
+
+1. Create the following files (`logo-bw.png` and `logo.png`)
+	<div>
+	<img src="../../tests/data/logo-bw.png" alt="Screenshot 1" width="300">
+	<img src="../../tests/data/logo.png" alt="Screenshot 2" width="300">
+	</div>
+
+2. Import `svgtrace` and convert a file on disk (with `trace`) to an svg, andsave this back to disk
+   (with `Path().write_text`)
+	```python
+	from pathlib import Path
+	from svgtrace import trace
+
+	Path("logo-bw.svg").write_text(trace("logo-bw.png", True), encoding="utf-8")
+	Path("logo.svg").write_text(trace("logo.png"), encoding="utf-8")
+	```
+
+3. Output
+	<div>
+	<img src="../../tests/data/logo-bw.svg" alt="logo-wb.svg" width="300">
+	<img src="../../tests/data/logo.svg" alt="logo.svg" width="300">
+	</div>
+
+## Using the `asyncTrace` function
+
+1. Import `svgtrace` and convert a file on disk (with `asyncTrace`) to an svg, andsave this back to disk
+   (with `Path().write_text`)
+	```python
+	from pathlib import Path
+	from svgtrace import trace
+
+	Path("logo-asyncBw.svg").write_text(asyncio.run(asyncTrace("logo-bw.png", True)), encoding="utf-8")
+	Path("logo-async.svg").write_text(asyncio.run(asyncTrace("logo.png")), encoding="utf-8")
+	```
+
+2. Output is identical to above
+
+## Using the `skimageTrace` function
+
+1. Import `svgtrace` and convert a pillow image (with `skimageTrace`) to an svg, andsave this back to disk
+   (with `Path().write_text`)
+	```python
+	from pathlib import Path
+	from PIL import Image
+	from svgtrace import trace
+
+	Path("logo-skimageBw.svg").write_text(skimageTrace(Image.open("logo-bw.png")), encoding="utf-8")
+	Path("logo-skimage.svg").write_text(skimageTrace(Image.open("logo.png")), encoding="utf-8")
+	```
+
+2. Output
+	<div>
+	<img src="../../tests/data/logo-skimageBw.svg" alt="logo-skimageBw.svg" width="300">
+	<img src="../../tests/data/logo-skimage.svg" alt="logo-skimage.svg" width="300">
+	</div>

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "svgtrace"
-version = "2023.0.1"
+version = "2023.1"
 license = "mit"
 description = "Leverage playwright and the imagetrace.js library to trace a bitmap to svg in python"
 authors = ["FredHappyface"]
@@ -21,9 +21,12 @@ documentation = "https://github.com/FHPythonUtils/SvgTrace/blob/master/README.md
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.8"
-playwright = "<2,>=1.29.1"
+python = "^3.9"
+playwright = "<2,>=1.35.0"
 install-playwright = "<2,>=0.0.0"
+scikit-image = "<2,>=0.21.0"
+pillow = "<10,>=9.5.0"
+numpy = "<2,>=1.25.0"
 
 [tool.poetry.group.dev.dependencies]
 nocairosvg = "^2023"
@@ -73,7 +76,6 @@ env_list =
 	py311
 	py310
 	py39
-	py38
 
 [testenv]
 deps =

requirements.txt

@@ -1,2 +1,5 @@
 install-playwright<2,>=0.0.0
-playwright<2,>=1.29.1
+numpy<2,>=1.25.0
+pillow<10,>=9.5.0
+playwright<2,>=1.35.0
+scikit-image<2,>=0.21.0

svgtrace/__init__.py

@@ -6,10 +6,15 @@
 from __future__ import annotations
 
 import asyncio
+import sys
+import warnings
 from pathlib import Path
 
+import numpy as np
 from install_playwright import install
-from playwright.sync_api import sync_playwright
+from PIL import Image
+from playwright.async_api import async_playwright
+from skimage import feature, measure
 
 THISDIR = str(Path(__file__).resolve().parent)
 
@@ -30,6 +35,40 @@ def trace(filename: str, blackAndWhite: bool = False, mode: str = "default") ->
 	Raises:
 		FileNotFoundError f"{filename} does not exist!"
 	"""
+	return asyncio.run(asyncTrace(filename, blackAndWhite, mode))
+
+
+async def asyncTrace(filename: str, blackAndWhite: bool = False, mode: str = "default") -> str:
+	"""Do a trace of an image on the filesystem using the playwright library.
+
+	Args:
+		filename (str): The location of the file on the filesystem, use an
+		absolute filepath for this
+		blackAndWhite (bool, optional): Trace a black and white SVG. Defaults to False.
+		mode (str, optional): Set the mode. See https://github.com/jankovicsandras/imagetracerjs
+		for more information. Defaults to "default".
+
+	Returns:
+		str: SVG string
+
+	Raises:
+		FileNotFoundError f"{filename} does not exist!"
+		OSError "svgtrace.trace/ asyncTrace is not supported in Windows Jupyter Notebooks"
+	"""
+	# Detecting Default event loop in Notebook 6.1.6 on Windows is not ProactorEventLoop
+	# (https://github.com/jupyter/notebook/issues/5916)
+	if sys.platform.startswith("win") and sys.version_info >= (3, 8):
+		try:
+			from asyncio import WindowsSelectorEventLoopPolicy
+		except ImportError:
+			pass
+		else:
+			if isinstance(asyncio.get_event_loop_policy(), WindowsSelectorEventLoopPolicy):
+				raise OSError(
+					"svgtrace.trace/ asyncTrace is not supported in Windows Jupyter Notebooks"
+				)
+
+	#
 	if mode.find("black") >= 0 or blackAndWhite:
 		mode = "posterized1"
 
@@ -38,19 +77,46 @@ def trace(filename: str, blackAndWhite: bool = False, mode: str = "default") ->
 	if not Path(filename).exists():
 		raise FileNotFoundError(f"{filename} does not exist!")
 
-	with sync_playwright() as p:
+	async with async_playwright() as p:
 		install(p.chromium)
-		browser = p.chromium.launch(
+		browser = await p.chromium.launch(
 			args=["--no-sandbox", "--disable-web-security", "--allow-file-access-from-files"]
 		)
 
-		page = browser.new_page()
-		page.goto(f"file:///{THISDIR}/imagetracer.html")
-		page.evaluate(
+		page = await browser.new_page()
+		await page.goto(f"file:///{THISDIR}/imagetracer.html")
+		await page.evaluate(
 			f"ImageTracer.imageToSVG('file:///{filename}',function(svgstr){{ ImageTracer.appendSVGString( svgstr, 'svg-container' ); }},'{mode}');"
 		)
-		element = page.query_selector("div")
-		svg = page.evaluate("(element) => element.innerHTML", element)
+		element = await page.query_selector("div")
+		svg = await page.evaluate("(element) => element.innerHTML", element)
+
+		await browser.close()
+	return svg
+
+
+def skimageTrace(image: Image.Image) -> str:
+	"""Do a trace of an pillow image using the skimage library.
+
+	Args:
+		image (Image.Image): pillow image to trace
+
+	Returns:
+		str: SVG string
+	"""
+	with warnings.catch_warnings():
+		warnings.filterwarnings("ignore")
+		imageGreyscale = image.convert("L")
+	edges = feature.canny(np.array(imageGreyscale))
+	paths = []
+	contours = measure.find_contours(edges, 0.5)
+	for contour in contours:
+		pathData = " L ".join([f"{coord[1]},{coord[0]}" for coord in contour])
+		paths.append(f'<path d="M {pathData} Z" stroke="black" fill="none" />')
 
-		browser.close()
+	svg = (
+		f'<svg xmlns="http://www.w3.org/2000/svg" width="{image.width}" height="{image.height}">'
+		+ "".join(paths)
+		+ "</svg>"
+	)
 	return svg