Metadata-Version: 2.1
Name: bb-wrapper
Version: 0.2.1
Summary: Cliente não oficial da API do Banco do Brasil
Home-page: https://github.com/imobanco/bb-wrapper/
Author: Imobanco
License: UNKNOWN
Project-URL: Source, https://github.com/imobanco/bb-wrapper
Project-URL: Tracker, https://github.com/imobanco/bb-wrapper/issues
Keywords: API Banco Brasil BB client wrapper
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: Portuguese (Brazilian)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries
Classifier: Topic :: Utilities
Classifier: 
Classifier: 
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: requests (>=2.23.0)
Requires-Dist: python-decouple (>=3.3)
Requires-Dist: pydantic (>=1.7.0)
Requires-Dist: python-barcode (>=0.13.1)
Requires-Dist: unidecode (>=1.1.2)
Requires-Dist: qrcode (>=6.1)
Requires-Dist: crc (>=1.0.0)

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 Pagamentos {esperando lançar no BB}

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 convênio {sem previsão de implementação}
- ☑ Geração de QR Code PIX


