BrasilApy 使用教程

1. 项目介绍

BrasilApy 是一个开源的 Python 客户端库，用于访问 Brasil API。该库提供了对 Brasil API 的便捷访问，使得用户可以轻松获取巴西的各类数据，例如银行信息、CEP（邮政编码）、CNPJ（商业注册号）、DDD（区号）、节假日信息、Fipe 车辆价格等。BrasilApy 通过将 API 响应转换为 Pydantic 对象，增加了 IDE 的自动完成支持，提高了数据处理的预见性和便捷性。

2. 项目快速启动

首先，确保你的环境中安装了 Python 3.10 或更高版本。然后，通过以下命令安装 BrasilApy：

pip install brasilapy

以下是一个快速启动示例，展示如何使用 BrasilApy 获取州信息和市政信息：

from brasilapy import BrasilAPI
from brasilapy.constants import IBGEProvider

# 创建 BrasilAPI 实例
client = BrasilAPI()

# 获取州信息
estado = client.get_ibge_estado(state_uf="pb")
print(estado.id)
print(estado.regiao)
print(estado.sigla)

# 获取市政信息
municipios = client.get_ibge_municipios(state_uf="pb", providers=(IBGEProvider.DADOS_ABERTOS_BR,))
for municipio in municipios:
    print(municipio.nome)
    print(municipio.codigo_ibge)

3. 应用案例和最佳实践

获取银行信息

from brasilapy import BrasilAPI

client = BrasilAPI()
banks = client.get_banks()
for bank in banks:
    print(bank.name, bank.code)

查询邮政编码

from brasilapy import BrasilAPI

client = BrasilAPI()
cep_info = client.get_cep(test_cep="01001000")
print(cep_info.logradouro)
print(cep_info.bairro)
print(cep_info.cidade)
print(cep_info.uf)

检查商业注册号

from brasilapy import BrasilAPI

client = BrasilAPI()
cnpj_info = client.get_cnpj(test_cnpj="12345678000195")
print(cnpj_info.razaosocial)
print(cnpj_info.natureza)

4. 典型生态项目

目前，BrasilApy 的生态项目包括但不限于以下：

• brasilapy: 核心库，提供对 Brasil API 的访问。
• brasilapy-extensions: 提供额外的工具和功能，扩展核心库的能力。
• brasilapy-cli: 一个命令行工具，允许用户通过命令行访问 Brasil API。

开发者可以根据自己的需要，利用 BrasilApy 创建更多针对特定需求的工具和项目。