switch to pdoc3

Author: JohnMount

data_algebra_dev_env.yaml

@@ -25,7 +25,7 @@ dependencies:
   - pylint
   - pip
   - pip:
-    - pdoc
+    - pdoc3
     - google.cloud
     - google-cloud-bigquery
     - db_dtypes

docs/data_algebra.html

@@ -0,0 +1,54 @@
+Module data_algebra.BigQuery
+============================
+Adapter for Google BigQuery database
+
+Functions
+---------
+
+    
+`example_handle()`
+:   Return an example db handle for testing. Returns None if helper packages not present.
+    Note: binds in a data_catalog and data schema prefix. So this handle is specific
+    to one database.
+
+Classes
+-------
+
+`BigQueryModel(*, table_prefix: Optional[str] = None)`
+:   A model of how SQL should be generated for BigQuery
+    connection should be google.cloud.bigquery.client.Client
+
+    ### Ancestors (in MRO)
+
+    * data_algebra.db_model.DBModel
+    * data_algebra.shift_pipe_action.ShiftPipeAction
+    * abc.ABC
+    * data_algebra.sql_model.SQLModel
+
+    ### Methods
+
+    `get_table_name(self, table_description)`
+    :
+
+`BigQuery_DBHandle(*, db_model=BigQueryModel, conn)`
+:   Container for database connection handles.
+    
+    Represent a db connection.
+    
+    :param db_model: associated database model
+    :param conn: database connection
+    :param db_engine: optional sqlalchemy style engine (for closing)
+
+    ### Ancestors (in MRO)
+
+    * data_algebra.db_model.DBHandle
+    * data_algebra.shift_pipe_action.ShiftPipeAction
+    * abc.ABC
+
+    ### Methods
+
+    `describe_bq_table(self, *, table_catalog, table_schema, table_name, row_limit=7) ‑> data_algebra.data_ops.TableDescription`
+    :
+
+    `query_to_csv(self, q, *, res_name) ‑> None`
+    :   Write query to csv

docs/data_algebra/BigQuery.html

@@ -0,0 +1,24 @@
+Module data_algebra.MySQL
+=========================
+Partial adapter of data algebra for MySQL. Not all data algebra operations are supported on this database at this time.
+
+Functions
+---------
+
+    
+`example_handle()`
+:   Return an example db handle for testing. Returns None if helper packages not present.
+
+Classes
+-------
+
+`MySQLModel()`
+:   A model of how SQL should be generated for MySQL.
+    Assuming we are using a sqlalchemy engine as our connection.
+
+    ### Ancestors (in MRO)
+
+    * data_algebra.db_model.DBModel
+    * data_algebra.shift_pipe_action.ShiftPipeAction
+    * abc.ABC
+    * data_algebra.sql_model.SQLModel

docs/data_algebra/BigQuery.md

@@ -0,0 +1,83 @@
+Module data_algebra.OrderedSet
+==============================
+Ordered set to enhance presentation of column names.
+
+Adapted from: https://stackoverflow.com/a/1653978
+
+Functions
+---------
+
+    
+`ordered_diff(a: collections.abc.Iterable, b: collections.abc.Iterable) ‑> data_algebra.OrderedSet.OrderedSet`
+:   a with b removed, a order preserved.
+
+    
+`ordered_intersect(a: collections.abc.Iterable, b: collections.abc.Iterable) ‑> data_algebra.OrderedSet.OrderedSet`
+:   Intersection of two iterables, ordered by a.
+
+    
+`ordered_union(a: collections.abc.Iterable, b: collections.abc.Iterable) ‑> data_algebra.OrderedSet.OrderedSet`
+:   Union of two iterables, ordered by a first, then b.
+
+Classes
+-------
+
+`OrderedSet(v: Optional[collections.abc.Iterable] = None)`
+:   Ordered set to enhance presentation of column names.
+
+    ### Ancestors (in MRO)
+
+    * collections.abc.MutableSet
+    * collections.abc.Set
+    * collections.abc.Collection
+    * collections.abc.Sized
+    * collections.abc.Iterable
+    * collections.abc.Container
+
+    ### Class variables
+
+    `impl: collections.OrderedDict`
+    :
+
+    ### Instance variables
+
+    `difference`
+    :
+
+    `difference_update`
+    :
+
+    `intersection`
+    :
+
+    `intersection_update`
+    :
+
+    `issubset`
+    :
+
+    `issuperset`
+    :
+
+    `symmetric_difference`
+    :
+
+    `symmetric_difference_update`
+    :
+
+    ### Methods
+
+    `add(self, elem)`
+    :   add an element
+
+    `copy(self)`
+    :
+
+    `discard(self, elem)`
+    :   delete an element
+
+    `union(self, *args)`
+    :   create new set union
+
+    `update(self, *args, **kwargs)`
+    :   add/replace elements

docs/data_algebra/MySQL.html

@@ -0,0 +1,14 @@
+Module data_algebra.PolarsSQL
+=============================
+Polars SQL adapter for data algebra.
+
+Classes
+-------
+
+`PolarsSQLModel()`
+:   A model of how SQL should be generated for PolarsSQL.
+    Model is just a stand-in for now, as we don't have a good description of Polars SQL dialect yet.
+
+    ### Ancestors (in MRO)
+
+    * data_algebra.sql_model.SQLModel