| Name | pixqrcode JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | |
| Summary | QRCode Pix for python |
| upload_time | 2024-03-16 08:21:50 |
| maintainer | |
| docs_url | None |
| author | Joao Carlos |
| requires_python | |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pix QRCode - Python
#### Versao: __1.1.0__
Biblioteca para a geração de codigos QR (BRCode como chamados na documentação do BACEN) a fins de facilitar a exibição para pagamentos ao consumidor.
## O que é pix
_Pix é o meio de pagamento eletrônico instantâneo, gratuito e com segurança, do Brasil. A iniciação de um Pix para uma pessoa física é gratuita._ [Wikipedia](https://pt.wikipedia.org/wiki/Pix)
## Isenção de responsabilidade
Os QR codes não foram testados aos bancos, sempre antes de transferir verifique se as informações estão corretas. O autor e contribuidores se isenta de qualquer responsabilidade pela exatidão e integridade das informações divulgada.
## Documentação de implementação BACEN - Banco Central do Brasil
[Manual BRCode](https://www.bcb.gov.br/content/estabilidadefinanceira/spb_docs/ManualBRCode.pdf)
[Especificações técnicas e de negócio do ecossistema de pagamentos instantâneos brasileiro](https://www.bcb.gov.br/content/estabilidadefinanceira/forumpireunioes/Documento%20de%20especifica%C3%A7%C3%B5es%20-%20vers%C3%A3o%205-0.pdf)
[Github Bacen](https://github.com/bacen)
**NÃO EXISTE NENHUMA INTEGRAÇÃO COM BANCOS**
---
## Exemplo basico
Importe a biblioteca do pip `pip install pixqrcode`
Importe a classe `from pixqrcode import PixQrCode` e defina os parametros como abaixo
Obrigatorio
* name = Nome do destinatario
* mobile (Chave PIX) = Telefone do destinatario _Em Breve mais chaves_
* city = Cidade de remetente
Opcional
* amount = Valor a ser enviado
Valores serão sempre contados com 3 casas decimais e tem todos os digitos não numericos removidos, exemplos abaixo
* R$ 1,00 = 100
* R$ 10,00 = 1000
* reference_label = Código da transferência. Codigo não obrigatorio mais pode auxiliar em casos como ecommerce e vendas diretas por Pix
`pix = PixQrCode("Fulano De Tal", "(70) 97070-7070", "Brasilia", "100")`
### Retorno do QRCode e codigo BRCode
seguimos com o objeto de cima definido iremos chamar os metodos e suas funções
#### Metodos
### `is_valid()`
Verifica se todos os campos inseridos são validos e pode seguir com a geração do QRCode. Retorna um valor boolean
### `export_base64()`
Retorna direto em formato base64 tipo imagem PNG (Portable Network Grapich) para ser renderizado dentro de uma tag img HTML ou ser transportado por uma API e demais usos.
pix.export_base64()
<img src='{pix_image}' alt='qrcode pagamento'/>
### `save_qrcode(folder, filename, **kwargs)`
pix.save_qrcode("/pixs","pix-fulano")
Caso queira você pode salvar o codigo gerado em uma pasta com um nome especifico para ter o codigo. **Não precisa especificar o formato do arquivo sempre será PNG**
Pode retornar o valor dentro BufferIO para ser novamente processado.
A geração do QRCode é feita com a biblioteca [Pillow](https://pillow.readthedocs.io/en/stable/) então você pode utilizar para deixar seu QRCode ainda mais personalizado passando os parametros por **kwargs
### `generate_code()`
Irá retornar a string com a qual foi gerado o QRCode contendo os valores todos em suas posições como descrito na documentação do BACEN
## [Exemplos](./examples)
Contem mais exemplos para facilitar a sua implementação
1. [API](./examples/API/api.py) [Dockerfile - port 8000](./examples/API/Dockerfile)
1. [Console](./examples/console/console_example.py)
Em breve mais...
#### Toda contribuição é bem vinda!
Raw data
{
"_id": null,
"home_page": "",
"name": "pixqrcode",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Joao Carlos",
"author_email": "joao-mostela@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/62/85169e770783f6dd62a8ac2e49937fd3a16bf5db723150364e7d95dbb710/pixqrcode-1.1.0.tar.gz",
"platform": null,
"description": "# Pix QRCode - Python\n\n#### Versao: __1.1.0__\n\nBiblioteca para a gera\u00e7\u00e3o de codigos QR (BRCode como chamados na documenta\u00e7\u00e3o do BACEN) a fins de facilitar a exibi\u00e7\u00e3o para pagamentos ao consumidor.\n\n## O que \u00e9 pix\n\n_Pix \u00e9 o meio de pagamento eletr\u00f4nico instant\u00e2neo, gratuito e com seguran\u00e7a, do Brasil. A inicia\u00e7\u00e3o de um Pix para uma pessoa f\u00edsica \u00e9 gratuita._ [Wikipedia](https://pt.wikipedia.org/wiki/Pix)\n\n\n## Isen\u00e7\u00e3o de responsabilidade\n\nOs QR codes n\u00e3o foram testados aos bancos, sempre antes de transferir verifique se as informa\u00e7\u00f5es est\u00e3o corretas. O autor e contribuidores se isenta de qualquer responsabilidade pela exatid\u00e3o e integridade das informa\u00e7\u00f5es divulgada.\n\n\n## Documenta\u00e7\u00e3o de implementa\u00e7\u00e3o BACEN - Banco Central do Brasil\n\n[Manual BRCode](https://www.bcb.gov.br/content/estabilidadefinanceira/spb_docs/ManualBRCode.pdf)\n\n[Especifica\u00e7\u00f5es t\u00e9cnicas e de neg\u00f3cio do ecossistema de pagamentos instant\u00e2neos brasileiro](https://www.bcb.gov.br/content/estabilidadefinanceira/forumpireunioes/Documento%20de%20especifica%C3%A7%C3%B5es%20-%20vers%C3%A3o%205-0.pdf)\n\n[Github Bacen](https://github.com/bacen)\n\n**N\u00c3O EXISTE NENHUMA INTEGRA\u00c7\u00c3O COM BANCOS**\n\n---\n\n## Exemplo basico\n\nImporte a biblioteca do pip `pip install pixqrcode`\n\nImporte a classe `from pixqrcode import PixQrCode` e defina os parametros como abaixo\n\nObrigatorio\n\n* name = Nome do destinatario\n* mobile (Chave PIX) = Telefone do destinatario _Em Breve mais chaves_\n* city = Cidade de remetente\n\n\nOpcional\n\n* amount = Valor a ser enviado\n \n Valores ser\u00e3o sempre contados com 3 casas decimais e tem todos os digitos n\u00e3o numericos removidos, exemplos abaixo\n \n * R$ 1,00 = 100\n * R$ 10,00 = 1000\n \n* reference_label = C\u00f3digo da transfer\u00eancia. Codigo n\u00e3o obrigatorio mais pode auxiliar em casos como ecommerce e vendas diretas por Pix\n\n\n\n `pix = PixQrCode(\"Fulano De Tal\", \"(70) 97070-7070\", \"Brasilia\", \"100\")`\n\n\n### Retorno do QRCode e codigo BRCode\n\nseguimos com o objeto de cima definido iremos chamar os metodos e suas fun\u00e7\u00f5es\n\n\n#### Metodos\n\n\n### `is_valid()`\n\nVerifica se todos os campos inseridos s\u00e3o validos e pode seguir com a gera\u00e7\u00e3o do QRCode. Retorna um valor boolean\n\n\n### `export_base64()`\n\nRetorna direto em formato base64 tipo imagem PNG (Portable Network Grapich) para ser renderizado dentro de uma tag img HTML ou ser transportado por uma API e demais usos.\n\n\n pix.export_base64()\n \n <img src='{pix_image}' alt='qrcode pagamento'/>\n\n\n\n### `save_qrcode(folder, filename, **kwargs)`\n\n pix.save_qrcode(\"/pixs\",\"pix-fulano\")\n\nCaso queira voc\u00ea pode salvar o codigo gerado em uma pasta com um nome especifico para ter o codigo. **N\u00e3o precisa especificar o formato do arquivo sempre ser\u00e1 PNG**\n\nPode retornar o valor dentro BufferIO para ser novamente processado.\n\nA gera\u00e7\u00e3o do QRCode \u00e9 feita com a biblioteca [Pillow](https://pillow.readthedocs.io/en/stable/) ent\u00e3o voc\u00ea pode utilizar para deixar seu QRCode ainda mais personalizado passando os parametros por **kwargs\n\n\n\n### `generate_code()`\n\nIr\u00e1 retornar a string com a qual foi gerado o QRCode contendo os valores todos em suas posi\u00e7\u00f5es como descrito na documenta\u00e7\u00e3o do BACEN\n\n\n\n## [Exemplos](./examples)\n\nContem mais exemplos para facilitar a sua implementa\u00e7\u00e3o\n\n1. [API](./examples/API/api.py) [Dockerfile - port 8000](./examples/API/Dockerfile)\n1. [Console](./examples/console/console_example.py)\n\nEm breve mais...\n\n#### Toda contribui\u00e7\u00e3o \u00e9 bem vinda!\n",
"bugtrack_url": null,
"license": "",
"summary": "QRCode Pix for python",
"version": "1.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ecf8552d8489540801001e6958da059f8c66f4db79f5a4508c7cd1e4bfdf1ca",
"md5": "3c1c6114ce47005ebc870edf4acdca22",
"sha256": "cbb72abe8e9b34d6a868094d7dc14526597d7bd3f853f947db1a93b870a95b56"
},
"downloads": -1,
"filename": "pixqrcode-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c1c6114ce47005ebc870edf4acdca22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8206,
"upload_time": "2024-03-16T08:21:48",
"upload_time_iso_8601": "2024-03-16T08:21:48.956812Z",
"url": "https://files.pythonhosted.org/packages/2e/cf/8552d8489540801001e6958da059f8c66f4db79f5a4508c7cd1e4bfdf1ca/pixqrcode-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "426285169e770783f6dd62a8ac2e49937fd3a16bf5db723150364e7d95dbb710",
"md5": "5eea250e500654be5fbec58c9507fc25",
"sha256": "3455ef522b7291d05a46adf4875c31a12eeb8f3aa2cb30ceda071f9cf545cf54"
},
"downloads": -1,
"filename": "pixqrcode-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5eea250e500654be5fbec58c9507fc25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7954,
"upload_time": "2024-03-16T08:21:50",
"upload_time_iso_8601": "2024-03-16T08:21:50.704739Z",
"url": "https://files.pythonhosted.org/packages/42/62/85169e770783f6dd62a8ac2e49937fd3a16bf5db723150364e7d95dbb710/pixqrcode-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 08:21:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pixqrcode"
}
