Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fhpythonutils/svgtrace

Leverage pyppeteer and the imagetrace.js library to trace a bitmap to SVG in python
https://github.com/fhpythonutils/svgtrace

jpg-to-svg png-to-svg python python3 svg trace trace-svg

Last synced: about 2 months ago
JSON representation

Leverage pyppeteer and the imagetrace.js library to trace a bitmap to SVG in python

Host: GitHub
URL: https://github.com/fhpythonutils/svgtrace
Owner: FHPythonUtils
License: mit
Created: 2020-04-24T18:52:35.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-30T15:23:36.000Z (9 months ago)
Last Synced: 2024-11-05T00:06:42.793Z (about 2 months ago)
Topics: jpg-to-svg, png-to-svg, python, python3, svg, trace, trace-svg
Language: Python
Homepage:
Size: 197 KB
Stars: 38
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        [![GitHub top language](https://img.shields.io/github/languages/top/FHPythonUtils/SvgTrace.svg?style=for-the-badge&cacheSeconds=28800)](../../)

[![Issues](https://img.shields.io/github/issues/FHPythonUtils/SvgTrace.svg?style=for-the-badge&cacheSeconds=28800)](../../issues)

[![License](https://img.shields.io/github/license/FHPythonUtils/SvgTrace.svg?style=for-the-badge&cacheSeconds=28800)](/LICENSE.md)

[![Commit activity](https://img.shields.io/github/commit-activity/m/FHPythonUtils/SvgTrace.svg?style=for-the-badge&cacheSeconds=28800)](../../commits/master)

[![Last commit](https://img.shields.io/github/last-commit/FHPythonUtils/SvgTrace.svg?style=for-the-badge&cacheSeconds=28800)](../../commits/master)

[![PyPI Downloads](https://img.shields.io/pypi/dm/svgtrace.svg?style=for-the-badge&cacheSeconds=28800)](https://pypistats.org/packages/svgtrace)

[![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%2Epepy%2Etech%2Fapi%2Fv2%2Fprojects%2Fsvgtrace)](https://pepy.tech/project/svgtrace)

[![PyPI Version](https://img.shields.io/pypi/v/svgtrace.svg?style=for-the-badge&cacheSeconds=28800)](https://pypi.org/project/svgtrace)

# SvgTrace



Leverage playwright and the imagetrace.js library to trace a bitmap to SVG in

python

- [Documentation](#documentation)

- [Install With PIP](#install-with-pip)

- [Language information](#language-information)

	- [Built for](#built-for)

- [Install Python on Windows](#install-python-on-windows)

	- [Chocolatey](#chocolatey)

	- [Windows - Python.org](#windows---pythonorg)

- [Install Python on Linux](#install-python-on-linux)

	- [Apt](#apt)

	- [Dnf](#dnf)

- [Install Python on MacOS](#install-python-on-macos)

	- [Homebrew](#homebrew)

	- [MacOS - Python.org](#macos---pythonorg)

- [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)

		- [Using GitHub Desktop](#using-github-desktop)

	- [Download Zip File](#download-zip-file)

- [Community Files](#community-files)

	- [Licence](#licence)

	- [Changelog](#changelog)

	- [Code of Conduct](#code-of-conduct)

	- [Contributing](#contributing)

	- [Security](#security)

	- [Support](#support)

	- [Rationale](#rationale)

## 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.

## Install With PIP

```python

pip install svgtrace

```

Head to https://pypi.org/project/svgtrace/ for more info

## Language information

### Built for

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

### Chocolatey

```powershell

choco install python

```

### Windows - Python.org

To install Python, go to https://www.python.org/downloads/windows/ and download the latest

version.

## Install Python on Linux

### Apt

```bash

sudo apt install python3.x

```

### Dnf

```bash

sudo dnf install python3.x

```

## Install Python on MacOS

### Homebrew

```bash

brew install [email protected]

```

### MacOS - Python.org

To install Python, go to https://www.python.org/downloads/macos/ and download the latest

version.

## How to run

### Windows

- Module

	`py -3.x -m [module]` or `[module]` (if module installs a script)

- File

	`py -3.x [file]` or `./[file]`

### Linux/ MacOS

- Module

	`python3.x -m [module]` or `[module]` (if module installs a script)

- 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

#### Using The Command Line

1. Press the Clone or download button in the top right

2. Copy the URL (link)

3. Open the command line and change directory to where you wish to

clone to

4. Type 'git clone' followed by URL in step 2

	```bash

	git clone https://github.com/FHPythonUtils/SvgTrace

	```

More information can be found at

https://help.github.com/en/articles/cloning-a-repository

#### Using GitHub Desktop

1. Press the Clone or download button in the top right

2. Click open in desktop

3. Choose the path for where you want and click Clone

More information can be found at

https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

### Download Zip File

1. Download this GitHub repository

2. Extract the zip archive

3. Copy/ move to the desired location

## Community Files

### Licence

MIT License

Copyright (c) FredHappyface

(See the [LICENSE](/LICENSE.md) for more information.)

### Changelog

See the [Changelog](/CHANGELOG.md) for more information.

### Code of Conduct

Online communities include people from many backgrounds. The *Project*

contributors are committed to providing a friendly, safe and welcoming

environment for all. Please see the

[Code of Conduct](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md)

 for more information.

### Contributing

Contributions are welcome, please see the

[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md)

for more information.

### Security

Thank you for improving the security of the project, please see the

[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md)

for more information.

### Support

Thank you for using this project, I hope it is of use to you. Please be aware that

those involved with the project often do so for fun along with other commitments

(such as work, family, etc). Please see the

[Support Policy](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md)

for more information.

### Rationale

The rationale acts as a guide to various processes regarding projects such as

the versioning scheme and the programming styles used. Please see the

[Rationale](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md)

for more information.