memoryframes 0.4.0__tar.gz → 0.5.0__tar.gz

{memoryframes-0.4.0 → memoryframes-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: memoryframes
-Version: 0.4.0
+Version: 0.5.0
 Summary: Add your description here
 Author: David Brownell
 Author-email: David Brownell <github@DavidBrownell.com>
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: dbrownell-common>=0.16.0
 Requires-Dist: pluggy>=1.6.0
 Requires-Dist: python-frontmatter>=1.1.0
+Requires-Dist: rtyaml>=1.0.0
 Requires-Dist: textual>=6.8.0
 Requires-Dist: typer>=0.20.0
 Requires-Dist: typer-config>=1.4.3

{memoryframes-0.4.0 → memoryframes-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "MemoryFrames"
-version = "0.4.0"
+version = "0.5.0"
 #          ^^^^^
 # Wheel names will be generated according to this value. Do not manually modify this value; instead
 # update it according to committed changes by running this command from the root of the repository:
@@ -17,6 +17,7 @@ dependencies = [
     "dbrownell-common>=0.16.0",
     "pluggy>=1.6.0",
     "python-frontmatter>=1.1.0",
+    "rtyaml>=1.0.0",
     "textual>=6.8.0",
     "typer>=0.20.0",
     "typer-config>=1.4.3",
@@ -32,6 +33,9 @@ classifiers = [
 [project.license]
 text = "MIT"
 
+[project.scripts]
+memoryframes = "MemoryFrames.__main__:app"
+
 [project.urls]
 Homepage = "https://github.com/davidbrownell/MemoryFrames"
 Documentation = "https://github.com/davidbrownell/MemoryFrames"
@@ -47,6 +51,7 @@ dev = [
     "dbrownell-commitemojis>=0.2.0",
     "pre-commit>=4.5.0",
     "py-minisign>=0.13.0",
+    "pyfakefs>=5.10.2",
     "pytest>=9.0.2",
     "pytest-cov>=7.0.0",
     "ruff>=0.14.9",

{memoryframes-0.4.0 → memoryframes-0.5.0}/src/MemoryFrames/PluginInfra/Plugin.py

@@ -1,7 +1,6 @@
-from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import ClassVar, TYPE_CHECKING
 
 import pluggy
 
@@ -31,14 +30,31 @@ class ThreadInfo:
 
 
 # ----------------------------------------------------------------------
-class Plugin(ABC):
+class Plugin:
     """Base class for all MemoryFrames plugins."""
 
+    # ----------------------------------------------------------------------
+    NAME: ClassVar[str] = ""
+    """The name of the plugin."""
+
+    AUTHOR: ClassVar[str] = ""
+    """The author of the plugin. This value will be used in the plugin's unique name."""
+
+    DESCRIPTION: ClassVar[str] = ""
+    """The description of the plugin."""
+
+    PLUGIN_PRIORITY: ClassVar[int] = 0
+    """The priority of the plugin. Higher values indicate higher priority, which will cause the plugin to appear before other lower priority plugins."""
+
     # ----------------------------------------------------------------------
     def __init__(
         self,
         root_data_dir: Path,
     ) -> None:
+        assert self.__class__.NAME, "Derived classes must set the NAME class variable"
+        assert self.__class__.AUTHOR, "Derived classes must set the AUTHOR class variable"
+        assert self.__class__.DESCRIPTION, "Derived classes must set the DESCRIPTION class variable"
+
         scrubbed_unique_name = self.unique_name
 
         for invalid_char in ["<", ">", ":", '"', "/", "\\", "|", "?", "*", "."]:
@@ -47,34 +63,10 @@ class Plugin(ABC):
         self.working_dir = root_data_dir / scrubbed_unique_name
 
     # ----------------------------------------------------------------------
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        """The name of the plugin."""
-        raise NotImplementedError()  # pragma: no cover
-
-    @property
-    @abstractmethod
-    def author(self) -> str:
-        """The author of the plugin. This value will be used in the plugin's unique name."""
-        raise NotImplementedError()  # pragma: no cover
-
-    @property
-    @abstractmethod
-    def description(self) -> str:
-        """The description of the plugin."""
-        raise NotImplementedError()  # pragma: no cover
-
-    @property
-    @abstractmethod
-    def plugin_priority(self) -> int:
-        """The priority of the plugin. Higher values indicate higher priority, which will cause the plugin to appear before other lower priority plugins."""
-        raise NotImplementedError()  # pragma: no cover
-
     @cached_property
     def unique_name(self) -> str:
         """The unique name of the plugin."""
-        return f"{self.author}_{self.name}"
+        return f"{self.__class__.AUTHOR}_{self.__class__.NAME}"
 
     # ----------------------------------------------------------------------
     def GetNoteSource(

memoryframes-0.5.0/src/MemoryFrames/Settings.py

@@ -0,0 +1,86 @@
+from typing import cast, TYPE_CHECKING
+
+import rtyaml
+
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from MemoryFrames.PluginInfra.Plugin import Plugin
+
+
+# ----------------------------------------------------------------------
+class Settings:
+    """Settings used by MemoryFrames and its plugins."""
+
+    # ----------------------------------------------------------------------
+    @classmethod
+    def DeserializeOrCreate(
+        cls,
+        content_dir: Path,
+        working_dir: Path,
+        *,
+        verbose: bool,
+        debug: bool,
+    ) -> Settings:
+        """Deserialize settings from disk or create default settings if necessary."""
+
+        settings_filename = cls._GetSettingsFilename(working_dir)
+
+        if settings_filename.is_file():
+            with settings_filename.open("r", encoding="utf-8") as f:
+                settings = rtyaml.load(f)
+        else:
+            settings = {}
+
+        return cls(
+            content_dir,
+            working_dir,
+            cast(dict[str, object], settings),
+            verbose=verbose,
+            debug=debug,
+        )
+
+    # ----------------------------------------------------------------------
+    def __init__(
+        self,
+        content_dir: Path,
+        working_dir: Path,
+        settings: dict[str, object],
+        *,
+        verbose: bool,
+        debug: bool,
+    ) -> None:
+        if debug is True:
+            verbose = True
+
+        # Commit results
+        self.content_dir = content_dir
+        self.working_dir = working_dir
+
+        self.verbose = verbose
+        self.debug = debug
+
+        self._settings = settings
+
+    # ----------------------------------------------------------------------
+    def Serialize(self) -> None:
+        """Serialize settings to disk."""
+
+        settings_filename = self._GetSettingsFilename(self.working_dir)
+
+        with settings_filename.open("w", encoding="utf-8") as f:
+            rtyaml.dump(self._settings, f)
+
+    # ----------------------------------------------------------------------
+    def GetPluginSettings(self, plugin: type[Plugin]) -> dict[str, object]:
+        """Return the settings associated with the provided Plugin."""
+
+        return cast(dict[str, object], self._settings.get(f"{plugin.AUTHOR}_{plugin.NAME}", {}))
+
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    @staticmethod
+    def _GetSettingsFilename(working_dir: Path) -> Path:
+        return working_dir / "settings.yaml"

memoryframes-0.5.0/src/MemoryFrames/TextualUserExperience.py

@@ -0,0 +1,11 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from MemoryFrames.Settings import Settings
+
+
+# ----------------------------------------------------------------------
+def Execute(settings: Settings) -> None:
+    """Execute the Textual user experience."""
+
+    print("TextualUserExperience", settings)  # noqa: T201

memoryframes-0.5.0/src/MemoryFrames/__main__.py

@@ -0,0 +1,107 @@
+import os
+
+from enum import Enum
+from pathlib import Path
+from typing import Annotated
+
+import typer
+
+from typer.core import TyperGroup
+
+from MemoryFrames.Settings import Settings
+from MemoryFrames import TextualUserExperience
+
+
+# ----------------------------------------------------------------------
+class NaturalOrderGrouper(TyperGroup):  # noqa: D101
+    # ----------------------------------------------------------------------
+    def list_commands(self, *args, **kwargs) -> list[str]:  # noqa: ARG002, D102
+        return list(self.commands.keys())  # pragma: no cover
+
+
+# ----------------------------------------------------------------------
+app = typer.Typer(
+    cls=NaturalOrderGrouper,
+    help=__doc__,
+    no_args_is_help=True,
+    pretty_exceptions_show_locals=False,
+    pretty_exceptions_enable=False,
+)
+
+
+# ----------------------------------------------------------------------
+def _GetWorkingDir() -> Path:
+    data_dir = Path.home()
+
+    if os.name == "nt":  # noqa: SIM108
+        data_dir = data_dir / "AppData" / "Local"
+    else:
+        data_dir = data_dir / ".local" / "share"
+
+    data_dir /= "MemoryFrames"
+
+    data_dir.mkdir(parents=True, exist_ok=True)
+
+    return data_dir
+
+
+# ----------------------------------------------------------------------
+class _ExperienceType(str, Enum):
+    Textual = "Textual"
+
+
+# ----------------------------------------------------------------------
+@app.command("EntryPoint", no_args_is_help=False)
+def EntryPoint(
+    content_dir: Annotated[
+        Path,
+        typer.Option(
+            "--content-dir",
+            exists=True,
+            file_okay=False,
+            help="Directory containing notes to load.",
+            resolve_path=True,
+        ),
+    ] = Path.cwd(),  # noqa: B008
+    working_dir: Annotated[
+        Path,
+        typer.Option(
+            "--working-dir",
+            file_okay=False,
+            help="Directory to use for settings and other persisted data.",
+            resolve_path=True,
+        ),
+    ] = _GetWorkingDir(),  # noqa: B008
+    experience: Annotated[
+        _ExperienceType,
+        typer.Option("--experience", case_sensitive=False, help="The user experience to use."),
+    ] = _ExperienceType.Textual,
+    verbose: Annotated[  # noqa: FBT002
+        bool,
+        typer.Option("--verbose", help="Write verbose information to the terminal."),
+    ] = False,
+    debug: Annotated[  # noqa: FBT002
+        bool,
+        typer.Option("--debug", help="Write debug information to the terminal."),
+    ] = False,
+) -> None:
+    """Run MemoryFrames."""
+
+    content_dir.mkdir(parents=True, exist_ok=True)
+    working_dir.mkdir(parents=True, exist_ok=True)
+
+    settings = Settings.DeserializeOrCreate(content_dir, working_dir, verbose=verbose, debug=debug)
+
+    if experience == _ExperienceType.Textual:
+        user_experience_func = TextualUserExperience.Execute
+    else:
+        assert False, experience  #  noqa: B011, PT015  # pragma: no cover
+
+    user_experience_func(settings)
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+if __name__ == "__main__":
+    app()  # pragma: no cover