memoryframes 0.1.5__tar.gz → 0.2.0__tar.gz

{memoryframes-0.1.5 → memoryframes-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: memoryframes
-Version: 0.1.5
+Version: 0.2.0
 Summary: Add your description here
 Author: David Brownell
 Author-email: David Brownell <github@DavidBrownell.com>
@@ -9,11 +9,14 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.10
-Requires-Python: >=3.10
+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: textual>=6.8.0
+Requires-Dist: typer>=0.20.0
+Requires-Dist: typer-config>=1.4.3
+Requires-Python: >=3.14
 Project-URL: Documentation, https://github.com/davidbrownell/MemoryFrames
 Project-URL: Homepage, https://github.com/davidbrownell/MemoryFrames
 Project-URL: Repository, https://github.com/davidbrownell/MemoryFrames

{memoryframes-0.1.5 → memoryframes-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "MemoryFrames"
-version = "0.1.5"
+version = "0.2.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:
@@ -12,17 +12,21 @@ readme = "README.md"
 authors = [
     { name = "David Brownell", email = "github@DavidBrownell.com" }
 ]
-requires-python = ">= 3.10"
-dependencies = []
+requires-python = ">= 3.14"
+dependencies = [
+    "dbrownell-common>=0.16.0",
+    "pluggy>=1.6.0",
+    "python-frontmatter>=1.1.0",
+    "textual>=6.8.0",
+    "typer>=0.20.0",
+    "typer-config>=1.4.3",
+]
 classifiers = [
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.13",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.14",
 ]
 
 [project.license]
@@ -40,11 +44,13 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "autogitsemver>=0.9.2",
-    "pre-commit>=4.2.0",
-    "py-minisign>=0.12.0",
-    "pytest>=8.4.1",
-    "pytest-cov>=6.2.1",
-    "ruff>=0.12.3",
+    "dbrownell-commitemojis>=0.2.0",
+    "pre-commit>=4.5.0",
+    "py-minisign>=0.13.0",
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.14.9",
+    "textual-dev>=1.8.0",
 ]
 
 [tool.pytest.ini_options]
@@ -52,12 +58,14 @@ addopts = "--verbose -vv --capture=no --cov=MemoryFrames --cov-report html --cov
 python_files = [
     "**/*Test.py",
 ]
+norecursedirs = ["prototype"]
 
 [tool.ruff]
 line-length = 110
+exclude = ["prototype/**"]
 
 [tool.ruff.lint]
-exclude = ["tests/**"]
+exclude = ["tests/**", "prototype/**"]
 
 select = ["ALL"]
 
@@ -66,6 +74,8 @@ ignore = [
     "ANN003", # Missing type annotation for `**kwargs`
     "BLE001", # Do not catch blind exception: `Exception`
     "COM812", # Trailing comma missing
+    "D100", # Missing docstring in public module
+    "D104", # Missing docstring in public package
     "D105", # Missing docstring in magic method
     "D107", # Missing docstring in `__init__` method
     "D202", # No blank lines allowed after function docstring

memoryframes-0.2.0/src/MemoryFrames/PluginInfra/Note.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from uuid import UUID
+
+    from MemoryFrames.PluginInfra.NoteSource import NoteSource
+
+
+# ----------------------------------------------------------------------
+@dataclass
+class Note:
+    """A note."""
+
+    id: UUID
+
+    source: NoteSource
+    source_data: object
+    """Opaque data provided by the NoteSource that created the note."""
+
+    metadata: dict[str, object] = field(repr=False)
+    content: str = field(repr=False)
+
+    metadata_hash: bytes = field(repr=False)
+    content_hash: bytes = field(repr=False)

memoryframes-0.2.0/src/MemoryFrames/PluginInfra/NoteSource.py

@@ -0,0 +1,36 @@
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from MemoryFrames.PluginInfra.Note import Note
+
+
+# ----------------------------------------------------------------------
+class NoteSource:
+    """Base class for a plugin component that provides notes to MemoryFrames."""
+
+    # ----------------------------------------------------------------------
+    def __init__(self, observer: NoteSourceObserver) -> None:
+        self.observer = observer
+
+
+# ----------------------------------------------------------------------
+class NoteSourceObserver(ABC):
+    """Base class for an observer that receives event notifications from a NoteSource."""
+
+    # ----------------------------------------------------------------------
+    @abstractmethod
+    def OnNewNote(
+        self,
+        note: Note,
+        *,
+        is_initializing: bool,
+    ) -> None:
+        """Indicate that a note has been discovered."""
+        raise NotImplementedError()  # pragma: no cover
+
+    # ----------------------------------------------------------------------
+    @abstractmethod
+    def OnInitializationComplete(self, note_source: NoteSource) -> None:
+        """Indicate that the NoteSource has completed its initialization."""
+        raise NotImplementedError()  # pragma: no cover

memoryframes-0.2.0/src/MemoryFrames/__init__.py

@@ -0,0 +1,9 @@
+from importlib.metadata import version
+
+
+# ----------------------------------------------------------------------
+APP_NAME = "MemoryFrames"
+
+
+# ----------------------------------------------------------------------
+__version__ = version("MemoryFrames")

memoryframes-0.1.5/src/MemoryFrames/EntryPoint.py

@@ -1,85 +0,0 @@
-"""An example of how to create scripts that can be invoked from the command line once the package is installed."""
-
-import sys
-
-import typer
-
-from typer.core import TyperGroup  # type: ignore [import-untyped]
-
-from MemoryFrames import Math, __version__
-
-
-# ----------------------------------------------------------------------
-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,
-)
-
-
-# ----------------------------------------------------------------------
-@app.command("Add")
-def Add(
-    x: int,
-    y: int,
-) -> None:
-    """Add 2 values."""
-
-    sys.stdout.write(str(Math.Add(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Sub")
-def Sub(
-    x: int,
-    y: int,
-) -> None:
-    """Subtract 2 values."""
-
-    sys.stdout.write(str(Math.Sub(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Mult")
-def Mult(
-    x: int,
-    y: int,
-) -> None:
-    """Multiplie 2 values."""
-
-    sys.stdout.write(str(Math.Mult(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Div")
-def Div(
-    x: int,
-    y: int,
-) -> None:
-    """Divide 1 value by another."""
-
-    sys.stdout.write(str(Math.Div(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Version")
-def Version() -> None:
-    """Print the version of the package."""
-
-    sys.stdout.write(__version__)
-
-
-# ----------------------------------------------------------------------
-# ----------------------------------------------------------------------
-# ----------------------------------------------------------------------
-if __name__ == "__main__":
-    app()  # pragma: no cover

memoryframes-0.1.5/src/MemoryFrames/Math.py

@@ -1,21 +0,0 @@
-"""Basic math functions. This file illustrates how to create a python package that contains functions that can be invoked by other python code."""
-
-
-# ----------------------------------------------------------------------
-def Add(x, y):  # noqa: ANN001, ANN201, D103
-    return x + y
-
-
-# ----------------------------------------------------------------------
-def Sub(x, y):  # noqa: ANN001, ANN201, D103
-    return x - y
-
-
-# ----------------------------------------------------------------------
-def Mult(x, y):  # noqa: ANN001, ANN201, D103
-    return x * y
-
-
-# ----------------------------------------------------------------------
-def Div(x, y):  # noqa: ANN001, ANN201, D103
-    return x / y

memoryframes-0.1.5/src/MemoryFrames/__init__.py

@@ -1,15 +0,0 @@
-# noqa: D104
-
-from importlib.metadata import version
-
-from .Math import Add, Sub, Mult, Div
-
-
-__all__ = [
-    "Add",
-    "Div",
-    "Mult",
-    "Sub",
-]
-
-__version__ = version("MemoryFrames")