Metadata-Version: 2.4
Name: qrlite
Version: 1.0.0
Summary: Simple QR Code generator with PIX, Wi-Fi and URL support
Author: Bruno Rafael
License: MIT
Project-URL: Homepage, https://github.com/brxnorafa/qrlite
Project-URL: Repository, https://github.com/brxnorafa/qrlite
Project-URL: Issues, https://github.com/brxnorafa/qrlite/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: segno

# qrlite

Uma biblioteca Python simples e open source para gerar QR Codes, com
suporte a:

-   URLs
-   Wi-Fi
-   PIX estático (com ou sem valor fixo)

Os QR Codes podem ser gerados em **PNG** ou **SVG**, automaticamente de
acordo com a extensão do arquivo.

------------------------------------------------------------------------

## Instalação

``` bash
pip install qrlite
```

------------------------------------------------------------------------

## Uso básico

### QR Code de URL

``` python
import qrlite

qrlite.url(
    "https://example.com",
    output="site.png",
)

qrlite.url(
    "https://example.com",
    output="site.svg",
)
```

------------------------------------------------------------------------

### QR Code de Wi-Fi

``` python
qrlite.wifi(
    ssid="MinhaRede",
    password="12345678",
    output="wifi.png",
)
```

------------------------------------------------------------------------

### QR Code de PIX (sem valor fixo)

Gera um PIX aberto, onde o pagador escolhe o valor no app do banco.

``` python
qrlite.pix(
    "email@exemplo.com",
    output="pix_livre.png",
)
```

------------------------------------------------------------------------

### QR Code de PIX (com valor fixo)

Gera um PIX com valor já definido.

``` python
qrlite.pix(
    "email@exemplo.com",
    valor=25.90,
    output="pix_25.svg",
)
```

------------------------------------------------------------------------

## Formatos suportados

O formato do QR Code é detectado automaticamente pela extensão do
arquivo:

-   `.png` → PNG
-   `.svg` → SVG

Não é necessário passar nenhum parâmetro extra.

------------------------------------------------------------------------

## PIX --- Detalhes técnicos

-   Implementação baseada no padrão **EMV®**
-   Suporte a:
    -   chave PIX
    -   valor opcional
-   Cálculo correto de **CRC-16/CCITT-FALSE**
-   Compatível com apps bancários no Brasil

------------------------------------------------------------------------

## Testes

Os testes automatizados usam `pytest`.

Para rodar os testes localmente:

``` bash
pytest
```

------------------------------------------------------------------------

## Requisitos

-   Python **3.9+**
-   Dependência:
    -   `segno`

------------------------------------------------------------------------

## Licença

MIT License

------------------------------------------------------------------------

## Aviso

Esta biblioteca gera **QR Codes estáticos**.\
Ela **não realiza pagamentos**, não se conecta a bancos e não processa
transações.

O QR Code gerado apenas codifica o payload no formato esperado pelos
aplicativos bancários.
