geobr: Download Official Spatial Data Sets of Brazil
geobr is a computational package to download official spatial data sets of Brazil. The package includes a wide range of geospatial data in geopackage format (like shapefiles but better), available at various geographic scales and for various years with harmonized attributes, projection and topology (see detailed list of available data sets below).
READ FULL DOCS
Contribute
To start the development environment run
uv sync
Test with
uv run pytest -n auto
You can use a helper to translate a function from R.
If you want to add read_biomes, just run
uv run python helpers/translate_from_R.py read_biomes
It will scrape the original R function to get documentation and metadata. It adds:
- default year
- function name
- documentation one liner
- larger documentation
- very basic tests
! Be aware that if the function that you are adding is more complicated than the template. So, always double check !
System Dependencies
Some functions in geobr require additional system tools to be installed:
For RAR file extraction (read_baze_sites)
This function requires one of the following tools to be installed:
-
unrar:
- macOS:
brew install unrar - Ubuntu/Debian:
sudo apt-get install unrar - Windows: Install WinRAR
- macOS:
-
unar:
- macOS:
brew install unar - Ubuntu/Debian:
sudo apt-get install unar - Windows: Install The Unarchiver
- macOS:
-
7-Zip:
- macOS:
brew install p7zip - Ubuntu/Debian:
sudo apt-get install p7zip-full - Windows: Install 7-Zip
- macOS:
For ZIP file extraction (IBGE files)
Some IBGE files use compression methods not supported by Python's built-in zipfile module. The following functions use the system's unzip command:
read_census_tract_2022read_neighborhoods_2022
Make sure you have the unzip command available on your system:
- macOS: Typically pre-installed
- Ubuntu/Debian:
sudo apt-get install unzip - Windows: Install a tool like 7-Zip or add unzip via WSL
Translation Status
| Function | Translated? | Easy? |
|---|---|---|
| read_amazon | Yes | Super |
| read_biomes | Yes | Super |
| read_census_tract | Yes | No |
| read_comparable_areas | Yes | Yes |
| read_conservation_units | Yes | Super |
| read_country | Yes | Super |
| read_disaster_risk_area | Yes | Super |
| read_health_facilities | Yes | Super |
| read_health_region | Yes | Super |
| read_immediate_region | Yes | Yes |
| read_indigenous_land | Yes | Super |
| read_intermediate_region | Yes | Yes |
| read_meso_region | Yes | No |
| read_metro_area | Yes | Super |
| read_micro_region | Yes | No |
| read_municipal_seat | Yes | Super |
| read_municipality | Yes | No |
| read_region | Yes | Super |
| read_semiarid | Yes | Super |
| read_state | Yes | Super |
| read_statistical_grid | Yes | No |
| read_urban_area | Yes | Super |
| read_urban_concentrations | Yes | Super |
| read_weighting_area | Yes | No |
| list_geobr | Yes | Yes |
| lookup_muni | Yes | No |
| read_neighborhood | Yes | Yes |
Release new version
poetry version [patch|minor|major]
poetry publish --build
1 maintainer
Metadata
1 maintainer
Release files for tunned-geobr 1.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tunned_geobr-1.1.3.tar.gz | 90.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tunned_geobr-1.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 372.8 kB
Release files / tunned_geobr-1.1.3.tar.gz
| Download URL | tunned_geobr-1.1.3.tar.gz |
|---|---|
| Size | 90.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
018c1ff31c8b022051fc580ad63c28380cb0074dd1abc76709cdaca4f9242107
|
|
BLAKE2b-256 checksum How to use checksums |
6a038e25414ff01da8aa898df59418d1c2068bd0192ff55d0a3f7b294641b5d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.23
|
Release files / tunned_geobr-1.1.3-py3-none-any.whl
| Download URL | tunned_geobr-1.1.3-py3-none-any.whl |
|---|---|
| Size | 281.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
27c046a54913b65cdf4cfdaea7b9b44cb092e85bafc6c6674ab034ed49a6ccab
|
|
BLAKE2b-256 checksum How to use checksums |
7173fac5890a776d0616a985f7c187a5270c32a376d282891491a60455859d02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.23
|
