Metadata-Version: 2.2
Name: img2num
Version: 0.0.0
Summary: A fast and accurate raster image to SVG conversion library
Author: Ryan Millard
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Scientific/Engineering :: Image Processing
Project-URL: Homepage, https://ryan-millard.github.io/Img2Num/info/docs/
Project-URL: Repository, https://github.com/Ryan-Millard/Img2Num
Project-URL: Documentation, https://ryan-millard.github.io/Img2Num/info/docs/
Project-URL: Changelog, https://github.com/Ryan-Millard/Img2Num/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/Ryan-Millard/Img2Num/issues
Requires-Python: >=3.10
Requires-Dist: numpy>=1.23.5
Provides-Extra: dev
Requires-Dist: ruff>=0.4.0; extra == "dev"
Description-Content-Type: text/markdown

<div align="center">

<img src="https://github.com/user-attachments/assets/d75b402e-03af-403f-8637-f9eb8a24c8c0" alt="Logo" height="100px" />

# Img2Num

[![Deploy to GitHub Pages](https://github.com/Ryan-Millard/Img2Num/actions/workflows/deploy.yml/badge.svg)](https://github.com/Ryan-Millard/Img2Num/actions/workflows/deploy.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Ryan-Millard/Img2Num/blob/main/LICENSE)
[![Docker Pulls](https://img.shields.io/docker/pulls/ryanmillard/img2num-dev)](https://hub.docker.com/repository/docker/ryanmillard/img2num-dev/general)
[![Open in Codespaces](https://img.shields.io/badge/-Open%20in%20Codespaces-black?logo=github)](https://codespaces.new/Ryan-Millard/Img2Num)

<a href="https://skillicons.dev">
  <img height="25px" src="https://skillicons.dev/icons?i=cpp,c,js,py" alt="C++, C, JavaScript, Python" />
</a>
 
_Img2Num_ converts raster images into clean SVGs with _high accuracy and performance_.

### Before vs After

| Original | Vectorized (SVG) |
|----------|------------------|
| <img src="docs/static/img/readme-demo/aerial-view-mountains_pexels-pixabay-51373.jpg" width="300" alt="Original input raster image (Aerial view of mountains)"> | <img src="docs/static/img/readme-demo/output-aerial-view-mountains_pexels-pixabay-51373.svg" width="300" alt="Final output SVG image (Aerial view of mountains)"> |
| <img src="docs/static/img/readme-demo/margate-garden.jpg" width="300" alt="Original input raster image (A garden in Margate, South Africa)" /> | <img width="300" alt="Final output SVG image (A garden in Margate, South Africa)" src="docs/static/img/readme-demo/output-margate-garden.svg" /> |
| <img src="docs/static/img/readme-demo/ring-on-hand.jpg" width="300" alt="Original input raster image (A ring on a woman's hand)" /> | <img width="300" alt="Final output SVG image  (A ring on a woman's hand)" src="docs/static/img/readme-demo/output-ring-on-hand.svg" /> |

### What are you waiting for?

Try the [live demo](https://ryan-millard.github.io/Img2Num/)!

</div>

<br />
<br />
<br />

## Essential links

### Docs
- [Full documentation](https://ryan-millard.github.io/Img2Num/info/docs/next/)
- [C++](https://ryan-millard.github.io/Img2Num/info/docs/next/cpp/)
- [C](https://ryan-millard.github.io/Img2Num/info/docs/next/c/)
- [JavaScript](https://ryan-millard.github.io/Img2Num/info/docs/next/js/)
- [Internal docs](https://ryan-millard.github.io/Img2Num/info/docs/next/internal/) (for contributors)

### Community
- [Changelog](https://ryan-millard.github.io/Img2Num/info/changelog)
- [Contributing guide](https://github.com/Ryan-Millard/Img2Num/blob/main/CONTRIBUTING.md)
- [Issues](https://github.com/Ryan-Millard/Img2Num/issues)

### Deployments
- [Demo app (React)](https://ryan-millard.github.io/Img2Num/)
- [Docker Hub](https://hub.docker.com/repository/docker/ryanmillard/img2num-dev/general)

## Contributing

We'd love some help! Check out our [CONTRIBUTING.md](https://github.com/Ryan-Millard/Img2Num/blob/main/CONTRIBUTING.md).

## License

The library is licensed under the [MIT License](LICENSE).

Certain subdirectories retain their own licenses:

| Subdirectory | License |
| ------------: | ------- |
| [`docs`](docs/) | GNU AGPLv3 (see [`docs/LICENSE`](docs/LICENSE)) |
| [`example-apps/react-js/`](example-apps/react-js/) | GNU AGPLv3 (see [`example-apps/react-js/LICENSE`](example-apps/react-js/LICENSE)) |
| [`.github/`](.github/) | GNU AGPLv3 (see [`.github/LICENSE`](.github/LICENSE)) |

## Can't find something?

If you need something, you should be able to find it on the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/).
If it isn't there, feel free to open a ["New Feature" issue](https://github.com/Ryan-Millard/Img2Num/issues/new?template=feature_request.yml) 
to request its addition to the docs and someone will assist you with finding or creating what you need.

## Maintainers

| GitHub | Role |
|--------|------|
| [<img src="https://github.com/Ryan-Millard.png" width="20" height="20" valign="middle" alt="Ryan-Millard avatar"> `@Ryan-Millard`](https://github.com/Ryan-Millard) | Lead Maintainer |
| [<img src="https://github.com/krasner.png" width="20" height="20" valign="middle" alt="krasner avatar"> `@krasner`](https://github.com/krasner) | Core Maintainer |


## Contributors & Credits

Thanks to all of our contributors - your impact on this project has been greatly appreciated!

[![GitHub Contributors Image](https://contrib.rocks/image?repo=Ryan-Millard/Img2Num)](https://github.com/Ryan-Millard/Img2Num/graphs/contributors)
