Metadata-Version: 2.1
Name: bb-wrapper
Version: 0.4.7
Summary: Cliente não oficial da API do Banco do Brasil
Home-page: https://github.com/imobanco/bb-wrapper
License: GPLv3
Keywords: API,Banco,Brasil,BB,client,wrapper
Author: Imobanco
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: Portuguese (Brazilian)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: Unidecode (>=1.2.0,<2.0.0)
Requires-Dist: crc (>=1.0.1,<2.0.0)
Requires-Dist: pycpfcnpj (>=1.5.1,<2.0.0)
Requires-Dist: pydantic (>=1.8.2,<2.0.0)
Requires-Dist: python-barcode (>=0.13.1,<0.14.0)
Requires-Dist: python-decouple (>=3.4,<4.0)
Requires-Dist: qrcode (>=7.3,<8.0)
Requires-Dist: requests (>=2.26.0,<3.0.0)
Project-URL: Repository, https://github.com/imobanco/bb-wrapper
Description-Content-Type: text/x-rst

Cliente não oficial feito em Python, para realizar integração com as API's do Banco do Brasil.

`Documentação oficial do BB <https://developers.bb.com.br/>`_

Instalando
===========

Nosso pacote está hospedado no `PyPI <https://pypi.org/project/bb-wrapper/>`_

.. code-block:: bash

    pip install bb-wrapper



Configuração
==================
Para utilizar o `bb-wrapper` é necessário ter algumas constantes/variáveis. sendo elas:

.. code-block:: python

    IMOBANCO_BB_IS_SANDBOX='flag True ou False para indicar utilização de sandbox ou não'
    IMOBANCO_BB_BASIC_TOKEN='chave de autenticação gerada para a aplicação no site developers.bb'
    IMOBANCO_BB_GW_APP_KEY='chave de desenvolvimento gerada para a aplicação no site developers.bb'


Para geração de boletos é necessário:

.. code-block:: python

    IMOBANCO_BB_CONVENIO='convênio do contrato para geração de boletos'
    IMOBANCO_BB_CARTEIRA='carteira do contrato para geração de boletos'
    IMOBANCO_BB_VARIACAO_CARTEIRA='variação da carteira do contrato para geração de boletos
    IMOBANCO_BB_AGENCIA='agência da conta berço do contrato para geração de boletos'
    IMOBANCO_BB_CONTA='nº da conta berço do contrato para geração de boletos'


Recomendamos criar um arquivo `.env` contendo essas varíaveis de ambiente.

::

    Podem ser criadas diretamente no terminal (não recomendado).

    Podem ser criadas também diretamente no `arquivo.py` (não recomendado).

Recursos disponíveis
=====================

API's
---------------------

- ☑ API de Cobrança (geração de boletos)
- ☑ API PIX (recebimento PIX) {essa API ainda está instável e incompleta no BB}
- ☐ API Arrecadação PIX {sem previsão de implementação}
- ☑ API Lotes de Pagamentos {essa API ainda está instável e incompleta no BB}

  - ☐ Transferência PIX
  - ☑ Transferência Bancária
  - ☐ Pagamento GPS
  - ☐ Pagamento GRU
  - ☐ Pagamento DARF Preto
  - ☑ Pagamento Tributos
  - ☑ Pagamento Boletos

Recursos auxiliares
-------------------

- ☑ Geração de imagem b64
- ☑ Geração, validação e conversão de código de barras de boleto
- ☑ Geração, validação e conversão de código de barras de tributos
- ☑ Geração de QR Code PIX
- ☑ Validação e limpeza de CPF/CNPJ

Exemplos disponíveis
=====================
Existem exemplos de utilização da biblioteca na pasta `examples`.

Preparando ambiente de desenvolvimento
=======================================

> O Nix é utilizado para gerenciar os pacotes necessários, por exemplo como a versão correta do python.

Certifique-se que o ambiente está ativado, se não estiver execute:

.. code-block:: bash

    nix develop


