release: 2023

Author: FredHappyface

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     rev: v3.3.1
     hooks:
       - id: pyupgrade
-        args: [--py37-plus]
+        args: [--py38-plus]
   - repo: https://github.com/boidolr/pre-commit-images
     rev: v1.1.0
     hooks:

CHANGELOG.md

@@ -3,6 +3,11 @@
 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 - 2023/01/08
+
+- Add tox config
+- Use playwright and install_playwright in-place of pyppeteer
+
 ## 2022 - 2022/01/06
 
 - update precommit

README.md

@@ -8,12 +8,12 @@
 [![PyPI Total Downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&label=total%20downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fsvgtrace)](https://pepy.tech/project/svgtrace)
 [![PyPI Version](https://img.shields.io/pypi/v/svgtrace.svg?style=for-the-badge)](https://pypi.org/project/svgtrace)
 
-<!-- omit in TOC -->
+<!-- omit in toc -->
 # SvgTrace
 
 <img src="readme-assets/icons/name.png" alt="Project Icon" width="750">
 
-Leverage pyppeteer and the imagetrace.js library to trace a bitmap to SVG in
+Leverage playwright and the imagetrace.js library to trace a bitmap to SVG in
 python
 
 - [Example](#example)
@@ -33,6 +33,8 @@ python
 - [How to run](#how-to-run)
 	- [Windows](#windows)
 	- [Linux/ MacOS](#linux-macos)
+- [Building](#building)
+- [Testing](#testing)
 - [Download Project](#download-project)
 	- [Clone](#clone)
 		- [Using The Command Line](#using-the-command-line)
@@ -106,8 +108,8 @@ Head to https://pypi.org/project/svgtrace/ for more info
 
 ### Built for
 
-This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and
-3.10
+This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
+3.11
 
 ## Install Python on Windows
 
@@ -167,6 +169,36 @@ version.
 - File
 	`python3.x [file]` or `./[file]`
 
+## Building
+
+This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
+command generates the documentation, updates the requirements.txt and builds the library artefacts
+
+Note the functionality provided by fhmake can be approximated by the following
+
+```sh
+handsdown  --cleanup -o documentation/reference
+poetry export -f requirements.txt --output requirements.txt
+poetry export -f requirements.txt --with dev --output requirements_optional.txt
+poetry build
+```
+
+`fhmake audit` can be run to perform additional checks
+
+## Testing
+
+For testing with the version of python used by poetry use
+
+```sh
+poetry run pytest
+```
+
+Alternatively use `tox` to run tests over python 3.8 - 3.11
+
+```sh
+tox
+```
+
 ## Download Project
 
 ### Clone

documentation/reference/MODULES.md

@@ -1,8 +1,7 @@
-# Svgtrace Modules
+# Svgtrace Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Svgtrace](README.md#svgtrace-index) project modules.
+A full list of `Svgtrace` project modules.
 
-- [Svgtrace Index](README.md#svgtrace-index)
 - [Svgtrace](svgtrace/index.md#svgtrace)

documentation/reference/README.md

@@ -1,39 +1,18 @@
 # Svgtrace
 
-> Auto-generated documentation for [svgtrace](../../../svgtrace/__init__.py) module.
-
-Author FredHappyface 2020.
-
-- [Svgtrace](../README.md#svgtrace-index) / [Modules](../MODULES.md#svgtrace-modules) / Svgtrace
-    - [doTrace](#dotrace)
-    - [trace](#trace)
-
-Uses pyppeteer to leverage a headless version of Chromium
-Requires imagetracer.html and imagetracer.js along with the modules below
-
-## doTrace
+[Svgtrace Index](../README.md#svgtrace-index) /
+Svgtrace
 
-[[find in source code]](../../../svgtrace/__init__.py#L16)
-
-```python
-async def doTrace(filename: str, mode: str = 'default'):
-```
+> Auto-generated documentation for [svgtrace](../../../svgtrace/__init__.py) module.
 
-Call web code.
+- [Svgtrace](#svgtrace)
+  - [trace](#trace)
 
 ## trace
 
-[[find in source code]](../../../svgtrace/__init__.py#L40)
+[Show source in __init__.py:20](../../../svgtrace/__init__.py#L20)
 
-```python
-def trace(
-    filename: str,
-    blackAndWhite: bool = False,
-    mode: str = 'default',
-) -> str:
-```
-
-Do a trace of an image on the filesystem using the pyppeteer library.
+Do a trace of an image on the filesystem using the playwright library.
 
 #### Arguments
 
@@ -46,3 +25,12 @@ for more information. Defaults to "default".
 #### Returns
 
 - `str` - SVG string
+
+#### Signature
+
+```python
+def trace(filename: str, blackAndWhite: bool = False, mode: str = "default") -> str:
+    ...
+```
+
+

documentation/reference/svgtrace/index.md

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "svgtrace"
-version = "2022"
+version = "2023"
 license = "mit"
-description = "Leverage pyppeteer and the imagetrace.js library to trace a bitmap to svg in python"
+description = "Leverage playwright and the imagetrace.js library to trace a bitmap to svg in python"
 authors = ["FredHappyface"]
 classifiers = [
 	"Development Status :: 5 - Production/Stable",
@@ -21,16 +21,33 @@ documentation = "https://github.com/FHPythonUtils/SvgTrace/blob/master/README.md
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.7"
-pyppeteer = "<2,>=1.0.2"
+python = "^3.8"
+playwright = "<2,>=1.29.1"
+install-playwright = "<2,>=0.0.0"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
+nocairosvg = "^2023"
 pytest = "^7.1.1"
 pylint = "^2.13.5"
 handsdown = "^1.1.0"
 coverage = "^6.3.2"
 imgcompare = "^2.0.1"
-nocairosvg = "^2022.0.1"
+
+[tool.black]
+line-length = 100
+target-version = ["py38"]
+
+[tool.isort]
+profile = "black"
+indent = "Tab"
+
+[tool.pydocstyle]
+convention = "google"
+ignore = "D205,D415"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
 
 [tool.pylint.basic]
 argument-naming-style = "camelCase"
@@ -43,28 +60,25 @@ variable-naming-style = "camelCase"
 indent-string = "\t"
 
 [tool.pylint.master]
-ignore-patterns = "test_.*?py"
+ignore-paths = ["tests"]
 
 [tool.pylint.messages_control]
 enable = ["F", "E", "W", "R", "C"]
-disable = [
-	"pointless-string-statement",
-	"superfluous-parens",
-	"bad-continuation"
-]
-
-[tool.black]
-line-length = 100
-target-version = ["py37"]
-
-[tool.isort]
-profile = "black"
-indent = "Tab"
+disable = ["pointless-string-statement", "superfluous-parens"]
 
-[tool.pydocstyle]
-convention = "google"
-ignore = "D205,D415"
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+env_list =
+	py311
+	py310
+	py39
+	py38
 
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+[testenv]
+deps =
+	nocairosvg
+	pytest
+	imgcompare
+commands = pytest tests
+"""

pyproject.toml

@@ -1 +1,2 @@
-pyppeteer<2,>=1.0.2
+install-playwright<2,>=0.0.0
+playwright<2,>=1.29.1

requirements.txt

@@ -1,44 +1,24 @@
 """Author FredHappyface 2020.
 
-Uses pyppeteer to leverage a headless version of Chromium
+Uses playwright to leverage a headless version of Chromium
 Requires imagetracer.html and imagetracer.js along with the modules below
 """
 from __future__ import annotations
 
 import asyncio
 from pathlib import Path
 
-from pyppeteer import launch
+from install_playwright import install
+from playwright.sync_api import sync_playwright
+
 
 THISDIR = str(Path(__file__).resolve().parent)
 
 
-async def doTrace(filename: str, mode: str = "default"):
-	"""Call web code."""
-	browser = await launch(
-		options={
-			"args": [
-				"--no-sandbox",
-				"--headless",
-				"--disable-web-security",
-				"--allow-file-access-from-files",
-			]
-		}
-	)
-	page = await browser.newPage()
-	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 = await page.querySelector("div")
-	svg = await page.evaluate("(element) => element.innerHTML", element)
-
-	await browser.close()
-	return svg
 
 
 def trace(filename: str, blackAndWhite: bool = False, mode: str = "default") -> str:
-	"""Do a trace of an image on the filesystem using the pyppeteer library.
+	"""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
@@ -52,12 +32,22 @@ def trace(filename: str, blackAndWhite: bool = False, mode: str = "default") ->
 	"""
 	if mode.find("black") >= 0 or blackAndWhite:
 		mode = "posterized1"
-	try:
-		return asyncio.get_event_loop().run_until_complete(
-			doTrace(filename.replace("\\", "/"), mode)
+
+	filename=filename.replace('\\', '/')
+
+	with sync_playwright() as p:
+		install(p.chromium)
+		browser = p.chromium.launch(
+			args=["--no-sandbox", "--disable-web-security", "--allow-file-access-from-files"]
 		)
-	except ConnectionResetError:
-		print("WARNING: ConnectionResetError - probably just a hiccup retrying")
-		return asyncio.get_event_loop().run_until_complete(
-			doTrace(filename.replace("\\", "/"), mode)
+
+		page = browser.new_page()
+		page.goto(f"file:///{THISDIR}/imagetracer.html")
+		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)
+
+		browser.close()
+	return svg