Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.45 KB

README.md

File metadata and controls

25 lines (16 loc) · 1.45 KB

pyIBGE - a module to access IBGE data

This is a module to access data from IBGE (Brazilian Institute of Geography and Statistics). For now you need to know which table you're looking for and its parameters, this module is merely a way to make this access easier.

Such information can be found at http://api.sidra.ibge.gov.br/, by entering the table ID (which is available in the surveys - census, PNAD, IPCA, the agricultural surveys, the system of national accounts etc...).

Usage:

  • import pyibge
  • use the 'IBGEQuery' object to compose the query. Basically it wants two arguments, table_ID and the parameters string (to pick what variables to use).
  • Its return will be in the 'variables' parameter. The 'name' and the 'value' properties do exactly what they say on the tin.

Examples are available in the 'samples' directory.

It needs requests and lxml but nothing else beyond the standard Python. If you want to run tests you should install nose.

Tested only on Python 3.5 and above. Python 2 or Python 3.[01234] might work, but they will never be supported unless you are willing to provide patches.

Future plans:

  • A more user-friendly interface that allows you to specify which survey and which variable you want.
  • Integration with pandas (for time series) and matplotlib (for direct graphing)

While I work for IBGE, this package is developed in (whatever remains of) my spare time and IBGE can't provide any help relating to it.