PKG-INFO

Metadata-Version: 2.1
Name: camaraPy
Version: 0.0.4
Summary: A wrapper for the Brazilian House of Representatives public data API
Home-page: https://github.com/RodrigoMenegat/camaraPy
Author: Rodrigo Menegat Schuinski
Author-email: rodrigoschuinski@gmail.com
License: UNKNOWN
Description: # camaraPy
        
        O pacote camaraPy é um wrapper, ainda em estágio inicial de desenvolvimento, para as APIs da [Câmara dos Deputados](https://dadosabertos.camara.leg.br/).
        
        Agora, em vez de montar a requisição manualmente usando pacotes como `urrlib` ou `requests`, você pode simplesmente instalar o **camaraPy** e fazer tudo em poucas linhas de código:
        
        ```
        from camaraPy.api_original import proposicoes
        
        # Define parâmetros para a consulta
        params = {
            "Tipo"   : "PEC",
            "Numero" : "666",
            "Ano"    : "2019"
        }
                
        # Acessa as votações da proposta
        dados = proposicoes.ObterVotacaoProposicao(params)
        ```
        
        Por enquanto, o módulo funciona apenas com a [API original](https://www2.camara.leg.br/transparencia/dados-abertos/dados-abertos-legislativo), que é mais estável e inclui o resultado das votações em plenário, dado que ainda não está disponível no novo serviço.
        
        ## Como usar?
        
        Todas as requsições descritas na [documentação da Câmara](https://www2.camara.leg.br/transparencia/dados-abertos/dados-abertos-legislativo/dados-abertos-legislativo) foram implementadas, exatamente com a mesma grafia. O nome dos webservices, porém, é grafado seguindo um padrão `lowercase_com_underlines`.
        
        Assim, para acessar o método *ListarDiscursosPlenario* do Webservice *SessoesReunioes*, o usuário precisa executar o seguinte código, no qual a variável `params` é um dicionário com os parâmetros que deseja passar para a requisição.
        
        ```
        from camaraPy.api_original import sessoes_reunioes
        
        params = { "DataIni" : "10/10/2018", "DataFim" : "13/10/2018" }
        dados = sessoes_reunioes.ListarDiscursosPlenario(params)
        ```
        
        De maneira semelhante, para acessar o método *ObterDeputados* do Webservice *Deputados*, o código seria o seguinte:
        ```
        from camaraPy.api_original import deputados
        
        dados = deputados.ObterDeputados()
        ```
        
        Os dados já vêm parseados em um dicionário no estilo JSON, embora a API retorne os valores em formato XML. Isso é possível porque o **camaraPy** usa o fenomenal pacote [`xmltodict`](https://github.com/martinblech/xmltodict)para fazer a conversão. :heart:
        
        O **camaraPy** funciona só para o Python 3.6 ou superior.
        
        ## Como instalar?
        
        `pip install camaraPy` ✨
        
        
        ## Coisas técnicas:
        
        O código consiste, basicamente, em um script genérico que faz solicitações variadas para a API. Ele está disponível no diretório `core`. A partir desse programa, foram criadas funções encapsuladoras em `deputados.py`, `orgaos.py`, `sessoes_reunioes.py` e `votacoes.py`. Elas apenas chamam as funções definidas em `core.py` com os parâmetros corretos.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: Unix
Requires-Python: >=3.6
Description-Content-Type: text/markdown