kash-shell 0.3.10__py3-none-any.whl → 0.3.12__py3-none-any.whl

kash/utils/file_utils/file_formats_model.py

@@ -48,6 +48,7 @@ class Format(Enum):
     """`md_html` is Markdown with HTML, used for example when we structure Markdown with divs."""
     html = "html"
     """`markdown` should be simple and clean Markdown that we can use with LLMs."""
+    epub = "epub"
     yaml = "yaml"
     diff = "diff"
     python = "python"
@@ -56,12 +57,14 @@ class Format(Enum):
     xonsh = "xonsh"
     json = "json"
     csv = "csv"
+    xlsx = "xlsx"
     npz = "npz"
     log = "log"
 
     # Media formats.
     pdf = "pdf"
     docx = "docx"
+    pptx = "pptx"
     jpeg = "jpeg"
     png = "png"
     gif = "gif"
@@ -100,6 +103,13 @@ class Format(Enum):
             self.log,
         ]
 
+    @property
+    def is_simple_text(self) -> bool:
+        """
+        Is this plaintext or close to it, like Markdown?
+        """
+        return self in [self.plaintext, self.markdown, self.md_html]
+
     @property
     def is_doc(self) -> bool:
         return self in [
@@ -108,6 +118,7 @@ class Format(Enum):
             self.html,
             self.pdf,
             self.docx,
+            self.pptx,
         ]
 
     @property
@@ -126,9 +137,17 @@ class Format(Enum):
     def is_code(self) -> bool:
         return self in [self.python, self.shellscript, self.xonsh, self.json, self.yaml]
 
+    @property
+    def is_markdown(self) -> bool:
+        return self in [self.markdown, self.md_html]
+
+    @property
+    def is_html(self) -> bool:
+        return self in [self.html, self.md_html]
+
     @property
     def is_data(self) -> bool:
-        return self in [self.csv, self.npz]
+        return self in [self.csv, self.xlsx, self.npz]
 
     @property
     def is_binary(self) -> bool:
@@ -166,6 +185,7 @@ class Format(Enum):
             Format.markdown: MediaType.text,
             Format.md_html: MediaType.text,
             Format.html: MediaType.webpage,
+            Format.epub: MediaType.text,
             Format.yaml: MediaType.text,
             Format.diff: MediaType.text,
             Format.python: MediaType.text,
@@ -175,11 +195,13 @@ class Format(Enum):
             Format.csv: MediaType.text,
             Format.log: MediaType.text,
             Format.pdf: MediaType.text,
+            Format.xlsx: MediaType.text,
             Format.jpeg: MediaType.image,
             Format.png: MediaType.image,
             Format.gif: MediaType.image,
             Format.svg: MediaType.image,
             Format.docx: MediaType.text,
+            Format.pptx: MediaType.text,
             Format.mp3: MediaType.audio,
             Format.m4a: MediaType.audio,
             Format.mp4: MediaType.video,
@@ -200,6 +222,7 @@ class Format(Enum):
             FileExt.diff.value: Format.diff,
             FileExt.json.value: Format.json,
             FileExt.csv.value: Format.csv,
+            FileExt.xlsx.value: Format.xlsx,
             FileExt.npz.value: Format.npz,
             FileExt.log.value: Format.log,
             FileExt.py.value: Format.python,
@@ -207,6 +230,7 @@ class Format(Enum):
             FileExt.xsh.value: Format.xonsh,
             FileExt.pdf.value: Format.pdf,
             FileExt.docx.value: Format.docx,
+            FileExt.pptx.value: Format.pptx,
             FileExt.jpg.value: Format.jpeg,
             FileExt.png.value: Format.png,
             FileExt.gif.value: Format.gif,
@@ -214,6 +238,7 @@ class Format(Enum):
             FileExt.mp3.value: Format.mp3,
             FileExt.m4a.value: Format.m4a,
             FileExt.mp4.value: Format.mp4,
+            FileExt.epub.value: Format.epub,
         }
         return ext_to_format.get(file_ext.value, None)
 
@@ -228,10 +253,12 @@ class Format(Enum):
             Format.md_html: FileExt.md,
             Format.html: FileExt.html,
             Format.plaintext: FileExt.txt,
+            Format.epub: FileExt.epub,
             Format.yaml: FileExt.yml,
             Format.diff: FileExt.diff,
             Format.json: FileExt.json,
             Format.csv: FileExt.csv,
+            Format.xlsx: FileExt.xlsx,
             Format.npz: FileExt.npz,
             Format.log: FileExt.log,
             Format.python: FileExt.py,
@@ -239,6 +266,7 @@ class Format(Enum):
             Format.xonsh: FileExt.xsh,
             Format.pdf: FileExt.pdf,
             Format.docx: FileExt.docx,
+            Format.pptx: FileExt.pptx,
             Format.jpeg: FileExt.jpg,
             Format.png: FileExt.png,
             Format.gif: FileExt.gif,
@@ -260,6 +288,7 @@ class Format(Enum):
             "text/html": Format.html,
             "text/diff": Format.diff,
             "text/x-diff": Format.diff,
+            "application/epub+zip": Format.epub,
             "application/yaml": Format.yaml,
             "application/x-yaml": Format.yaml,
             "text/x-python": Format.python,
@@ -269,9 +298,11 @@ class Format(Enum):
             "text/x-xonsh": Format.xonsh,
             "application/json": Format.json,
             "text/csv": Format.csv,
+            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": Format.xlsx,
             "application/x-npz": Format.npz,
             "application/pdf": Format.pdf,
             "application/vnd.openxmlformats-officedocument.wordprocessingml.document": Format.docx,
+            "application/vnd.openxmlformats-officedocument.presentationml.presentation": Format.pptx,
             "image/jpeg": Format.jpeg,
             "image/png": Format.png,
             "image/gif": Format.gif,

kash/utils/file_utils/file_sort_filter.py

@@ -1,9 +1,11 @@
+from __future__ import annotations
+
 from datetime import UTC, datetime
 from enum import Enum
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import humanfriendly
-import pandas as pd
 from funlog import log_calls
 from prettyfmt import fmt_path
 from pydantic.dataclasses import dataclass
@@ -12,6 +14,9 @@ from kash.config.logger import get_logger
 from kash.utils.errors import FileNotFound, InvalidInput
 from kash.utils.file_utils.file_walk import IgnoreFilter, walk_by_dir
 
+if TYPE_CHECKING:
+    from pandas import DataFrame
+
 log = get_logger(__name__)
 
 
@@ -122,8 +127,10 @@ class FileListing:
     size_matching: int
     since_timestamp: float
 
-    def as_dataframe(self) -> pd.DataFrame:
-        df = pd.DataFrame([file.__dict__ for file in self.files])
+    def as_dataframe(self) -> DataFrame:
+        from pandas import DataFrame
+
+        df = DataFrame([file.__dict__ for file in self.files])
         return df
 
     @property

kash/web_gen/__init__.py

@@ -1,4 +0,0 @@
-from pathlib import Path
-
-base_templates_dir = Path(__file__).parent / "templates"
-"""Common base web page templates."""

kash/web_gen/simple_webpage.py

@@ -0,0 +1,52 @@
+from kash.model.items_model import Item
+from kash.utils.file_utils.file_formats_model import Format
+from kash.web_gen.template_render import render_web_template
+
+
+def simple_webpage_render(
+    item: Item,
+    page_template: str = "simple_webpage.html.jinja",
+    add_title_h1: bool = True,
+) -> str:
+    """
+    Generate a simple web page from a single item.
+    If `add_title_h1` is True, the title will be inserted as an h1 heading above the body.
+    """
+    return render_web_template(
+        template_filename=page_template,
+        data={
+            "title": item.title,
+            "add_title_h1": add_title_h1,
+            "content_html": item.body_as_html(),
+            "thumbnail_url": item.thumbnail_url,
+        },
+    )
+
+
+## Tests
+
+
+def test_render():
+    import os
+
+    from kash.model.items_model import ItemType
+
+    # Create a test item
+    item = Item(
+        type=ItemType.doc,
+        format=Format.html,
+        title="A Simple Web Page",
+        body="<p>This is a simple web page with <b>HTML content</b>.</p>",
+    )
+
+    # Generate HTML
+    html = simple_webpage_render(item)
+
+    os.makedirs("tmp", exist_ok=True)
+    with open("tmp/simple_webpage.html", "w") as f:
+        f.write(html)
+    print("Rendered simple webpage to tmp/simple_webpage.html")
+
+    # Basic validation
+    assert item.title and item.title in html
+    assert "<b>HTML content</b>" in html

kash/web_gen/tabbed_webpage.py

@@ -2,7 +2,7 @@ import os
 from dataclasses import asdict, dataclass
 
 from frontmatter_format import read_yaml_file, to_yaml_string, write_yaml_file
-from prettyfmt import sanitize_title
+from prettyfmt import abbrev_on_words, sanitize_title
 
 from kash.config.logger import get_logger
 from kash.exec.preconditions import has_thumbnail_url
@@ -12,7 +12,6 @@ from kash.model.paths_model import StorePath
 from kash.utils.common.type_utils import as_dataclass, not_none
 from kash.utils.errors import NoMatch
 from kash.utils.file_utils.file_formats_model import Format
-from kash.web_gen import base_templates_dir
 from kash.web_gen.template_render import render_web_template
 from kash.workspaces import current_ws
 from kash.workspaces.source_items import find_upstream_item
@@ -34,6 +33,7 @@ class TabbedWebpage:
     title: str
     tabs: list[TabInfo]
     show_tabs: bool = True
+    add_title_h1: bool = True
 
 
 def _fill_in_ids(tabs: list[TabInfo]):
@@ -42,7 +42,9 @@ def _fill_in_ids(tabs: list[TabInfo]):
             tab.id = f"tab_{i}"
 
 
-def webpage_config(items: list[Item], clean_headings: bool = False) -> Item:
+def tabbed_webpage_config(
+    items: list[Item], clean_headings: bool = False, add_title_h1: bool = True
+) -> Item:
     """
     Get an item with the config for a tabbed web page.
     """
@@ -58,11 +60,15 @@ def webpage_config(items: list[Item], clean_headings: bool = False) -> Item:
             log.warning("Item has no thumbnail URL: %s", item)
             return None
 
-    clean = clean_heading if clean_headings else sanitize_title
+    def clean_label(label: str) -> str:
+        if clean_headings:
+            return clean_heading(label)
+        else:
+            return abbrev_on_words(sanitize_title(label), max_len=40)
 
     tabs = [
         TabInfo(
-            label=clean(item.abbrev_title()),
+            label=clean_label(item.abbrev_title()),
             store_path=item.store_path,
             thumbnail_url=get_thumbnail_url(item),
         )
@@ -70,7 +76,9 @@ def webpage_config(items: list[Item], clean_headings: bool = False) -> Item:
     ]
     _fill_in_ids(tabs)
     title = summary_heading([item.abbrev_title() for item in items])
-    config = TabbedWebpage(title=title, tabs=tabs, show_tabs=len(tabs) > 1)
+    config = TabbedWebpage(
+        title=title, tabs=tabs, show_tabs=len(tabs) > 1, add_title_h1=add_title_h1
+    )
 
     config_item = Item(
         title=f"{title} (config)",
@@ -91,7 +99,9 @@ def _load_tab_content(config: TabbedWebpage):
         tab.content_html = html
 
 
-def webpage_generate(config_item: Item) -> str:
+def tabbed_webpage_generate(
+    config_item: Item, page_template: str = "base_webpage.html.jinja", add_title_h1: bool = True
+) -> str:
     """
     Generate a web page using the supplied config.
     """
@@ -101,14 +111,15 @@ def webpage_generate(config_item: Item) -> str:
     _load_tab_content(tabbed_webpage)
 
     content = render_web_template(
-        base_templates_dir, "tabbed_webpage.html.jinja", asdict(tabbed_webpage)
+        template_filename="tabbed_webpage.html.jinja",
+        data=asdict(tabbed_webpage),
     )
 
     return render_web_template(
-        base_templates_dir,
-        "base_webpage.html.jinja",
-        {
+        page_template,
+        data={
             "title": tabbed_webpage.title,
+            "add_title_h1": add_title_h1,
             "content": content,
         },
     )
@@ -138,11 +149,7 @@ def test_render():
     new_config = as_dataclass(read_yaml_file("tmp/webpage_config.yaml"), TabbedWebpage)
     assert new_config == config
 
-    html = render_web_template(
-        base_templates_dir,
-        "tabbed_webpage.html.jinja",
-        asdict(config),
-    )
+    html = render_web_template(template_filename="tabbed_webpage.html.jinja", data=asdict(config))
     with open("tmp/webpage.html", "w") as f:
         f.write(html)
     print("Rendered tabbed webpage to tmp/webpage.html")

kash/web_gen/template_render.py

@@ -1,12 +1,45 @@
+from collections.abc import Iterator
+from contextlib import contextmanager
+from contextvars import ContextVar
 from pathlib import Path
 
 from jinja2 import Environment, FileSystemLoader
 
 from kash.config import colors
 
+_base_templates_dir = Path(__file__).parent / "templates"
+"""Common base web page templates."""
+
+
+_additional_template_dirs: ContextVar[list[Path] | None] = ContextVar(
+    "_additional_template_dirs", default=None
+)
+
+
+def get_template_dirs(*dirs: Path) -> list[Path]:
+    """
+    Returns template directories currently in context along with any
+    additional template directories.
+    """
+    additional = _additional_template_dirs.get() or []
+    return list(dirs) + [*additional, _base_templates_dir]
+
+
+@contextmanager
+def additional_template_dirs(*dirs: Path) -> Iterator[None]:
+    """
+    Context manager for temporarily adding template directories to the search path.
+    """
+    original = _additional_template_dirs.get()
+    current = [] if not original else original.copy()
+    token = _additional_template_dirs.set(current + list(dirs))
+    try:
+        yield
+    finally:
+        _additional_template_dirs.reset(token)
+
 
 def render_web_template(
-    templates_dir: Path,
     template_filename: str,
     data: dict,
     autoescape: bool = True,
@@ -14,11 +47,13 @@ def render_web_template(
 ) -> str:
     """
     Render a Jinja2 template file with the given data, returning an HTML string.
+    Uses template directories from the base directory and any added via context manager.
     """
     if css_overrides is None:
         css_overrides = {}
 
-    env = Environment(loader=FileSystemLoader(templates_dir), autoescape=autoescape)
+    search_paths = get_template_dirs()
+    env = Environment(loader=FileSystemLoader(search_paths), autoescape=autoescape)
 
     # Load and render the template.
     template = env.get_template(template_filename)

kash/web_gen/templates/base_styles.css.jinja

@@ -1,4 +1,5 @@
 :root {
+  {% block root_variables %}
   font-size: 16px;
   /* Adding Hack Nerd Font to all fonts for icon support, if it is installed. */
   --font-sans: "Source Sans 3 Variable", sans-serif, "Hack Nerd Font";
@@ -16,14 +17,17 @@
 
   --console-char-width: 88;
   --console-width: calc(var(--console-char-width) + 2rem);
+  {% endblock root_variables %}
 }
 
 {{ color_defs|safe }}
 
+{% block selection_styles %}
 ::selection {
   background-color: var(--color-selection);
   color: inherit;
 }
+{% endblock selection_styles %}
 
 {# TODO: Fix PDF issues and re-enable for prettier emoji. #}
 {# @font-face {
@@ -39,6 +43,7 @@
     U+1F900-1F9FF;  /* Supplemental Symbols and Pictographs */ 
 } #}
 
+{% block scrollbar_styles %}
 /* Scrollbar coloring. */
 /* For Webkit browsers (Chrome, Safari) */
 ::-webkit-scrollbar {
@@ -60,7 +65,9 @@
   scrollbar-width: thin;
   scrollbar-color: var(--color-scrollbar) var(--color-bg);
 }
+{% endblock scrollbar_styles %}
 
+{% block body_styles %}
 body {
   font-family: var(--font-serif);
   color: var(--color-text);
@@ -70,10 +77,15 @@ body {
   background-color: var(--color-bg);
   overflow-wrap: break-word;  /* Don't let long words/URLs break layout. */
 }
+{% endblock body_styles %}
 
+{% block typography %}
 p {
   margin-bottom: 1rem;
 }
+pre {
+  margin-bottom: 1rem;
+}
 
 b, strong {
   font-weight: var(--font-weight-sans-bold);
@@ -105,14 +117,14 @@ h1 {
 
 h2 {
   font-size: 1.4rem;
-  margin-top: 2.5rem;
+  margin-top: 1.2rem;
   margin-bottom: 1rem;
 }
 
 h3 {
   font-size: 1.09rem;
-  margin-top: 1.7rem;
-  margin-bottom: 0.7rem;
+  margin-top: 1.5rem;
+  margin-bottom: 0.5rem;
 }
 
 h4 {
@@ -120,37 +132,6 @@ h4 {
   margin-bottom: 0.7rem;
 }
 
-/* Long text stylings, for nicely formatting blog post length or longer texts. */
-
-.long-text h1 {
-  font-family: var(--font-serif);
-  font-weight: 400;
-}
-
-.long-text h2 {
-  font-family: var(--font-serif);
-  font-weight: 400;
-  font-style: italic;
-}
-
-.long-text h3 {
-  font-family: var(--font-sans);
-  font-weight: var(--font-weight-sans-bold);
-  text-transform: uppercase;
-  letter-spacing: 0.02em;
-}
-
-.long-text h4 {
-  font-family: var(--font-serif);
-  font-weight: 700;
-}
-
-.subtitle {
-  font-family: var(--font-serif);
-  font-style: italic;
-  font-size: 1rem;
-}
-
 ul {
   list-style-type: none;
   margin-left: 2rem;
@@ -207,7 +188,42 @@ pre {
   letter-spacing: -0.025em;
   {# overflow-x: auto; #}
 }
+{% endblock typography %}
+
+{% block long_text_styles %}
+/* Long text stylings, for nicely formatting blog post length or longer texts. */
+
+.long-text h1 {
+  font-family: var(--font-serif);
+  font-weight: 400;
+}
+
+.long-text h2 {
+  font-family: var(--font-serif);
+  font-weight: 400;
+  font-style: italic;
+}
+
+.long-text h3 {
+  font-family: var(--font-sans);
+  font-weight: var(--font-weight-sans-bold);
+  text-transform: uppercase;
+  letter-spacing: 0.02em;
+}
+
+.long-text h4 {
+  font-family: var(--font-serif);
+  font-weight: 700;
+}
+
+.subtitle {
+  font-family: var(--font-serif);
+  font-style: italic;
+  font-size: 1rem;
+}
+{% endblock long_text_styles %}
 
+{% block table_styles %}
 table {
   font-family: var(--font-sans);
   font-size: var(--font-size-small);
@@ -239,16 +255,6 @@ tbody tr:nth-child(even) {
   background-color: var(--color-bg-alt-solid); 
 }
 
-nav {
-  display: flex;
-  flex-wrap: wrap;
-  /* Allow wrapping */
-  justify-content: center;
-  /* Center the content */
-  gap: 1rem;
-  /* Add some space between the buttons */
-}
-
 /* Container for wide tables to allow tables to break out of parent width. */
 .table-container {
   {# max-width: calc(100vw - 6rem); #}
@@ -258,26 +264,24 @@ nav {
   box-sizing: border-box;
   margin-bottom: 1rem;
   background-color: var(--color-bg-solid);
-
 }
+{% endblock table_styles %}
 
-/* Bleed wide on larger screens. */
-/* TODO: Don't make so wide if table itself isn't large? */
-@media (min-width: 768px) {
-  table {
-    width: calc(100vw - 6rem);
-  }
-  .table-container {
-    width: calc(100vw - 6rem);
-  }
+{% block nav_styles %}
+nav {
+  display: flex;
+  flex-wrap: wrap;
+  /* Allow wrapping */
+  justify-content: center;
+  /* Center the content */
+  gap: 1rem;
+  /* Add some space between the buttons */
 }
+{% endblock nav_styles %}
 
-@media (max-width: 768px) {
-  table {
-    font-size: var(--font-size-smaller);
-  }
-}
 
+
+{% block footnote_styles %}
 /* Footnotes. */
 sup {
   font-size: 80%;
@@ -288,6 +292,8 @@ sup {
   padding: 0 0.15rem;
   border-radius: 4px;
   transition: all 0.15s ease-in-out;
+  font-style: normal;
+  font-weight: normal;
 }
 
 .footnote-ref a:hover, .footnote:hover {
@@ -295,4 +301,23 @@ sup {
   color: var(--color-primary-light);
   text-decoration: none;
 }
+{% endblock footnote_styles %}
 
+{% block responsive_styles %}
+/* Bleed wide on larger screens. */
+/* TODO: Don't make so wide if table itself isn't large? */
+@media (min-width: 768px) {
+  table {
+    width: calc(100vw - 6rem);
+  }
+  .table-container {
+    width: calc(100vw - 6rem);
+  }
+}
+
+@media (max-width: 768px) {
+  table {
+    font-size: var(--font-size-smaller);
+  }
+}
+{% endblock responsive_styles %}