feature(actions): Should Build without Database.

Added `include` to `db.Config` because the database should not be used
in builds (for now).
Added banner, svg captures, and japanese figure.
Added more notes on NVIM improvements.

Author: acederberg

.github/workflows/commit_checks.yaml

@@ -111,7 +111,6 @@ jobs:
           echo "ACEDERBERG_IO_ENV=ci" >> "GITHUB_ENV"
 
           source .venv/bin/activate
-          poetry run acederbergio db config
           poetry run coverage run -m pytest
           poetry run coverage html
       - name: Upload Coverage Report.

.gitignore

@@ -46,3 +46,4 @@ blog/projects/blog/typedoc
 blog/projects/blog/quartodoc
 blog/dsa/leetcode/calendar_2/_oops_files/
 .env.actions
+blog/posts/keywords/*.svg

acederbergio/db.py

@@ -42,12 +42,16 @@ def check_object_id(value) -> str | None:
     pydantic.Field(default=None),
     pydantic.BeforeValidator(check_object_id),
 ]
-FlagURL = Annotated[str, typer.Option("--mongodb-url"), pydantic.Field(URL)]
+FlagURL = Annotated[
+    pydantic.MongoDsn, typer.Option("--mongodb-url"), pydantic.Field(URL)
+]
 FlagDatabase = Annotated[str, pydantic.Field(DATABASE)]
 
 
-def create_client(*, _mongodb_url: str | None = None, cls: Type = MongoClient):
-    mongodb_url = env.require("mongodb_url", _mongodb_url)
+def create_client(
+    *, _mongodb_url: pydantic.MongoDsn | str | None = None, cls: Type = MongoClient
+):
+    mongodb_url = env.require("mongodb_url", str(_mongodb_url))
     return cls(mongodb_url, server_api=ServerApi("1"))
 
 
@@ -64,6 +68,27 @@ class Config(ysp.BaseYamlSettings):
 
     database: FlagDatabase
     url: FlagURL
+    include: Annotated[
+        bool,
+        pydantic.Field(
+            default=env.ENV == "ci",
+            description="""
+            When mongodb is not required (e.g. during builds) use this to
+            run without it. Some documents using this code do not need mongodb
+            for one off renders. To set this, do
+
+            .. code:: python
+
+                ACEDERBERG_IO_MONGODB_INCLUDE=false
+
+            and verify:
+
+            .. code:: shell
+
+                acederbergio db config 
+        """,
+        ),
+    ]
 
     def create_client(self) -> MongoClient:
         return create_client(_mongodb_url=self.url)

acederbergio/pdf.py

@@ -84,7 +84,7 @@ def compare(cls, left: "Metrics", right: "Metrics") -> Self:
         )
 
 
-class Metrics(util.HasTimestamp):
+class Metrics(util.HasTimestamp, db.HasMongoId):
     """
     **RAKE** metrics for a piece of text.
 
@@ -203,6 +203,9 @@ async def lazy(
         force: bool = False,
     ) -> Self:
 
+        # if db is None:
+        #     return cls.create(cls.createDF(text), text=text, metadata=metadata)
+
         collection = db[cls._collection]
         res = await collection.find_one(cls.match_text(text)["$match"])
         if not force and res is not None:
@@ -469,7 +472,7 @@ def __init__(
     @classmethod
     def resolveText(cls, text: FlagText, _file: FlagFile) -> tuple[str, dict[str, str]]:
         if text is None and _file is None:
-            util.CONSOLE.print("[red]Failed to determine text.")
+            util.CONSOLE.print("[red]One of `--text` or `--file` is required.")
             raise typer.Exit(3)
 
         metadata = dict(origin="cli", origin_file="pdf.py")

acederbergio/util.py

@@ -81,6 +81,7 @@ def print_yaml(
     rule_title: str = "",
     rule_kwargs: dict[str, Any] = dict(),
     is_complex: bool = False,
+    console: rich.console.Console = CONSOLE,
     **kwargs_model_dump,
 ) -> rich.syntax.Syntax | None:
     if items:
@@ -109,9 +110,9 @@ def print_yaml(
     )
 
     if rule_title or rule_kwargs:
-        CONSOLE.rule(rule_title, **rule_kwargs)
+        console.rule(rule_title, **rule_kwargs)
 
-    CONSOLE.print(s)
+    console.print(s)
     return s