Metadata-Version: 2.1
Name: bank-transfer-qrcode
Version: 0.1.0
Summary: QR codes for bank transfers with banking applications
Author-email: Karol Podgórski <karolsoon.dev@gmail.com>
Maintainer-email: Karol Podgórski <karolsoon.dev@gmail.com>
License: Copyright (c) 2024, Karol Podgórski
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/Karolsoon/Bank-Transfer-QR
Project-URL: Source, https://github.com/Karolsoon/Bank-Transfer-QR
Keywords: QR Code,qrcode,transfer,payment
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: segno>=1.6.1
Provides-Extra: build
Requires-Dist: build; extra == "build"
Requires-Dist: twine; extra == "build"
Provides-Extra: dev
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# Bank-Transfer-QRCode
> Generate QR codes for bank transfers.

[![PyPi version](https://img.shields.io/badge/pypi-0.1.0-green)](https://pypi.org/project/bank-transfer-qrcode/)
[![Supported Python versions](https://img.shields.io/badge/Python-3.11-blue)](https://pypi.org/project/bank-transfer-qrcode/)


This package generates QR codes to be used with banking application. 
Provide information about the receiver, generate a QR code and scan it with a 
banking application.

Implementation is based on [this recommendation](https://zbp.pl/getmedia/1d7fef90-d193-4a2d-a1c3-ffdf1b0e0649/2013-12-03_-_Rekomendacja_-_Standard_2D)
and may not follow strict laws or other binding regulations.

![QR Code Example](https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/examples/example_bank_transfer_qrcode.png?raw=true)

## Installation

OS X & Linux, Windows:

```sh
python -m pip install bank-transfer-qrcode
```

## Usage example

Import the QR module from the package
```py
from bank_transfer_qrcode import QR
```


Provide information about the recipient and create an instance of QR
```py
qr = QR(
    country_code='PL',
    iban='PL01234567890123456789012345',
    amount='000123',
    recipient_name='Bob Smith',
    transfer_title='Payment title'
)
```

Save the QR
```py
# Save as svg
qr.save('svg_filename', 'svg')
# Save as png
qr.save('png_filename', 'png')
```

...or get an io.BytesIO object and do something with it
```py
qr.get()
```

For mor information check the QR class or method docstrings or use
```py 
QR.info()
```

## Release History

* 0.1.0
    * The first release


## Meta

Karol Podgórski, karolsoon.dev@gmail.com

Distributed under the BSD license. See ``LICENSE`` for more information.

[https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/LICENSE](https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/LICENSE)
