Metadata-Version: 2.4
Name: geobr
Version: 1.0.0
Summary: geobr: Download Official Spatial Data Sets of Brazil
Author: João Carabetta, Rafael H. M. Pereira, Camila Gonçalves de Brito, Rogério Jerônimo Barbosa, Caio Nogueira Goncalves, Bernardo Furtado
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: homepage, https://github.com/ipea/geobr
Project-URL: repository, https://github.com/ipea/geobr
Requires-Python: <4.0,>=3.10
Requires-Dist: geopandas<=1.1.2,>=1.0.0
Requires-Dist: shapely<=2.1.0,>=1.7.0
Requires-Dist: requests<3.0.0,>=2.25.1
Requires-Dist: urllib3<3.0.0,>=1.26.0
Requires-Dist: lxml<7.0.0,>=5.1.0
Requires-Dist: html5lib==1.1
Requires-Dist: pyarrow>=15.0.0
Requires-Dist: duckdb>=1.5.3
Requires-Dist: rapidfuzz>=3.0
Description-Content-Type: text/markdown

# geobr: Download Official Spatial Data Sets of Brazil 

<img align="right" src="https://github.com/ipea/geobr/blob/master/r-package/man/figures/geobr_logo_b.png?raw=true" alt="logo" width="140"> 
<img align="right" src="https://github.com/ipea/geobr/blob/master/r-package/man/figures/geobr_logo_y.png?raw=true" alt="logo" width="140">
<p align="justify">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). </p> 

## [READ FULL DOCS](https://github.com/ipea/geobr)

## Contribute

To start the development environment run

```sh
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

```sh
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 !

# Release new version

1. Update `version` in `pyproject.toml` and the `CHANGELOG.md`.
2. Commit and push to `master`.
3. Tag the release (the `python-v` prefix avoids conflicts with R package tags):

```sh
git tag python-v1.0.0
git push origin python-v1.0.0
```

4. The `Python-publish-PyPI` workflow will automatically build, test, and upload to PyPI.
