# sidrapy
[![Version](https://img.shields.io/pypi/v/sidrapy.svg?style=flat)](https://pypi.python.org/pypi/sidrapy)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/sidrapy)](https://pypi.python.org/pypi/sidrapy)
[![Python Version](https://img.shields.io/pypi/pyversions/sidrapy?style=flat)](https://pypi.python.org/pypi/sidrapy)
[![License](https://img.shields.io/github/license/AlanTaranti/Sidrapy)](https://github.com/AlanTaranti/sidrapy/blob/master/LICENSE)
![Maintenance](https://img.shields.io/maintenance/yes/2022)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/AlanTaranti/sidrapy/blob/master/CODE_OF_CONDUCT.md)
## O que é esse projeto? / _What is this project?_
É uma biblioteca que oferece uma interface em python para a [API SIDRA](http://api.sidra.ibge.gov.br/) 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](http://api.sidra.ibge.gov.br/)._
_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](https://pip.pypa.io/en/stable/quickstart/) (inglês):
```shell script
pip install -U sidrapy
```
_Install and update using [pip](https://pip.pypa.io/en/stable/quickstart/):_
```shell script
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._
```python
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](https://github.com/AlanTaranti/sidrapy/blob/master/CONTRIBUTING.md).
_For guidance on setting up a development environment and how to make a contribution to sidrapy, see the [contributing guidelines](https://github.com/AlanTaranti/sidrapy/blob/master/CONTRIBUTING_EN.md)._
## Como entrar em contato? / _How do I get in touch?_
Suporte / _Support:_
* [Grupo Telegram](https://t.me/joinchat/AmdQix1KKeZ5KGpsKVFsKw)
Mantenedor / _Maintainer_:
* Email: [contato@alantaranti.me](mailto:contato@alantaranti.me)
* Website: <a href="https://alantaranti.me" target="_blank">alantaranti.me</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/AlanTaranti/sidrapy",
"name": "sidrapy",
"maintainer": "Alan Taranti",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "contato@alantaranti.me",
"keywords": "ibge,sidra,api,brasil,brazil,estatistica,statistics",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/25/73/58c3024d754c1497bbf25fe7d63cd4b301c9cf8ae47ca4c1c3f8cfc42a82/sidrapy-0.1.4.tar.gz",
"platform": null,
"description": "# sidrapy\n\n[![Version](https://img.shields.io/pypi/v/sidrapy.svg?style=flat)](https://pypi.python.org/pypi/sidrapy)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/sidrapy)](https://pypi.python.org/pypi/sidrapy)\n[![Python Version](https://img.shields.io/pypi/pyversions/sidrapy?style=flat)](https://pypi.python.org/pypi/sidrapy)\n[![License](https://img.shields.io/github/license/AlanTaranti/Sidrapy)](https://github.com/AlanTaranti/sidrapy/blob/master/LICENSE)\n![Maintenance](https://img.shields.io/maintenance/yes/2022)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/AlanTaranti/sidrapy/blob/master/CODE_OF_CONDUCT.md)\n\n## O que \u00e9 esse projeto? / _What is this project?_\n\n\u00c9 uma biblioteca que oferece uma interface em python para a [API SIDRA](http://api.sidra.ibge.gov.br/) do Instituto Brasileiro de Geografia e Estat\u00edstica (IBGE)\n\nO sidrapy permite acessar facilmente em Python dados sobre habita\u00e7\u00e3o, infla\u00e7\u00e3o, industrias e muito mais.\n\n_It is a library that provides a python interface for the Brazilian Institute of Geography and Statistics (IBGE) [SIDRA API](http://api.sidra.ibge.gov.br/)._\n\n_Sidrapy allows you to access data about housing, inflation, industries and many more in Brazil; easily in Python._\n\n\n## Vers\u00f5es Python Suportadas / _Supported Python Versions_\n\nTodas as vers\u00f5es do Python 3 oficialmente suportadas. Atualmente:\n- Python 3.7+\n\n_All officially supported Python 3 versions. Currently:_\n- _Python 3.7+_\n\n## Como instalar e utilizar esse projeto? / _How to install and use this project?_\n\n### Instala\u00e7\u00e3o / _Installation_\nInstale e atualize utilizando o [pip](https://pip.pypa.io/en/stable/quickstart/) (ingl\u00eas):\n```shell script\npip install -U sidrapy\n```\n\n_Install and update using [pip](https://pip.pypa.io/en/stable/quickstart/):_\n```shell script\npip install -U sidrapy\n```\n\n### In\u00edcio R\u00e1pido / _Quick Start_\n\nAqui um exemplo de como utilizar essa biblioteca.\nDigamos que desejamos os dados do IPCA dos ultimos 12 meses.\n\n_Here is an example of how to use this library._\n_Let's assume that we want the IPCA from Brazil from last 12 months._\n\n```python\nimport sidrapy\n\ndata = sidrapy.get_table(table_code=\"1419\", territorial_level=\"1\", ibge_territorial_code=\"all\", period=\"last 12\")\n```\n\n### Onde est\u00e1 a documenta\u00e7\u00e3o da API do SIDRA? / _Where is the SIDRA API documentation?_\nAqui: http://api.sidra.ibge.gov.br/home/ajuda\n\n_Here: http://api.sidra.ibge.gov.br/home/ajuda (brazilian portuguese)_\n\n### E onde est\u00e1 a documenta\u00e7\u00e3o do sidrapy? / _How about the sidrapy documentation?_\nAqui: https://sidrapy.readthedocs.io\n\n_Here: https://sidrapy.readthedocs.io (brazilian portuguese)_\n\n### Contribuindo / _Contributing_\nPara obter orienta\u00e7\u00f5es sobre como configurar o ambiente de desenvolvimento e como fazer uma contribui\u00e7\u00e3o para o sidrapy, consulte o [guia de contribui\u00e7\u00e3o](https://github.com/AlanTaranti/sidrapy/blob/master/CONTRIBUTING.md).\n\n_For guidance on setting up a development environment and how to make a contribution to sidrapy, see the [contributing guidelines](https://github.com/AlanTaranti/sidrapy/blob/master/CONTRIBUTING_EN.md)._\n\n## Como entrar em contato? / _How do I get in touch?_\nSuporte / _Support:_\n* [Grupo Telegram](https://t.me/joinchat/AmdQix1KKeZ5KGpsKVFsKw)\n\nMantenedor / _Maintainer_:\n* Email: [contato@alantaranti.me](mailto:contato@alantaranti.me)\n* Website: <a href=\"https://alantaranti.me\" target=\"_blank\">alantaranti.me</a>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library that provides a python interface for the IBGE SIDRA API.",
"version": "0.1.4",
"split_keywords": [
"ibge",
"sidra",
"api",
"brasil",
"brazil",
"estatistica",
"statistics"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c40bf896d1a4a4e84b0fd61d4da50919",
"sha256": "5a18c999dcbc17772bb062131a798b1eb3185aa5700a4c1d029c8d9eeb629d17"
},
"downloads": -1,
"filename": "sidrapy-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c40bf896d1a4a4e84b0fd61d4da50919",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6874,
"upload_time": "2022-09-19T22:18:21",
"upload_time_iso_8601": "2022-09-19T22:18:21.563486Z",
"url": "https://files.pythonhosted.org/packages/dd/8b/190d75bb78851f0af571925f61843fe70d8d99bb335ac7d5d574818614b8/sidrapy-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "775adc329d5b2008fe711fc02cb3a4b2",
"sha256": "6a91e0eab7fe4dfb7c8a82c4b5fc9c2eb58d99c1bfe5daf0bf8c47c4bdc431af"
},
"downloads": -1,
"filename": "sidrapy-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "775adc329d5b2008fe711fc02cb3a4b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7962,
"upload_time": "2022-09-19T22:18:23",
"upload_time_iso_8601": "2022-09-19T22:18:23.619471Z",
"url": "https://files.pythonhosted.org/packages/25/73/58c3024d754c1497bbf25fe7d63cd4b301c9cf8ae47ca4c1c3f8cfc42a82/sidrapy-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-09-19 22:18:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AlanTaranti",
"github_project": "sidrapy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "sidrapy"
}