expdpy.streamlit_app

Full source of expdpy.streamlit_app — src/expdpy/streamlit_app/__init__.py on GitHub. Each top-level definition is anchored; reach it from the source link on a reference page.

"""The ExPdPy interactive apps, built with Streamlit.

expdpy ships **three** no-code apps — one per module — that build a multipage UI on top of
the library's ``explore_*`` / ``analyze_*`` / ``learn_*`` functions:

* :func:`ExploreApp` — exploratory data analysis (tables, distributions, trends, scatter…),
* :func:`AnalyzeApp` — panel estimators (regression, FWL, panel models, CRE, event study…),
* :func:`LearnApp` — the teaching layer (concept sandboxes and explainers).

All three share the same shell (data upload, the analysis-sample pipeline, config save/load
and reproducible notebook export) and differ only in which pages they expose. Because
Streamlit runs as its own process, each launcher serializes the data you pass to a temporary
bundle and starts ``streamlit run`` in a subprocess (see
:mod:`expdpy.streamlit_app._launcher`), tagging it with the module via the
``EXPDPY_MODULE`` environment variable. The app body is
:func:`expdpy.streamlit_app._entry.run_app`.
"""

from __future__ import annotations

from collections.abc import Sequence
from typing import Any

import pandas as pd

__all__ = [
    "ExploreApp",
    "AnalyzeApp",
    "LearnApp",
    "main_explore",
    "main_analyze",
    "main_learn",
]

_DEFAULT_TITLES = {
    "explore": "ExPdPy — Explore your data!",
    "analyze": "ExPdPy — Analyze your panel!",
    "learn": "ExPdPy — Learn the methods!",
}

_launch

def _launch(
    module: str,
    df: Any = None,
    entity: Sequence[str] | str | None = None,
    time: str | None = None,
    df_def: pd.DataFrame | None = None,
    var_def: pd.DataFrame | None = None,
    config_list: dict | None = None,
    *,
    title: str | None = None,
    df_name: str | Sequence[str] | None = None,
    components: Any = None,
    factor_cutoff: int = 10,
    export_nb_option: bool = True,
    save_settings_option: bool = True,
    run: bool = True,
    **run_kwargs: Any,
) -> Any:
    """Launch (or describe) one module's ExPdPy app — the shared engine behind the three."""
    # The panel identifiers were renamed in 0.4.1; reject the old names with a clear message
    # rather than silently swallowing them into the Streamlit server kwargs.
    for legacy, new in (("cs_id", "entity"), ("ts_id", "time")):
        if legacy in run_kwargs:
            raise TypeError(
                f"{legacy!r} is no longer accepted — use {new!r} instead "
                "(renamed in expdpy 0.4.1)"
            )
    from expdpy.streamlit_app import _handoff as handoff
    from expdpy.streamlit_app import _launcher

    samples = handoff.normalize_samples(df, df_name)
    entities, time = handoff.resolve_ids(df_def, entity, time)
    return _launcher.launch(
        samples,
        df_def=df_def,
        var_def=var_def,
        entities=entities,
        time=time,
        components=components,
        factor_cutoff=factor_cutoff,
        title=title or _DEFAULT_TITLES[module],
        export_nb_option=export_nb_option,
        save_settings_option=save_settings_option,
        base_cfg=dict(config_list) if config_list else {},
        module=module,
        run=run,
        **run_kwargs,
    )

ExploreApp

↩︎ docs

def ExploreApp(df: Any = None, *args: Any, **kwargs: Any) -> Any:
    """Launch the **Explore** app — exploratory analysis of panel / cross-sectional data.

    Same parameters as the other launchers (``df``, ``entity``, ``time``, ``df_def``,
    ``var_def``, ``config_list``, ``title``, ``components``, server ``run_kwargs`` …); see
    the module docstring. ``entity`` (the cross-section/unit id) may be a string or a list;
    ``time`` is the time id. Pass a :class:`pandas.DataFrame` (or ``None`` for the dataset
    picker / upload dialog).
    """
    return _launch("explore", df, *args, **kwargs)

AnalyzeApp

↩︎ docs

def AnalyzeApp(df: Any = None, *args: Any, **kwargs: Any) -> Any:
    """Launch the **Analyze** app — panel estimators, panel models, CRE and event studies."""
    return _launch("analyze", df, *args, **kwargs)

LearnApp

↩︎ docs

def LearnApp(df: Any = None, *args: Any, **kwargs: Any) -> Any:
    """Launch the **Learn** app — concept sandboxes and the explainer index."""
    return _launch("learn", df, *args, **kwargs)

main_explore

def main_explore() -> None:
    """Console entry point (``expdpy-explore``): launch the Explore app."""
    ExploreApp(run=True)

main_analyze

def main_analyze() -> None:
    """Console entry point (``expdpy-analyze``): launch the Analyze app."""
    AnalyzeApp(run=True)

main_learn

def main_learn() -> None:
    """Console entry point (``expdpy-learn``): launch the Learn app."""
    LearnApp(run=True)