Skip to content

API overview

Public symbols are exported from entie (and re-exported entei-core helpers where noted). Source paths are relative to the repository root.

Top-level (entie)

Symbol Description
connect Build an EntieMongoClient / EntieDatabase from a URI, optional ENTIE_URI, or an existing MongoClient.
EntieMongoClient Thin wrapper around PyMongo’s MongoClient; use database(name) for EntieDatabase.
EntieDatabase Holds a PyMongo Database (not a collection). table / collection return collections.
EnteiDataFrame Lazy, collection-backed frame: from_collection, filter_rows, select, collect.
Records Row-oriented insert helper: from_list, insert_into.
col / column Expression helpers for dataframe-style operations.
lit Literal expression helper.
__version__ Package version string.

Re-exported from entei-core (via entie)

Symbol Description
MongoRoot Columnar root dict[str, list] plus metadata for a Mongo collection snapshot.
materialize_root_data Materialize documents into columnar form.
mongo_root_to_column_dict Convert a MongoRoot to a plain column dict.

Modules (for imports and reading source)

Module Role
entie.client connect, EntieMongoClient, EntieDatabase.
entie.dataframe EnteiDataFrame.
entie.io.records Records.
entie.expressions col, column, lit.
entei_core Core materialization only (also usable without entie).

See also