pysimpqr 1.0.0
This python library can help you to create simple qr code


![Python Version](https://img.shields.io/badge/python-3.9-blue.svg)

**_`pysimpqr` is python library that can you help to create qr code and automatically save QR code with name provided by you as png file._**

## Table of Contents

- [Installation](#installation)
- [How To Use](#how-to-use)
  - [Importing the Module](#importing-the-module)
  - [Creating QR Codes](#create-qr-code)
  - [More Examples](#more-examples)
  - [Errors](#errors)
- [Terms And Condition](#terms-and-condition)
- [License](#license)
- [About Us](#about-us)

## Installation

To integrate `pysimpqr` into your project, you can use `pip`:

```bash
pip install pysimpqr
```

pysimpqr using pypng library for save png files. If it's not installed after installing pysimpqr, then install it :

```bash
pip install pypng
```

For use pysimpqr you have to install python 3 on your device.(Python 2 is not supported!)

## How To Use

### Importing The Module

To import pysimpqr to your projects just use `import` :

```python
import pysimpqr
```

### Create Qr Code

To create qr code using pysimpqr, you can use `pysimpqr.create_qr` : 

```python
pysimpqr.create_qr("<YOUR TEXT>", "<IMAGE NAME>")
```

### More Examples

Normal example

```python
import pysimpqr

# With Variables
text_for_qr = "Welcome to the our free Wi-Fi. Password is freewifi123"
file_name = "My-First-QR-Code"

pysimpqr.create_qr(text_for_qr, file_name)

# Without Variables
pysimpqr.create_qr("Welcome to the our free Wi-Fi. Password is freewifi123", "My-First-QR-Code")
```

Define pysimpqr

```python
import pysimpqr as qrgen

# With Variables
text_for_qr = "Welcome to the our free Wi-Fi. Password is freewifi123"
file_name = "My-First-QR-Code"

qrgen.create_qr(text_for_qr, file_name)

# Without Variables
qrgen.create_qr("Welcome to the our free Wi-Fi. Password is freewifi123", "My-First-QR-Code")
```

### Errors

You will face some errors while using pysimpqr.

1. **text object not found: code need for create qr code** - This mean you haven't provided text for create qr code. Provide your text.

```python
pysimpqr.create_qr("My Text", "<FILE_NAME>")
```

2. **name object not found: file name need for save qr code** - This error saying you haven't given the file name for qr code. Give your file name.

```python
pysimpqr.create_qr("<TEXT>", "My_Qr_Code")
```

3. **Unable to create QR Code : ERROR_5963** - This code mean something messing in proccess. Try again with different text and file name.

4. **Seem like you have python2. You must have python3 installed on your device to run pysimpqr** - If you see this error you have to update your python version. pysimpqr can't run on python 2. It's very old version. All potato pc's can run python 3.2. So why are you using python2?

## Terms And Condition

1. **Use Responsibly**: This python library is developed for only education purpose.

2. **Time Delay**: Sometimes it takes few seconds to generate QR code

3. **Don't use long text**: Use shorts text for create qr code. Long text due to crash the your project.

4. **Objects**: pysimpqr has only two objects. One is code. The text for the qr code. Another one is name. The file name for save png file.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.


## About Us

We are PixCap TM. We are from Sri Lanka. We interest on programming and software development. PYSIMPQR is our first python library. We have created some computer softwares. And we developing telegram bots. You can find Medusa bot on telegram(Username : @medusa_rs45_bot). This bot has awesome tools for intract qith dnghua and anime world. Check it out!

**Copyright © 2020-2023 PixCap TM.**
**All rights Reserved.**