API Client criado para visualizar informações referentes a dados de localização. O objetivo é praticar diversos conceitos da linguagem e padrões de projeto. O padrão de projeto escolhido para o desenvolvimento é o MVC (Model-View-Controller), implementado em Python.
A API utilizada neste projeto foi a cep.la, que disponibiliza acesso gratuito e sem registro. Nessa API é possível solicitar dados de CEP de forma simples, com requisições GET, para recuperar dados de diferentes formas. É possível verificar dados referentes às cidades, bairros, ruas, cep's entre outros. Sua versatilidade de identificar todos esses campos através dos nomes que o usuário pode requisitar, faz com que seja possível desenvolver diversas funcionalidades.
- Introdução
- Instalando pacotes
- Padrão Model-View-Controller
- To-Do List da Aplicação
- Uso do API Client
Para instalar os pacotes utilizados no projeto, basta ter o pip instalado e utilizar o comando a seguir:
pip install -r requirements.txt
- requests é utilizado para realizar todas as requisições à API cep.la
- rich é utilizado para formatar os resultados, implementados em CepView para a visualização do usuário
A implementação do CepModel consiste em realizar as requisições para a API, além de tratar os dados inseridos pelo usuário e retornar os dados de resposta da API, de uma maneira que possa ser utilizada por outras estruturas. Além disso, lança exceções para diversos problemas que podem ocorrer no processo, seja pelo usuário ou pela API.
A implementação do CepView consiste apenas em organizar a visualização dos dados retornados pelo CepModel. A visualização deve ser feita de forma clara para o usuário, a fim de oferecer uma experiência boa para quem utiliza. No momento é feita através de prints no terminal, porém a forma como o projeto está organizado permite que, caso o projeto escale e seja feita uma interface gráfica, por exemplo, os únicos métodos que deveriam ser modificadas seriam as de CepView.
A implementação do CepControl é feita para que o usuário tenha acesso aos métodos para o uso da API como um cliente. Estes métodos coletam os dados necessários do usuário, invoca o model para tratá-los e organizar os dados, depois utiliza esses resultados para invocar o view e exibir os dados para o usuário. Essa orquestração é feita apenas pelo controller, ao qual o usuário tem contato. Nele também são feitos os tratamentos de exceção, simplificando ainda mais o retorno para o usuário verificar e realizar ações a respeito.
Aqui serão apresentadas as próximas ideias a serem implementadas para que o projeto tenha cada vez mais funcionalidades.
- Procura informações de endereço através de um CEP
- Procura nomes dos bairros de cidades
- Descobrir CEP através de um endereço
- Descobrir se uma cidade, de um determinado estado possui distritos
- Listar Ruas de algum bairro da cidade
- Etc... (To-Do)
main.py
from CepControl import CepControl
if __name__ == '__main__':
control = CepControl()
control.search_by_cep(input('Insira um CEP válido: '))TERMINAL
main.py
from CepControl import CepControl
if __name__ == '__main__':
control = CepControl()
control.search_by_neighborhood(uf='pe', city='recife')TERMINAL (apenas parte da saída na imagem)
