Giter VIP home page Giter VIP logo

brasilapy's Introduction

BrasilApy

Um cliente da Brasil API em python3. Link do repositório oficial.

codecov Quality Gate Status

Nesta versão 1.0.0 esse cliente possui suporte a autocomplete por meio de Typed Hints. Todos as respostas são traduzidas para objetos do Pydantic, que trazem previsibilidade ao explorar a API através da sua IDE favorita.

Instalação

Rode o comando pip install brasilapy e estará tudo pronto. A versão do python que é compativel com essa biblioteca é a 3.10+.

Documentação

Documentação oficial da API com todas as chamadas poderão se encontradas neste link.

Código de exemplo

Para efetuar as consultas na API, basta instanciar a classe e fazer as consultas.

from brasilapy import BrasilAPI

client = BrasilAPI()
estado = client.get_ibge_estado(state_uf="pb")

print(estado.id)
print(estado.regiao)
print(estado.sigla)

###
# para um caso mais complexo, temos
###
from brasilapy.constants import IBGEProvider

municipios = client.get_ibge_municipios(state_uf="pb", providers=(IBGEProvider.DADOS_ABERTOS_BR,))

for municipio in municipios:
    print(municipio.nome)
    print(municipio.codigo_ibge)

Métodos disponíveis do BrasilAPI

Método Detalhes
get_banks()
get_bank(code: str)
get_cep(test_cep: str, api_version: APIVersion)
get_cnpj(test_cnpj: str)
get_ddd(test_ddd: str)
get_feriados(year: int)
get_fipe_veiculos(tipo_veiculos: FipeTipoVeiculo, tabela_referencia: int)
get_fipe_precos(codigo_fipe: str, tabela_referencia: int)
get_fipe_tabelas()
get_ibge_municipios(state_uf: str, providers: tuple[IBGEProvider]
get_ibge_estados()
get_registro_br_domain(fqdn: str)
get_taxas_juros()
get_taxa_juros(taxa: TaxaJurosType)

Os tipos de dados APIVersion, FipeTipoVeiculo, IBGEProvider e TaxaJurosType são classes de constants que podem ser importadas através do seguinte comando:

from brasilapy.constants import APIVersion, FipeTipoVeiculo, IBGEProvider, TaxaJurosType

Autores

Filipe Soares Jonhnatha Trigueiro

Gostaria de contribuir?

Escrevemos um guia que pode ser encontrado em CONTRIBUTE.md.

brasilapy's People

Contributors

joepreludian avatar lipe14-ops avatar maxwellat avatar phpinheiro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.