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
.. code-block:: bash
nix flake clone 'github:imobanco/bb-wrapper' --dest bb-wrapper \
&& cd bb-wrapper 1>/dev/null 2>/dev/null \
&& (direnv --version 1>/dev/null 2>/dev/null && direnv allow) \
|| nix develop --command sh -c 'make poetry.config.venv && make poetry.install && python -c "import requests"'
git remote set-url origin $(git remote show origin \
| grep "Fetch URL" \
| sed 's/ *Fetch URL: //' \
| sed 's/https:\/\/github.com\//git@github.com:/')
Raw data
{
"_id": null,
"home_page": "https://github.com/imobanco/bb-wrapper",
"name": "bb-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.10",
"maintainer_email": "",
"keywords": "API,Banco,Brasil,BB,client,wrapper",
"author": "Imobanco",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/95/a5/c0339a8dc39bd9c0399c14cd9b7d238fc4e54952ba6971e507b2b9a7600a/bb_wrapper-0.4.21.tar.gz",
"platform": null,
"description": "Cliente n\u00e3o oficial feito em Python, para realizar integra\u00e7\u00e3o com as API's do Banco do Brasil.\n\n`Documenta\u00e7\u00e3o oficial do BB <https://developers.bb.com.br/>`_\n\nInstalando\n===========\n\nNosso pacote est\u00e1 hospedado no `PyPI <https://pypi.org/project/bb-wrapper/>`_\n\n.. code-block:: bash\n\n pip install bb-wrapper\n\n\n\nConfigura\u00e7\u00e3o\n==================\nPara utilizar o `bb-wrapper` \u00e9 necess\u00e1rio ter algumas constantes/vari\u00e1veis. sendo elas:\n\n.. code-block:: python\n\n IMOBANCO_BB_IS_SANDBOX='flag True ou False para indicar utiliza\u00e7\u00e3o de sandbox ou n\u00e3o'\n IMOBANCO_BB_BASIC_TOKEN='chave de autentica\u00e7\u00e3o gerada para a aplica\u00e7\u00e3o no site developers.bb'\n IMOBANCO_BB_GW_APP_KEY='chave de desenvolvimento gerada para a aplica\u00e7\u00e3o no site developers.bb'\n\n\nPara gera\u00e7\u00e3o de boletos \u00e9 necess\u00e1rio:\n\n.. code-block:: python\n\n IMOBANCO_BB_CONVENIO='conv\u00eanio do contrato para gera\u00e7\u00e3o de boletos'\n IMOBANCO_BB_CARTEIRA='carteira do contrato para gera\u00e7\u00e3o de boletos'\n IMOBANCO_BB_VARIACAO_CARTEIRA='varia\u00e7\u00e3o da carteira do contrato para gera\u00e7\u00e3o de boletos\n IMOBANCO_BB_AGENCIA='ag\u00eancia da conta ber\u00e7o do contrato para gera\u00e7\u00e3o de boletos'\n IMOBANCO_BB_CONTA='n\u00ba da conta ber\u00e7o do contrato para gera\u00e7\u00e3o de boletos'\n\n\nRecomendamos criar um arquivo `.env` contendo essas var\u00edaveis de ambiente.\n\n::\n\n Podem ser criadas diretamente no terminal (n\u00e3o recomendado).\n\n Podem ser criadas tamb\u00e9m diretamente no `arquivo.py` (n\u00e3o recomendado).\n\nRecursos dispon\u00edveis\n=====================\n\nAPI's\n---------------------\n\n- \u2611 API de Cobran\u00e7a (gera\u00e7\u00e3o de boletos)\n- \u2611 API PIX (recebimento PIX) {essa API ainda est\u00e1 inst\u00e1vel e incompleta no BB}\n- \u2610 API Arrecada\u00e7\u00e3o PIX {sem previs\u00e3o de implementa\u00e7\u00e3o}\n- \u2611 API Lotes de Pagamentos {essa API ainda est\u00e1 inst\u00e1vel e incompleta no BB}\n\n - \u2610 Transfer\u00eancia PIX\n - \u2611 Transfer\u00eancia Banc\u00e1ria\n - \u2610 Pagamento GPS\n - \u2610 Pagamento GRU\n - \u2610 Pagamento DARF Preto\n - \u2611 Pagamento Tributos\n - \u2611 Pagamento Boletos\n\nRecursos auxiliares\n-------------------\n\n- \u2611 Gera\u00e7\u00e3o de imagem b64\n- \u2611 Gera\u00e7\u00e3o, valida\u00e7\u00e3o e convers\u00e3o de c\u00f3digo de barras de boleto\n- \u2611 Gera\u00e7\u00e3o, valida\u00e7\u00e3o e convers\u00e3o de c\u00f3digo de barras de tributos\n- \u2611 Gera\u00e7\u00e3o de QR Code PIX\n- \u2611 Valida\u00e7\u00e3o e limpeza de CPF/CNPJ\n\nExemplos dispon\u00edveis\n=====================\nExistem exemplos de utiliza\u00e7\u00e3o da biblioteca na pasta `examples`.\n\nPreparando ambiente de desenvolvimento\n=======================================\n\n> O Nix \u00e9 utilizado para gerenciar os pacotes necess\u00e1rios, por exemplo como a vers\u00e3o correta do python.\n\nCertifique-se que o ambiente est\u00e1 ativado, se n\u00e3o estiver execute:\n\n.. code-block:: bash\n\n nix develop\n\n.. code-block:: bash\n\n nix flake clone 'github:imobanco/bb-wrapper' --dest bb-wrapper \\\n && cd bb-wrapper 1>/dev/null 2>/dev/null \\\n && (direnv --version 1>/dev/null 2>/dev/null && direnv allow) \\\n || nix develop --command sh -c 'make poetry.config.venv && make poetry.install && python -c \"import requests\"'\n\n git remote set-url origin $(git remote show origin \\\n | grep \"Fetch URL\" \\\n | sed 's/ *Fetch URL: //' \\\n | sed 's/https:\\/\\/github.com\\//git@github.com:/')\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Cliente n\u00e3o oficial da API do Banco do Brasil",
"version": "0.4.21",
"project_urls": {
"Homepage": "https://github.com/imobanco/bb-wrapper",
"Repository": "https://github.com/imobanco/bb-wrapper"
},
"split_keywords": [
"api",
"banco",
"brasil",
"bb",
"client",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "105aaa0ef38bad6801bae45d8980dc82b973f16a9831772e330652a63b65d0cd",
"md5": "05a503b1ef32a072577b512872dfc3ac",
"sha256": "4366136a0c01880ecefdebffc33ba2882d8f29f08f26b550b651e2f43c2c5976"
},
"downloads": -1,
"filename": "bb_wrapper-0.4.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05a503b1ef32a072577b512872dfc3ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.10",
"size": 38030,
"upload_time": "2023-11-29T17:17:39",
"upload_time_iso_8601": "2023-11-29T17:17:39.299460Z",
"url": "https://files.pythonhosted.org/packages/10/5a/aa0ef38bad6801bae45d8980dc82b973f16a9831772e330652a63b65d0cd/bb_wrapper-0.4.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95a5c0339a8dc39bd9c0399c14cd9b7d238fc4e54952ba6971e507b2b9a7600a",
"md5": "f251e4b5b40ef3e85869c5c47ce22c19",
"sha256": "6effba006d0cf14e84bc6823ce8f7b9a8dd93e09e824690e5e8e71573f166a23"
},
"downloads": -1,
"filename": "bb_wrapper-0.4.21.tar.gz",
"has_sig": false,
"md5_digest": "f251e4b5b40ef3e85869c5c47ce22c19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.10",
"size": 31478,
"upload_time": "2023-11-29T17:17:41",
"upload_time_iso_8601": "2023-11-29T17:17:41.177391Z",
"url": "https://files.pythonhosted.org/packages/95/a5/c0339a8dc39bd9c0399c14cd9b7d238fc4e54952ba6971e507b2b9a7600a/bb_wrapper-0.4.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 17:17:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "imobanco",
"github_project": "bb-wrapper",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "bb-wrapper"
}
JSON
