# PyQrbtf
pyqrbtf is a Python library for generating beautiful and customizable QR codes in SVG format. It is a Python port of the original [qrbtf JavaScript library](https://github.com/latentcat/qrbtf).
## Features
- Generate aesthetically pleasing QR codes
- Multiple style options for QR code rendering
- SVG output for high-quality, scalable QR codes
- Customizable colors, shapes, and patterns
- Easy-to-use Python API
## Installation
You can install pyqrbtf using pip:
```bash
pip install pyqrbtf
```
## Usage
Here's a quick example of how to use pyqrbtf:
```python
from qrcode import QRCode
from pyqrbtf import PositioningPointType, SP1Drawer
qr = QRCode(
version=1,
error_correction=1,
box_size=10,
border=0,
)
qr.add_data("test")
qr.make()
a = SP1Drawer(positioning_point_type=PositioningPointType.circle)
text = a.to_bytes(qr.get_matrix(), {})
with open("example.svg", "wb") as f:
f.write(text)
```
## Documentation
Will be created after 100 stars in this repo
## Examples
You can find example outputs in the `examples/` directory:
| circles_circle | circles_circle_rounded | sp1_rounded |
| --- | --- | --- |
|  |  |  |
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Original [qrbtf JavaScript library](https://github.com/latentcat/qrbtf) by latentcat
- [Python QR Code](https://github.com/lincolnloop/python-qrcode) library
## Contact
If you have any questions or feedback, please open an issue here.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/Myrik/pyqrbtf",
"name": "pyqrbtf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Yorsh Siarhei",
"author_email": "myrik260138@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/33/b6/1880fc7125c54e2df60247e59afe220cbcfb4fb8bfa41a9978b8fa4a2890/pyqrbtf-0.0.3.tar.gz",
"platform": null,
"description": "# PyQrbtf\n\npyqrbtf is a Python library for generating beautiful and customizable QR codes in SVG format. It is a Python port of the original [qrbtf JavaScript library](https://github.com/latentcat/qrbtf).\n\n## Features\n\n- Generate aesthetically pleasing QR codes\n- Multiple style options for QR code rendering\n- SVG output for high-quality, scalable QR codes\n- Customizable colors, shapes, and patterns\n- Easy-to-use Python API\n\n## Installation\n\nYou can install pyqrbtf using pip:\n\n```bash\npip install pyqrbtf\n```\n\n## Usage\n\nHere's a quick example of how to use pyqrbtf:\n\n```python\nfrom qrcode import QRCode\nfrom pyqrbtf import PositioningPointType, SP1Drawer\n\nqr = QRCode(\n version=1,\n error_correction=1,\n box_size=10,\n border=0,\n)\n\nqr.add_data(\"test\")\nqr.make()\n\na = SP1Drawer(positioning_point_type=PositioningPointType.circle)\ntext = a.to_bytes(qr.get_matrix(), {})\nwith open(\"example.svg\", \"wb\") as f:\n f.write(text)\n```\n\n## Documentation\n\nWill be created after 100 stars in this repo\n\n## Examples\n\nYou can find example outputs in the `examples/` directory:\n\n| circles_circle | circles_circle_rounded | sp1_rounded |\n| --- | --- | --- |\n|  |  |  |\n\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements\n\n- Original [qrbtf JavaScript library](https://github.com/latentcat/qrbtf) by latentcat\n- [Python QR Code](https://github.com/lincolnloop/python-qrcode) library\n\n## Contact\n\nIf you have any questions or feedback, please open an issue here.\n",
"bugtrack_url": null,
"license": null,
"summary": "A project for generating a QR codes in SVG format",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://gitlab.com/Myrik/pyqrbtf"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88febef512b82162fe7ff3d792d702d6eda16cbf55b05f0e7074d0c3943c8a94",
"md5": "74ebb2f853c9166fb894bd45e9ef1206",
"sha256": "4f878805e632c3cb3240636c0f2362499901ad2c6353b9dd35bd7b282083e4c4"
},
"downloads": -1,
"filename": "pyqrbtf-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74ebb2f853c9166fb894bd45e9ef1206",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12062,
"upload_time": "2024-09-17T16:57:56",
"upload_time_iso_8601": "2024-09-17T16:57:56.245541Z",
"url": "https://files.pythonhosted.org/packages/88/fe/bef512b82162fe7ff3d792d702d6eda16cbf55b05f0e7074d0c3943c8a94/pyqrbtf-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33b61880fc7125c54e2df60247e59afe220cbcfb4fb8bfa41a9978b8fa4a2890",
"md5": "e7b35decc5a3efdbd0412b0a68c2cf56",
"sha256": "c7ca770c817b68ba97685c79f4ef618d33aab0a102e44a6fce69905c55dfe955"
},
"downloads": -1,
"filename": "pyqrbtf-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "e7b35decc5a3efdbd0412b0a68c2cf56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9988,
"upload_time": "2024-09-17T16:57:57",
"upload_time_iso_8601": "2024-09-17T16:57:57.629715Z",
"url": "https://files.pythonhosted.org/packages/33/b6/1880fc7125c54e2df60247e59afe220cbcfb4fb8bfa41a9978b8fa4a2890/pyqrbtf-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 16:57:57",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "Myrik",
"gitlab_project": "pyqrbtf",
"lcname": "pyqrbtf"
}
JSON