entangled-cli 2.1.11__tar.gz → 2.1.13__tar.gz

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entangled-cli
-Version: 2.1.11
+Version: 2.1.13
 Summary: Literate Programming toolbox
 Project-URL: Homepage, https://entangled.github.io/
 Project-URL: Repository, https://github.com/entangled/entangled.py

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/code_reader.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass, field
-from pathlib import Path
+from pathlib import Path, PurePath
 
 import mawk
 import re
@@ -18,9 +18,9 @@ class Frame:
 class CodeReader(mawk.RuleSet):
     """Reads an annotated code file."""
 
-    def __init__(self, path: str, refs: ReferenceMap):
+    def __init__(self, path: PurePath, refs: ReferenceMap):
         self.location = TextLocation(path, 0)
-        self.stack: list[Frame] = [Frame(ReferenceId("#root#", "", -1), "")]
+        self.stack: list[Frame] = [Frame(ReferenceId("#root#", PurePath("-"), -1), "")]
         self.refs: ReferenceMap = refs
 
     @property
@@ -56,7 +56,7 @@ class CodeReader(mawk.RuleSet):
 
         self.stack.append(
             Frame(
-                ReferenceId(m["ref_name"], m["source"], ref_count), m["indent"], content
+                ReferenceId(m["ref_name"], PurePath(m["source"]), ref_count), m["indent"], content
             )
         )
         return []

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/commands/stitch.py

@@ -57,7 +57,7 @@ def stitch(*, force: bool = False, show: bool = False):
                 logging.debug("reading `%s`", path)
                 t.update(path)
                 with open(path, "r") as f:
-                    CodeReader(str(path), refs).run(f.read())
+                    CodeReader(path, refs).run(f.read())
 
             for path in input_file_list:
                 t.write(path, stitch_markdown(refs, content[path]), [])

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/config/__init__.py

@@ -83,7 +83,7 @@ class Config(threading.local):
     languages: list[Language] = field(default_factory=list)
     markers: Markers = field(default_factory=lambda: copy(markers))
     watch_list: list[str] = field(default_factory=lambda: ["**/*.md"])
-    ignore_list: list[str] = field(default_factory=lambda: ["README.md"])
+    ignore_list: list[str] = field(default_factory=list)
     annotation_format: Optional[str] = None
     annotation: AnnotationMethod = AnnotationMethod.STANDARD
     use_line_directives: bool = False

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/config/templates.py

@@ -32,5 +32,12 @@ templates: list[Template] = [
         "gh:entangled/template-pandoc",
         "pandoc",
         "Supports HTML and PDF output, numbered equations and citations."
+    ),
+    Template(
+        "one-pager",
+        "One-page README",
+        "gh:entangled/template-one-pager",
+        "none",
+        "Everything in a single README, to be rendered on Github/Gitlab/etc."
     )
 ]

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/document.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass, field
 from collections import defaultdict
 from functools import singledispatchmethod
 from itertools import chain
+from pathlib import PurePath
 
 from .config import Language, AnnotationMethod, config
 from .properties import Property, get_attribute
@@ -17,7 +18,7 @@ def length(iter: Iterable[Any]) -> int:
 @dataclass
 class ReferenceId:
     name: str
-    file: str
+    file: PurePath
     ref_count: int
 
     def __hash__(self):
@@ -71,7 +72,7 @@ class ReferenceMap:
 
         return (self.map[r] for r in self.index[n])
 
-    def new_id(self, filename: str, name: str) -> ReferenceId:
+    def new_id(self, filename: PurePath, name: str) -> ReferenceId:
         c = length(filter(lambda r: r.file == filename, self.index[name]))
         return ReferenceId(name, filename, c)
 

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/hooks/shebang.py

@@ -5,6 +5,6 @@ from .base import HookBase
 class Hook(HookBase):
     def on_read(self, code: CodeBlock):
         lines = code.source.splitlines()
-        if lines[0].startswith("#!"):
+        if lines and lines[0].startswith("#!"):
             code.header = lines[0]
             code.source = "\n".join(lines[1:])

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/markdown_reader.py

@@ -1,6 +1,6 @@
 from typing import Optional
 from copy import copy
-from pathlib import Path
+from pathlib import Path, PurePath
 
 import re
 import mawk
@@ -20,8 +20,8 @@ class MarkdownLexer(mawk.RuleSet):
     content."""
     def __init__(
         self,
-        filename: str
-    ):
+        filename: Path
+    ): 
         self.location = TextLocation(filename)
         self.raw_content: list[RawContent] = []
         self.inside_codeblock: bool = False
@@ -122,13 +122,13 @@ def read_markdown_file(
     -> tuple[ReferenceMap, list[Content]]:
 
     with open(path, "r") as f:
-        path_str = str(path.resolve().relative_to(Path.cwd()))
-        return read_markdown_string(f.read(), path_str, refs, hooks)
+        rel_path = path.resolve().relative_to(Path.cwd())
+        return read_markdown_string(f.read(), rel_path, refs, hooks)
 
 
 def read_markdown_string(
         text: str,
-        path_str: str = "-",
+        path_str: Path = Path("-"),
         refs: ReferenceMap | None = None,
         hooks: list[HookBase] | None = None) \
         -> tuple[ReferenceMap, list[Content]]:

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/tangle.py

@@ -95,7 +95,7 @@ class AnnotatedTangler(Tangler):
         if self.cb.header is not None:
             result.append(self.cb.header)
         result.append(
-            f"{self.cb.language.comment.open} ~/~ begin <<{self.ref.file}#{self.ref.name}>>[{count}]{self.close_comment}"
+            f"{self.cb.language.comment.open} ~/~ begin <<{self.ref.file.as_posix()}#{self.ref.name}>>[{count}]{self.close_comment}"
         )
         return result
 

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/entangled/text_location.py

@@ -1,9 +1,10 @@
 from dataclasses import dataclass
+from pathlib import PurePath
 
 
 @dataclass
 class TextLocation:
-    filename: str
+    filename: PurePath
     line_number: int = 0
 
     def __str__(self):

{entangled_cli-2.1.11 → entangled_cli-2.1.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "entangled-cli"
-version = "2.1.11"
+version = "2.1.13"
 description = "Literate Programming toolbox"
 authors = [{ name = "Johan Hidding", email = "j.hidding@esciencecenter.nl" }]
 requires-python = "~=3.11"