pyampp.util.demo_notebooks
==========================

.. py:module:: pyampp.util.demo_notebooks

.. autoapi-nested-parse::

   Guardrails and convenience helpers for demo notebook assets.



Attributes
----------

.. autoapisummary::

   pyampp.util.demo_notebooks.REPO_ROOT
   pyampp.util.demo_notebooks.DEMO_NOTEBOOK_ROOT
   pyampp.util.demo_notebooks.PROTECTED_SUFFIXES
   pyampp.util.demo_notebooks.DEFAULT_ALLOW_ENV


Functions
---------

.. autoapisummary::

   pyampp.util.demo_notebooks.is_protected_demo_path
   pyampp.util.demo_notebooks.filter_protected_paths
   pyampp.util.demo_notebooks.git_changed_paths
   pyampp.util.demo_notebooks.check_changed_paths
   pyampp.util.demo_notebooks.copy_demo_bundle
   pyampp.util.demo_notebooks.find_demo_notebooks
   pyampp.util.demo_notebooks.lock_main
   pyampp.util.demo_notebooks.check_main
   pyampp.util.demo_notebooks.launch_main
   pyampp.util.demo_notebooks.main


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

.. py:data:: REPO_ROOT

.. py:data:: DEMO_NOTEBOOK_ROOT

.. py:data:: PROTECTED_SUFFIXES

.. py:data:: DEFAULT_ALLOW_ENV
   :value: 'PYAMPP_ALLOW_DEMO_NOTEBOOK_EDITS'


.. py:function:: is_protected_demo_path(path: str) -> bool

.. py:function:: filter_protected_paths(paths: Iterable[str]) -> list[str]

.. py:function:: git_changed_paths(repo_root: pathlib.Path, *, staged: bool = False, against: str | None = None) -> list[str]

.. py:function:: check_changed_paths(paths: Sequence[str], *, allow_env: str = DEFAULT_ALLOW_ENV) -> list[str]

.. py:function:: copy_demo_bundle(source_root: pathlib.Path, dest_root: pathlib.Path) -> list[pathlib.Path]

.. py:function:: find_demo_notebooks(root: pathlib.Path) -> list[pathlib.Path]

.. py:function:: lock_main(argv: Sequence[str] | None = None) -> int

.. py:function:: check_main(argv: Sequence[str] | None = None) -> int

.. py:function:: launch_main(argv: Sequence[str] | None = None) -> int

.. py:function:: main(argv: Sequence[str] | None = None) -> int