Metadata-Version: 2.1
Name: qrcode-styled
Version: 0.2.1
Summary: Python port for kozakdenys/qr-code-styling
Home-page: https://cifrazia.com
License: MIT
Keywords: cifrazia,library,utils,tools,qrcode
Author: Bogdan Parfenov
Author-email: adam.brian.bright@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: svg
Requires-Dist: Pillow (>=9.0.0,<10.0.0)
Requires-Dist: lxml (>=4.7.1,<5.0.0); extra == "svg"
Requires-Dist: qrcode (>=7.3.1,<8.0.0)
Project-URL: Bug Tracker, https://github.com/AdamBrianBright/qrcode_styled/issues
Project-URL: Contact Author, https://vk.com/adam_bright
Project-URL: Repository, https://github.com/AdamBrianBright/qrcode_styled.git
Description-Content-Type: text/markdown

# Welcome

[![PyPI version](https://badge.fury.io/py/qrcode-styled.svg)](https://badge.fury.io/py/qrcode-styled) [![codecov](https://codecov.io/gh/AdamBrianBright/qrcode_styled/branch/master/graph/badge.svg?token=MMDPS40REC)](https://codecov.io/gh/AdamBrianBright/qrcode_styled) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FAdamBrianBright%2Fqrcode_styled.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FAdamBrianBright%2Fqrcode_styled?ref=badge_shield)

## QRCode Styled [\[WIP\]](https://dictionary.cambridge.org/us/dictionary/english/wip?q=WIP)

<img src="./wiki/img/logo.png" alt="QRCode Styled" width="64" height="64" />

This is a python port for a [browser QRCode generator](https://github.com/kozakdenys/qr-code-styling)
by [Denys Kozak](https://github.com/kozakdenys)

This project was initially created for internal use in [cifrazia.com](https://cifrazia.com/).

We do not intend to maintain this project for wide usage, but feel free to use it, share, edit or submit pull requests.

## Features

+ Multiple formats:
   + [x] SVG using `xmls`
   + [x] PNG/WEBP, etc. using `Pillow`
+ Multiple styles:
   + [x] Extra rounded corners
   + [ ] Rounded corners
   + [ ] Straight
   + [ ] Dotted

Check out [our documentation](https://adambrianbright.github.io/qrcode_styled/get-started/).

## Installing

Using **Poetry**

```shell
poetry add qrcode-styled
```

Using **PIP**

```shell
pip install qrcode-styled
```

### Requirements

+ Python `>= 3.9`
+ Pillow `>= 8.2.0`
+ qrcode `>= 6.1`
+ lxml `>= 8.2.0` (optional, for SVG rendering)

### Extras

| Keyword | Description                | Packages        |
| ------- | -------------------------- | --------------- |
| `svg`   | Allows you to generate SVG | `lxml >= 4.6.3` |

| SVG                                | WEBp                                |
| ---------------------------------- | ----------------------------------- |
| ![Svg QRCode](./wiki/img/test.svg) | ![Svg QRCode](./wiki/img/test.webp) |

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FAdamBrianBright%2Fqrcode_styled.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FAdamBrianBright%2Fqrcode_styled?ref=badge_large)
