Metadata-Version: 2.4
Name: pushinpay
Version: 0.1.0
Summary: Wrapper para a API PushinPay
Home-page: https://github.com/ricardotenv/pushinpay
Author: Ricardo Santos
Author-email: ricardotenv@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# PushinPay

pushinpay é uma biblioteca Python para integração com a API do gateway de pagamento [PushinPay](https://pushinpay.com.br/), permitindo a criação e gerenciamento de pagamentos via Pix.

Documentação oficial: https://doc.pushinpay.com.br/#introducao

## Instalação

Para instalar a biblioteca, utilize o `pip`:

```bash
pip install pushinpay
```

## Configuração

Para começar a usar a biblioteca, você precisa de uma chave de API fornecida pelo PushinPay. Você pode configurar a biblioteca da seguinte forma:

```python
from pushinpay import PushinPay

# Inicialize o cliente PushinPay
pushinpay = PushinPay(api_key="SUA_CHAVE_API", webhook_url="https://seu-webhook.com", sandbox=True)
```

- `api_key`: Sua chave de API.
- `webhook_url`: (Opcional) URL para receber notificações de eventos.
- `sandbox`: (Opcional) Define se o ambiente de sandbox será utilizado. O padrão é `False`.

## Funcionalidades

### Criar QR Code Pix

Você pode criar um QR Code Pix para pagamentos:

```python
# Criar um QR Code Pix
qrcode = pushinpay.pix.create_qrcode(value=1000)  # Valor em centavos (R$10,00)
print(qrcode)  # String do QR Code (__str__)
# Ou
print(qrcode.qrcode)
```

### Consultar Status de um QR Code Pix

Para consultar o status de um QR Code Pix:

```python
# Consultar o status do QR Code
qrcode_status = pushinpay.pix.get_status_qrcode(qrcode)
print(qrcode_status)  # Uma instância de QRCodeResponseStatus
print(qrcode_status.value) # 1000

# Observação: qrcode.status é diferente de qrcode_status
```

## Tratamento de Erros

A biblioteca lança exceções específicas para erros da API:

- `PushinPayError`: Exceção base para erros da biblioteca.
- `APIError`: Exceção para erros retornados pela API.

Exemplo de tratamento de erros:

```python
from pushinpay.errors import APIError

try:
    qrcode = pushinpay.pix.create_qrcode(value=1000)
except APIError as e:
    print(f"Erro na API: {e.status_code} - {e.message}")
```

## Requisitos

- Python 3.6 ou superior
- Biblioteca `requests`

## Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests no repositório.

## Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo `LICENSE` para mais detalhes.
