leaf_engine.etl.transform
=========================

.. py:module:: leaf_engine.etl.transform

.. autoapi-nested-parse::

   Functions to transform the shipments DataFrame.

   Includes functions for transforming the shipments DataFrame output by
   the ETL pipeline into DataFrames that can be inserted into the analytics
   DB via the API.



Functions
---------

.. autoapisummary::

   leaf_engine.etl.transform.to_execution_graph_shipments
   leaf_engine.etl.transform.to_graph_lanes
   leaf_engine.etl.transform.to_locations
   leaf_engine.etl.transform.to_raw_lanes
   leaf_engine.etl.transform.to_raw_shipments
   leaf_engine.etl.transform.to_records


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

.. py:function:: to_execution_graph_shipments(shipments_df: pandas.DataFrame)

   Transforms execution shipments to fit execution graph data model.

   :param shipments_df: DataFrame containing execution shipments.
   :type shipments_df: pd.DataFrame
   :param See `analytics.v_execution_shipment`.:

   :returns: DataFrame with columns that fit the graph data model.
   :rtype: pd.DataFrame


.. py:function:: to_graph_lanes(lanes_df: pandas.DataFrame) -> pandas.DataFrame

   Transforms company network lanes to fit graph data model.

   :param lanes_df: DataFrame generated by calling the Postgres function
   :type lanes_df: pd.DataFrame
   :param `analytics.get_company_network_lanes`. See LeafCRUDCaller.get_company_network_lanes.:

   :returns: DataFrame with columns that fit the graph data model.
   :rtype: pd.DataFrame


.. py:function:: to_locations(df: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: to_raw_lanes(df: pandas.DataFrame, company_id: int, batch_date: str, record_type: str, db_cols: List[str]) -> pandas.DataFrame

.. py:function:: to_raw_shipments(df: pandas.DataFrame, company_id: int, batch_date: str, record_type: str, db_cols: List[str]) -> pandas.DataFrame

.. py:function:: to_records(df: pandas.DataFrame) -> List[dict]

   Transforms a DataFrame to a list of dictionaries.

   Removes all non-null/inf values.