bank-transfer-qrcode


Namebank-transfer-qrcode JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryQR codes for bank transfers with banking applications
upload_time2024-05-06 00:05:53
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseCopyright (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.
keywords qr code qrcode transfer payment
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bank-transfer-qrcode",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Karol Podg\u00f3rski <karolsoon.dev@gmail.com>",
    "keywords": "QR Code, qrcode, transfer, payment",
    "author": null,
    "author_email": "Karol Podg\u00f3rski <karolsoon.dev@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ce/8a/67fd00f0ebca3a6fc397a387976448f6dbca5b7e26fdbddefff4e5c33197/bank_transfer_qrcode-0.1.0.tar.gz",
    "platform": null,
    "description": "# Bank-Transfer-QRCode\n> Generate QR codes for bank transfers.\n\n[![PyPi version](https://img.shields.io/badge/pypi-0.1.0-green)](https://pypi.org/project/bank-transfer-qrcode/)\n[![Supported Python versions](https://img.shields.io/badge/Python-3.11-blue)](https://pypi.org/project/bank-transfer-qrcode/)\n\n\nThis package generates QR codes to be used with banking application. \nProvide information about the receiver, generate a QR code and scan it with a \nbanking application.\n\nImplementation is based on [this recommendation](https://zbp.pl/getmedia/1d7fef90-d193-4a2d-a1c3-ffdf1b0e0649/2013-12-03_-_Rekomendacja_-_Standard_2D)\nand may not follow strict laws or other binding regulations.\n\n![QR Code Example](https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/examples/example_bank_transfer_qrcode.png?raw=true)\n\n## Installation\n\nOS X & Linux, Windows:\n\n```sh\npython -m pip install bank-transfer-qrcode\n```\n\n## Usage example\n\nImport the QR module from the package\n```py\nfrom bank_transfer_qrcode import QR\n```\n\n\nProvide information about the recipient and create an instance of QR\n```py\nqr = QR(\n    country_code='PL',\n    iban='PL01234567890123456789012345',\n    amount='000123',\n    recipient_name='Bob Smith',\n    transfer_title='Payment title'\n)\n```\n\nSave the QR\n```py\n# Save as svg\nqr.save('svg_filename', 'svg')\n# Save as png\nqr.save('png_filename', 'png')\n```\n\n...or get an io.BytesIO object and do something with it\n```py\nqr.get()\n```\n\nFor mor information check the QR class or method docstrings or use\n```py \nQR.info()\n```\n\n## Release History\n\n* 0.1.0\n    * The first release\n\n\n## Meta\n\nKarol Podg\u00f3rski, karolsoon.dev@gmail.com\n\nDistributed under the BSD license. See ``LICENSE`` for more information.\n\n[https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/LICENSE](https://github.com/Karolsoon/Bank-Transfer-QR/blob/main/LICENSE)\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2024, Karol Podg\u00f3rski 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. ",
    "summary": "QR codes for bank transfers with banking applications",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Karolsoon/Bank-Transfer-QR",
        "Source": "https://github.com/Karolsoon/Bank-Transfer-QR"
    },
    "split_keywords": [
        "qr code",
        " qrcode",
        " transfer",
        " payment"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "327e33de0f49eab77c7aaa01a38456962aef533e6f6b0e29944c90e06ae68a75",
                "md5": "614c870e5faa251fd6e2e6f5b0015808",
                "sha256": "3cff968e4a72238346dd5206e44680d8e38813caff1a56b69a136b4bd5c6c1bc"
            },
            "downloads": -1,
            "filename": "bank_transfer_qrcode-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "614c870e5faa251fd6e2e6f5b0015808",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 10037,
            "upload_time": "2024-05-06T00:05:51",
            "upload_time_iso_8601": "2024-05-06T00:05:51.171325Z",
            "url": "https://files.pythonhosted.org/packages/32/7e/33de0f49eab77c7aaa01a38456962aef533e6f6b0e29944c90e06ae68a75/bank_transfer_qrcode-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce8a67fd00f0ebca3a6fc397a387976448f6dbca5b7e26fdbddefff4e5c33197",
                "md5": "97b44f00febafd345863b37af4139174",
                "sha256": "0bd472587efc6f08ab3dec147648d2a4b0aedd07379e47eb1c6a129cd9ba1527"
            },
            "downloads": -1,
            "filename": "bank_transfer_qrcode-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "97b44f00febafd345863b37af4139174",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 11850,
            "upload_time": "2024-05-06T00:05:53",
            "upload_time_iso_8601": "2024-05-06T00:05:53.024602Z",
            "url": "https://files.pythonhosted.org/packages/ce/8a/67fd00f0ebca3a6fc397a387976448f6dbca5b7e26fdbddefff4e5c33197/bank_transfer_qrcode-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-06 00:05:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Karolsoon",
    "github_project": "Bank-Transfer-QR",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bank-transfer-qrcode"
}
        
Elapsed time: 0.23852s