tunned-geobr 0.1.0__tar.gz

tunned_geobr-0.1.0/LICENSE.txt

@@ -0,0 +1,2 @@
+YEAR: 2020
+COPYRIGHT HOLDER: Institute for Appled Economic Research (Ipea)

tunned_geobr-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: tunned-geobr
+Version: 0.1.0
+Summary: Fork personalizado do geobr com funcionalidades extras como download de dados da ANM
+Author: Anderson Stolfi
+License: MIT
+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
+Project-URL: homepage, https://github.com/popogis24/tunned_geobr
+Project-URL: repository, https://github.com/popogis24/tunned_geobr
+Requires-Python: <4.0,>=3.9
+Requires-Dist: geopandas<=1.1,>=1.0.0
+Requires-Dist: shapely<=2.1.0,>=1.7.0
+Requires-Dist: requests<3.0.0,>=2.25.1
+Requires-Dist: lxml<6.0.0,>=5.1.0
+Requires-Dist: html5lib==1.1
+Requires-Dist: geobr<0.3.0,>=0.2.2
+Requires-Dist: patool>=1.15.0
+Description-Content-Type: text/markdown
+
+# geobr: Download Official Spatial Data Sets of Brazil 
+
+<img align="right" src="https://github.com/ipeaGIT/geobr/blob/master/r-package/man/figures/geobr_logo_b.png?raw=true" alt="logo" width="140"> 
+<img align="right" src="https://github.com/ipeaGIT/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/ipeaGIT/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 !
+
+
+
+
+## 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
+```

tunned_geobr-0.1.0/README.md

@@ -0,0 +1,79 @@
+# geobr: Download Official Spatial Data Sets of Brazil 
+
+<img align="right" src="https://github.com/ipeaGIT/geobr/blob/master/r-package/man/figures/geobr_logo_b.png?raw=true" alt="logo" width="140"> 
+<img align="right" src="https://github.com/ipeaGIT/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/ipeaGIT/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 !
+
+
+
+
+## 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
+```

tunned_geobr-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "tunned-geobr"
+version = "0.1.0"
+description = "Fork personalizado do geobr com funcionalidades extras como download de dados da ANM"
+readme = "README.md"
+requires-python = "<4.0,>=3.9"
+authors = [
+    { name = "Anderson Stolfi" },
+]
+dependencies = [
+    "geopandas>=1.0.0,<=1.1",
+    "shapely>=1.7.0,<=2.1.0",
+    "requests<3.0.0,>=2.25.1",
+    "lxml<6.0.0,>=5.1.0",
+    "html5lib==1.1",
+    "geobr>=0.2.2,<0.3.0",
+    "patool>=1.15.0",
+]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Programming Language :: Python",
+]
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+homepage = "https://github.com/popogis24/tunned_geobr"
+repository = "https://github.com/popogis24/tunned_geobr"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm.build]
+includes = [
+    "tunned_geobr",
+]
+excludes = [
+    "**/*.gpkg",
+]
+
+[tool.black]
+line-length = 88
+target-version = [
+    "py37",
+]
+include = "\\.pyi?$"
+exclude = "\n(\n  /(\n      \\.eggs         # exclude a few common directories in the\n    | \\.git          # root of the project\n    | \\.hg\n    | \\.mypy_cache\n    | \\.tox\n    | \\.venv\n    | _build\n    | buck-out\n    | build\n    | dist\n  )/\n  | helpers/template\n)\n"
+
+[tool.uv]
+dev-dependencies = [
+    "pytest<7.0,>=6.0",
+    "pytest-xdist>=3.5.0",
+    "jinja2<4.0.0,>=3.1.4",
+    "fire<1.0.0,>=0.5.0",
+]

tunned_geobr-0.1.0/tests/read_state.py

@@ -0,0 +1,112 @@
+import requests
+import geopandas as gpd
+import pandas as pd
+import os
+import tempfile
+import sys
+import fiona
+
+
+def read_state(code_state, year=None, mode="simplified"):
+
+    # Get metadata with data addresses
+    metadata = download_metadata()
+
+    # Select geo
+    temp_meta = metadata.query('geo=="uf"')
+
+    # Select mode
+    if mode == "simplified":
+        temp_meta = temp_meta[temp_meta["download_path"].str.contains("simplified")]
+    elif mode == "normal":
+        temp_meta = temp_meta[~temp_meta["download_path"].str.contains("simplified")]
+    else:
+        print("not a valid argument for mode")
+
+    # Verify year input
+    if year is None:
+        print("Using data from year 2010\n")
+        year = 2010
+        temp_meta = temp_meta[temp_meta.year == 2010]
+    elif year in temp_meta.year.unique():
+        temp_meta = temp_meta[temp_meta.year == year]
+    else:
+        print(
+            "Error: Invalid Value to argument 'year'. It must be one of the following: ",
+            temp_meta["year"].unique(),
+        )
+        sys.exit()
+
+    # BLOCK 2.1 From 1872 to 1991  ----------------------------
+    if year < 1992:
+        if code_mun is None:
+            sys.exit("Value to argument 'code_state' cannot be NULL")
+        print("Loading data for the whole country\n")
+
+        # list paths of files to download
+        filesD = temp_meta.download_path.astype(str)
+
+        temp_sf = gpd.read_file(filesD.iloc[0])
+
+        return temp_sf
+
+    else:
+        # BLOCK 2.2 From 2000 onwards  ----------------------------
+
+        # Verify code_state input
+
+        # Test if code_state input is null
+        if code_state is None:
+            sys.exit("Value to argument 'code_state' cannot be NULL")
+
+        if code_state == "all":
+            print("Loading data for the whole country\n")
+
+            # read files and pile them up
+
+            filesD = list(temp_meta.download_path.astype(str))
+
+            temp_sf = list()
+
+            for fp in filesD:
+
+                gdf = gpd.read_file(fp)
+
+                temp_sf.append(gdf)
+
+            temp_sf = gpd.GeoDataFrame(pd.concat(temp_sf, ignore_index=True))
+
+            return temp_sf
+
+        if (str(code_state)[0:2] not in temp_meta.code.unique()) and (
+            str(code_state)[0:2] not in temp_meta.code_abbrev.unique()
+        ):
+
+            sys.exit("Error: Invalid Value to argument code_state.")
+        else:
+
+            # list paths of files to download
+
+            if isinstance(code_state, int):
+
+                filesD = temp_meta[
+                    temp_meta.code == str(code_state)[0:2]
+                ].download_path.iloc[0]
+
+            if isinstance(code_state, str):
+
+                filesD = temp_meta[
+                    temp_meta.code_abbrev == str(code_state)[0:2]
+                ].download_path.iloc[0]
+
+            # download files
+
+            temp_sf = gpd.read_file(filesD)
+
+            if len(str(code_state)) == 2:
+
+                return temp_sf
+
+            else:
+
+                sys.exit("Error: Invalid Value to argument code_state.")

tunned_geobr-0.1.0/tests/test_list_geobr.py

@@ -0,0 +1,8 @@
+from geobr import list_geobr
+
+
+def test_list_geobr(capsys):
+    list_geobr()
+    # Tests whether the function prints output
+    captured = capsys.readouterr()
+    assert len(captured.out) > 200

tunned_geobr-0.1.0/tests/test_lookup_muni.py

@@ -0,0 +1,24 @@
+import pandas as pd
+import pytest
+from geobr.lookup_muni import lookup_muni
+
+
+def test_lookup_muni():
+    # Check it is DataFrame object
+
+    assert isinstance(lookup_muni(name_muni="fortaleza"), pd.DataFrame)
+    assert isinstance(lookup_muni(code_muni=2304400), pd.DataFrame)
+    assert isinstance(lookup_muni(name_muni="all"), pd.DataFrame)
+    assert isinstance(lookup_muni(code_muni="all"), pd.DataFrame)
+    assert isinstance(lookup_muni(), pd.DataFrame)
+
+    # Check number of columns
+    df = lookup_muni(name_muni="rio de janeiro")
+    assert len(df.columns) == 13
+
+    assert len(lookup_muni()) > len(lookup_muni(code_muni=2304400))
+
+    # When using two arguments (supposed to give a warning)
+    with pytest.raises(Exception):
+        lookup_muni(code_muni=9999999)
+        lookup_muni(name_muni="alem paraiba do longinquo caminho curto")

tunned_geobr-0.1.0/tests/test_read_amazon.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_amazon
+
+
+def test_read_amazon():
+
+    assert isinstance(read_amazon(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_amazon(year=9999999)

tunned_geobr-0.1.0/tests/test_read_biomes.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_biomes
+
+def test_read_biomes():
+
+    assert isinstance(read_biomes(), 
+                      gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_biomes(year=9999999)

tunned_geobr-0.1.0/tests/test_read_census_tract.py

@@ -0,0 +1,42 @@
+import geopandas as gpd
+import pytest
+from geobr import read_census_tract
+
+
+def test_read_census_tract():
+
+    assert isinstance(
+        read_census_tract(code_tract=11, zone="rural", year=2000),
+        gpd.geodataframe.GeoDataFrame,
+    )
+    assert isinstance(
+        read_census_tract(code_tract="AC", zone="rural", year=2000),
+        gpd.geodataframe.GeoDataFrame,
+    )
+    assert isinstance(
+        read_census_tract(code_tract="AP", zone="rural"), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_census_tract(code_tract=11, zone="urban", year=2000),
+        gpd.geodataframe.GeoDataFrame,
+    )
+    assert isinstance(
+        read_census_tract(code_tract="AP", zone="urban", year=2000),
+        gpd.geodataframe.GeoDataFrame,
+    )
+    assert isinstance(
+        read_census_tract(code_tract="AP", zone="urban", year=2010),
+        gpd.geodataframe.GeoDataFrame,
+    )
+    assert isinstance(
+        read_census_tract(code_tract="all", year=2000), gpd.geodataframe.GeoDataFrame
+    )
+
+    with pytest.raises(Exception):
+
+        read_census_tract(year=9999999)
+        read_census_tract(code_tract="AP", year=2000, zone="ABCD")
+
+        read_census_tract(code_tract=None)
+        read_census_tract(code_tract="AC_ABCD")
+        read_census_tract()

tunned_geobr-0.1.0/tests/test_read_comparable_areas.py

@@ -0,0 +1,14 @@
+import geopandas as gpd
+import pytest
+from geobr import read_comparable_areas
+
+
+def test_read_comparable_areas():
+
+    assert isinstance(read_comparable_areas(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_comparable_areas(year=9999999)
+        read_comparable_areas(12323423, 2010)
+
+    assert isinstance(read_comparable_areas(2000, 2010), gpd.geodataframe.GeoDataFrame)

tunned_geobr-0.1.0/tests/test_read_conservation_units.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_conservation_units
+
+
+def test_read_conservation_units():
+
+    assert isinstance(read_conservation_units(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_conservation_units(year=9999999)

tunned_geobr-0.1.0/tests/test_read_country.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_country
+
+
+def test_read_country():
+
+    assert isinstance(read_country(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_country(year=9999999)

tunned_geobr-0.1.0/tests/test_read_disaster_risk_area.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_disaster_risk_area
+
+
+def test_read_disaster_risk_area():
+
+    assert isinstance(read_disaster_risk_area(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_disaster_risk_area(year=9999999)

tunned_geobr-0.1.0/tests/test_read_health_facilities.py

@@ -0,0 +1,18 @@
+import geopandas as gpd
+import pytest
+from geobr import read_health_facilities
+
+
+def test_read_health_facilities():
+
+    df = read_health_facilities()
+
+    assert isinstance(df, gpd.geodataframe.GeoDataFrame)
+
+    assert len(df) == 517629
+
+    with pytest.raises(Exception):
+        read_health_facilities(year=9999999)
+
+    with pytest.raises(Exception):
+        read_health_facilities(year="banana")

tunned_geobr-0.1.0/tests/test_read_health_region.py

@@ -0,0 +1,19 @@
+import geopandas as gpd
+import pytest
+from geobr import read_health_region
+
+
+def test_read_health_region():
+
+    assert isinstance(read_health_region(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_health_region(year=9999999)
+
+
+def test_read_health_region_macro():
+
+    assert isinstance(read_health_region(macro=True), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_health_region(year=9999999)

tunned_geobr-0.1.0/tests/test_read_immediate_region.py

@@ -0,0 +1,18 @@
+import geopandas as gpd
+import pytest
+from geobr import read_immediate_region
+
+
+def test_read_immediate_region():
+
+    assert isinstance(read_immediate_region(), gpd.geodataframe.GeoDataFrame)
+
+    assert isinstance(
+        read_immediate_region(code_immediate="AC"), gpd.geodataframe.GeoDataFrame
+    )
+
+    assert len(read_immediate_region(code_immediate=110002).columns) == 8
+
+    with pytest.raises(Exception):
+        read_immediate_region(year=9999999)
+        read_immediate_region(code_intermediate=5201108312313213)

tunned_geobr-0.1.0/tests/test_read_indigenous_land.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_indigenous_land
+
+
+def test_read_indigenous_land():
+
+    assert isinstance(read_indigenous_land(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_indigenous_land(year=9999999)

tunned_geobr-0.1.0/tests/test_read_intermediate_region.py

@@ -0,0 +1,16 @@
+import geopandas as gpd
+import pytest
+from geobr import read_intermediate_region
+
+
+def test_read_intermediate_region():
+
+    assert isinstance(read_intermediate_region(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_intermediate_region(year=9999999)
+        read_intermediate_region(12323423535)
+
+    assert len(read_intermediate_region("SP")) > 0
+
+    assert len(read_intermediate_region(1101)) > 0

tunned_geobr-0.1.0/tests/test_read_meso_region.py

@@ -0,0 +1,26 @@
+import geopandas as gpd
+import pytest
+from geobr import read_meso_region
+
+
+def test_read_meso_region():
+
+    assert isinstance(read_meso_region(), gpd.geodataframe.GeoDataFrame)
+
+    assert isinstance(read_meso_region(code_meso=1401), gpd.geodataframe.GeoDataFrame)
+    assert isinstance(
+        read_meso_region(code_meso="AC", year=2010), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_meso_region(code_meso=11, year=2010), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_meso_region(code_meso="all", year=2010), gpd.geodataframe.GeoDataFrame
+    )
+
+    with pytest.raises(Exception):
+        read_meso_region(year=9999999)
+
+        read_meso_region(code_meso=5201108312313213)
+
+        read_meso_region(code_meso=9999999, year=9999999)

tunned_geobr-0.1.0/tests/test_read_metro_area.py

@@ -0,0 +1,11 @@
+import geopandas as gpd
+import pytest
+from geobr import read_metro_area
+
+
+def test_read_metro_area():
+
+    assert isinstance(read_metro_area(), gpd.geodataframe.GeoDataFrame)
+
+    with pytest.raises(Exception):
+        read_metro_area(year=9999999)

tunned_geobr-0.1.0/tests/test_read_micro_region.py

@@ -0,0 +1,25 @@
+import geopandas as gpd
+import pytest
+from geobr import read_micro_region
+
+
+def test_read_micro_region():
+
+    assert isinstance(
+        read_micro_region(code_micro=11008), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_micro_region(code_micro="AC", year=2010), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_micro_region(code_micro=11, year=2010), gpd.geodataframe.GeoDataFrame
+    )
+    assert isinstance(
+        read_micro_region(code_micro="all", year=2010), gpd.geodataframe.GeoDataFrame
+    )
+
+    with pytest.raises(Exception):
+
+        read_micro_region(year=9999999)
+
+        read_micro_region(code_micro=9999999)