Metadata-Version: 2.1
Name: py-epc-qr
Version: 0.1.2
Summary: Generate EPC-compatible QR codes for wire transfers
Home-page: https://github.com/timueh/py-epc-qr
License: MIT
Author: timueh
Author-email: t.muehlpfordt@mailbox.org
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Pillow (>=9.1.0,<10.0.0)
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: qrcode (>=7.3.1,<8.0.0)
Requires-Dist: typer (>=0.4.1,<0.5.0)
Project-URL: Documentation, https://github.com/timueh/py-epc-qr
Project-URL: Repository, https://github.com/timueh/py-epc-qr
Description-Content-Type: text/markdown

# Create QR codes for wire transfers

Sick of copy-and-pasting IBANs to forms?
Why not just scan a QR code and have your favorite banking app take care of the rest?

Why not be generous and support wikipedia with 123,45€?
Grab your phone and scan the image.

![Support Wikipedia with 123,45 €](tests/data/qr_version_002.png "Support Wikipedia with 123,45 €")

[The create QR code complies with the European Payments Council (EPC) Quick Response (QR) code guidelines.](https://en.wikipedia.org/wiki/EPC_QR_code)

Disclaimer: The author of this code has no affiliation with the EPC whatsoever.
Henceforth, you are welcome to use the code at your own dispense, but any use is at your own (commercial) risk.

## Installation

You can easily install the Python package via pip.

```python
pip install py-epc-qr
```

## Usage

You can use the package as part of your own code or as a standalone command line interface (CLI).

### Code

```python
from py_epc_qr.transaction import consumer_epc_qr
epc_qr = consumer_epc_qr(
    beneficiary= "Wikimedia Foerdergesellschaft",
    iban= "DE33100205000001194700",
    amount= 123.45,
    remittance= "Spende fuer Wikipedia"
    )
epc_qr.to_qr()
```

### CLI

<todo>

### From interaction

<todo>

#### From template

<todo>

## Limitations

Currently, the EPC specifications are implemented only to work with IBAN-based consumer wire transfers within the European Economic Area.
