sidrapy

O que é esse projeto? / What is this project?

É uma biblioteca que oferece uma interface em python para a API SIDRA do Instituto Brasileiro de Geografia e Estatística (IBGE)

O sidrapy permite acessar facilmente em Python dados sobre habitação, inflação, industrias e muito mais.

It is a library that provides a python interface for the Brazilian Institute of Geography and Statistics (IBGE) SIDRA API.

Sidrapy allows you to access data about housing, inflation, industries and many more in Brazil; easily in Python.

Versões Python Suportadas / Supported Python Versions

Todas as versões do Python 3 oficialmente suportadas. Atualmente:

• Python 3.7+

All officially supported Python 3 versions. Currently:

• Python 3.7+

Como instalar e utilizar esse projeto? / How to install and use this project?

Instalação / Installation

Instale e atualize utilizando o pip (inglês):

pip install -U sidrapy

Install and update using pip:

pip install -U sidrapy

Início Rápido / Quick Start

Aqui um exemplo de como utilizar essa biblioteca. Digamos que desejamos os dados do IPCA dos ultimos 12 meses.

Here is an example of how to use this library. Let's assume that we want the IPCA from Brazil from last 12 months.

import sidrapy

data = sidrapy.get_table(table_code="1419", territorial_level="1", ibge_territorial_code="all", period="last 12")

Onde está a documentação da API do SIDRA? / Where is the SIDRA API documentation?

Aqui: http://api.sidra.ibge.gov.br/home/ajuda

Here: http://api.sidra.ibge.gov.br/home/ajuda (brazilian portuguese)

E onde está a documentação do sidrapy? / How about the sidrapy documentation?

Aqui: https://sidrapy.readthedocs.io

Here: https://sidrapy.readthedocs.io (brazilian portuguese)

Contribuindo / Contributing

Para obter orientações sobre como configurar o ambiente de desenvolvimento e como fazer uma contribuição para o sidrapy, consulte o guia de contribuição.

For guidance on setting up a development environment and how to make a contribution to sidrapy, see the contributing guidelines.

Como entrar em contato? / How do I get in touch?

Suporte / Support:

• Grupo Telegram

Mantenedor / Maintainer:

• Email: contato@alantaranti.me
• Website: alantaranti.me