[](https://doi.org/10.5281/zenodo.13958863)
# pofium
Pacote para baixar, carregar e salvar os microdados da Pesquisa de Orçamentos Familiares (POF) - Atualmente somente para a POF 2017/2018.
A Pesquisa de Orçamentos Familiares (POF) tem seus microdados disponibilizados em arquivos de coluna por largura fixa, em formato `.txt`. Este pacote visa automatizar o processo de download e criação de DataFrames utilizando o Pandas. Ao fim, os DataFrames de cada questionário são salvos em formato `.parquet` no diretório de trabalho que o usuário estiver utilizando.
## Instalação
`pip install pofium`
## Uso
### Para importar o pacote:
`import pofium`
### Para realizar o download e salvar os DataFrames:
`pofium.download()`
### Para consultar variáveis pelo código ou descrição:
`pofium.consulta_var(cod='código', desc='parte da descrição buscada', d=int)`
- Utilize **um** dos parâmetros de busca (`cod` ou `desc`).
- O parâmetro `d` é **obrigatório** e corresponde ao número do questionário cujo dicionário de variáveis será alvo da consulta.
- Caso tenha dúvidas, basta rodar a função sem qualquer parâmetro:
`pofium.consulta_var()`
A resposta será a lista dos questionários e seus respectivos números.
### Para consultar as características de uma variável:
`pofium.descreva_var(cod='código', d=int)`
O retorno será as características da variável (se indica categorias e quais são). Se o retorno for nulo, a variável não tem características descritas no dicionário disponibilizado pelo IBGE.
## Contribuições
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.
Raw data
{
"_id": null,
"home_page": "https://github.com/ggximenez/pofium",
"name": "pofium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Gustavo G. Ximenez",
"author_email": "ggximenez@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/34/c1/fe633a6ab9edb59f8703a02e33dec927af372578a96d51a5fa29d7e505d6/pofium-0.1.8.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.13958863)\n\n# pofium\n\nPacote para baixar, carregar e salvar os microdados da Pesquisa de Or\u00e7amentos Familiares (POF) - Atualmente somente para a POF 2017/2018.\n\nA Pesquisa de Or\u00e7amentos Familiares (POF) tem seus microdados disponibilizados em arquivos de coluna por largura fixa, em formato `.txt`. Este pacote visa automatizar o processo de download e cria\u00e7\u00e3o de DataFrames utilizando o Pandas. Ao fim, os DataFrames de cada question\u00e1rio s\u00e3o salvos em formato `.parquet` no diret\u00f3rio de trabalho que o usu\u00e1rio estiver utilizando.\n\n## Instala\u00e7\u00e3o\n\n`pip install pofium`\n\n## Uso\n\n### Para importar o pacote:\n\n`import pofium`\n\n### Para realizar o download e salvar os DataFrames:\n\n`pofium.download()`\n\n### Para consultar vari\u00e1veis pelo c\u00f3digo ou descri\u00e7\u00e3o:\n\n`pofium.consulta_var(cod='c\u00f3digo', desc='parte da descri\u00e7\u00e3o buscada', d=int)`\n\n- Utilize **um** dos par\u00e2metros de busca (`cod` ou `desc`).\n- O par\u00e2metro `d` \u00e9 **obrigat\u00f3rio** e corresponde ao n\u00famero do question\u00e1rio cujo dicion\u00e1rio de vari\u00e1veis ser\u00e1 alvo da consulta.\n- Caso tenha d\u00favidas, basta rodar a fun\u00e7\u00e3o sem qualquer par\u00e2metro:\n\n`pofium.consulta_var()`\n\nA resposta ser\u00e1 a lista dos question\u00e1rios e seus respectivos n\u00fameros.\n\n### Para consultar as caracter\u00edsticas de uma vari\u00e1vel:\n\n`pofium.descreva_var(cod='c\u00f3digo', d=int)`\n\nO retorno ser\u00e1 as caracter\u00edsticas da vari\u00e1vel (se indica categorias e quais s\u00e3o). Se o retorno for nulo, a vari\u00e1vel n\u00e3o tem caracter\u00edsticas descritas no dicion\u00e1rio disponibilizado pelo IBGE.\n\n## Contribui\u00e7\u00f5es\n\nContribui\u00e7\u00f5es s\u00e3o bem-vindas! Sinta-se \u00e0 vontade para abrir issues ou enviar pull requests.\n",
"bugtrack_url": null,
"license": null,
"summary": "Pacote para download e processamento dos microdados da POF do IBGE.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/ggximenez/pofium"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37e70eebff53a8b18eb12302c4add5c70cd58e402cdf3f8582a977a1c3bc6de7",
"md5": "36b7303049875eef454163a73c98f5f6",
"sha256": "d5aecf0594b4f4ce6d633a225aba34fba057a69b506014b42c15a3f690cc79d6"
},
"downloads": -1,
"filename": "pofium-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36b7303049875eef454163a73c98f5f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6338,
"upload_time": "2024-10-21T16:42:05",
"upload_time_iso_8601": "2024-10-21T16:42:05.791812Z",
"url": "https://files.pythonhosted.org/packages/37/e7/0eebff53a8b18eb12302c4add5c70cd58e402cdf3f8582a977a1c3bc6de7/pofium-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "34c1fe633a6ab9edb59f8703a02e33dec927af372578a96d51a5fa29d7e505d6",
"md5": "54b69c543ce526bd1072d24174d3bd82",
"sha256": "121fbce85b0074c01a60958ba3ac5eb88289efebf04024b2e69dab2778ad8642"
},
"downloads": -1,
"filename": "pofium-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "54b69c543ce526bd1072d24174d3bd82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5957,
"upload_time": "2024-10-21T16:42:06",
"upload_time_iso_8601": "2024-10-21T16:42:06.564285Z",
"url": "https://files.pythonhosted.org/packages/34/c1/fe633a6ab9edb59f8703a02e33dec927af372578a96d51a5fa29d7e505d6/pofium-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 16:42:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ggximenez",
"github_project": "pofium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pofium"
}
JSON
