pipeline.src.flows.fao_areas
============================

.. py:module:: pipeline.src.flows.fao_areas


Functions
---------

.. autoapisummary::

   pipeline.src.flows.fao_areas.extract_fao_areas
   pipeline.src.flows.fao_areas.transform_fao_areas
   pipeline.src.flows.fao_areas.load_fao_areas
   pipeline.src.flows.fao_areas.fao_areas_flow


Module Contents
---------------

.. py:function:: extract_fao_areas(url: str, proxies: dict) -> geopandas.GeoDataFrame

   Download shapefile of FAO areas and load to GeoDataFrame.

   :param url: url to fetch the shapefile from
   :type url: str
   :param proxies: http and https proxies to use for the download.
   :type proxies: dict

   :returns: GeoDataFrame of FAO areas
   :rtype: gpd.GeoDataFrame


.. py:function:: transform_fao_areas(fao_areas: geopandas.GeoDataFrame) -> geopandas.GeoDataFrame

   Transforms the ``fao_areas`` DataFrame to match the desired table columns.


.. py:function:: load_fao_areas(fao_areas: geopandas.GeoDataFrame)

.. py:function:: fao_areas_flow(url: str = FAO_AREAS_URL, proxies: dict = PROXIES, extract_fao_areas_fn: prefect.Task = extract_fao_areas)