Metadata-Version: 2.4
Name: CTkQrCode
Version: 0.1.0
Summary: A CustomTkinter widget for generating customizable QR Codes easily.
Author-email: Matin <matinyarzadeh13@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/hu-matin/CTkQrCode
Project-URL: Bug Tracker, https://github.com/hu-matin/CTkQrCode/issues
Keywords: customtkinter,qrcode,widget,gui
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: qrcode
Requires-Dist: customtkinter
Requires-Dist: Pillow

# CTkQrCode

**A module to generate and display QR codes using CustomTkinter.**

## Features:
- Generates customizable QR codes
- Sets QR version (size/complexity)
- Adjusts box size of QR modules
- Changes border thickness
- Customizes fill color
- Changes background color
- Auto-updates QR image on changes
- Easy access to generated QR image
- Built as a CustomTkinter widget
- Uses qrcode and Pillow libraries
  
## Installation
```
pip install CTkQrCode
```

https://github.com/hu-matin/CTkQrCode/archive/refs/heads/main.zip


## Usage
```python
import customtkinter
from ctkqrcode import CTkQrCode

root = customtkinter.CTk()

table = CTkQrCode(master=root, qr_data = 'CTkQrCode')
table.pack(padx=20, pady=20)

root.mainloop()
```
## Arguments


| Parameter       | Description                                            |
| --------------- | ------------------------------------------------------ |
| master          | parent widget                                          |
| qr_data        | data/content encoded in the QR code (string)         |
| qr_version     | QR code version (controls size and complexity)       |
| qr_box_size   | size of each box / module in the QR code (int)         |
| qr_border      | thickness of the border around QR code (int)         |
| qr_fill_color | color of the QR code modules (fill color) (string) |
| qr_back_color | background color of the QR code (string)             |
| qr_size        | display size of the QR code image (int, pixels)      |
| corner_radius  | radius for rounded corners of QR image (int)         |
| padx            | internal horizontal padding inside the widget (int)  |
| pady            | internal vertical padding inside the widget (int)    |




## Methods
- **.generate_qr_code():** generate and display the QR code image based on current settings  
- <b>.configure(*args, **kwargs):</b> update widget configuration; supports QR-specific options and regenerates QR image on change  
- **.cget(option):** get the value of a configuration option, including QR-specific ones  
- **.set_qr_size(qr_size: int):** set QR code image size and regenerate the QR code
- **.get_qr_size():** return current QR code size
- **.set_corner_radius(corner_radius: int):** set rounded corner radius and regenerate QR code
- **.get_corner_radius():** return current corner radius value
- **.set_qr_data(qr_data: str):** update the data encoded in the QR code and regenerate
- **.set_qr_version(qr_version: int):** set QR version (complexity/size) and regenerate
- **.set_qr_box_size(qr_box_size: int):** set size of QR code boxes/modules and regenerate
- **.set_qr_border(qr_border: int):** set border width around QR code and regenerate
- **.set_qr_fill_color(qr_fill_color: str):** set fill color of QR pattern and regenerate
- **.set_qr_back_color(qr_back_color: str):** set background color behind QR code and regenerate
- **.get_qr_image():** get the current generated QR code image object
- **.get_qr_data():** get the current QR code data string
- **.get_qr_version():** get current QR version
- **.get_qr_box_size():** get current size of QR boxes
- **.get_qr_border():** get current border width
- **.get_qr_fill_color():** get current fill color
- **.get_qr_back_color():** get current background color

### Thanks for visiting! Hope it will help :)
