mkdocs-entangled-plugin 0.3.0__tar.gz → 0.4.0__tar.gz

{mkdocs_entangled_plugin-0.3.0 → mkdocs_entangled_plugin-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-entangled-plugin
-Version: 0.3.0
+Version: 0.4.0
 Summary: Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects.
 License: Apache 2.0
 Author: Johan Hidding
@@ -9,13 +9,17 @@ Requires-Python: >=3.11,<4.0
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: entangled-cli[rich] (>=2.0.0a3,<3.0.0)
+Requires-Dist: entangled-cli (>=2.0.0a6,<3.0.0)
+Requires-Dist: mawk (>=0.1.4,<0.2.0)
 Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
 Description-Content-Type: text/markdown
 
 # Welcome to MkDocs Entangled Plugin
 Using this plugin, you can make your Entangled documents look better.
 
+## Examples
+Detailed examples are found in the [entangled/mkdocs-examples repository](https://entangled.github.io/mkdocs-examples).
+
 ## Install
 
 Install this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:
@@ -30,6 +34,8 @@ markdown_extensions:
       alternate_style: true 
 ```
 
+For more information, see [the documentation](https://entangled.github.io/mkdocs-plugin).
+
 ## Components
 This plugin bundles functionality for literate programming with Entangled.
 

{mkdocs_entangled_plugin-0.3.0 → mkdocs_entangled_plugin-0.4.0}/README.md

@@ -1,6 +1,9 @@
 # Welcome to MkDocs Entangled Plugin
 Using this plugin, you can make your Entangled documents look better.
 
+## Examples
+Detailed examples are found in the [entangled/mkdocs-examples repository](https://entangled.github.io/mkdocs-examples).
+
 ## Install
 
 Install this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:
@@ -15,6 +18,8 @@ markdown_extensions:
       alternate_style: true 
 ```
 
+For more information, see [the documentation](https://entangled.github.io/mkdocs-plugin).
+
 ## Components
 This plugin bundles functionality for literate programming with Entangled.
 

{mkdocs_entangled_plugin-0.3.0 → mkdocs_entangled_plugin-0.4.0}/mkdocs_entangled/on_page_markdown.py

@@ -7,7 +7,7 @@ from mkdocs.structure.pages import Page
 from mkdocs.structure.files import Files
 
 from .properties import read_properties, Id, Attribute
-from . import mawk
+import mawk
 
 
 @dataclass

{mkdocs_entangled_plugin-0.3.0 → mkdocs_entangled_plugin-0.4.0}/mkdocs_entangled/plugin.py

@@ -1,20 +1,11 @@
-import logging
 import mkdocs
 from mkdocs.config.defaults import MkDocsConfig
 from mkdocs.structure.pages import Page
 from mkdocs.structure.files import Files
 
-from entangled.commands import sync
-from entangled.main import configure
-
 from .on_page_markdown import on_page_markdown
 from .config import EntangledConfig
 
 class EntangledPlugin(mkdocs.plugins.BasePlugin[EntangledConfig]):
-    def on_pre_build(self, config: MkDocsConfig):
-        configure()
-        logging.info("Running `entangled sync`")
-        sync()
-        
     def on_page_markdown(self, markdown: str, *, page: Page, config: MkDocsConfig, files: Files):
         return on_page_markdown(markdown, page=page, config=config, files=files)

{mkdocs_entangled_plugin-0.3.0 → mkdocs_entangled_plugin-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mkdocs-entangled-plugin"
-version = "0.3.0"
+version = "0.4.0"
 description = "Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects."
 readme = "README.md"
 authors = ["Johan Hidding <j.hidding@esciencecenter.nl>"]
@@ -15,8 +15,8 @@ entangled = "mkdocs_entangled:EntangledPlugin"
 [tool.poetry.dependencies]
 python = "^3.11"
 mkdocs = "^1.4.2"
-# entangled-cli = {path = "../entangled.py", extras = ["rich"], develop = true}
-entangled-cli = {extras = ["rich"], version = "^2.0.0a3"}
+entangled-cli = "^2.0.0a6"
+mawk = "^0.1.4"
 
 [tool.poetry.dev-dependencies]
 mypy = "^1.2.0"

mkdocs_entangled_plugin-0.3.0/mkdocs_entangled/mawk.py

@@ -1,100 +0,0 @@
-"""
-μAwk, a tiny awk-like interface in Python
-"""
-
-from typing import Callable, Optional
-from functools import wraps, partial
-import re
-
-
-"""Global counter to sort filters by the order in which they appear
-in a class."""
-_filter_creation_order = 0
-
-
-def match_filter(expr: str, handler: Callable[[re.Match], Optional[list[str]]], inp: str) -> Optional[list[str]]:
-    if m := re.match(expr, inp):
-        return handler(m)
-    return None
-
-
-def on_match(expr: str):
-    """Decorator for doing search-and-replace based on a given regex.
-    
-    The inner function should take as argument a `re.Match` object
-    and return a list of strings. The resulting decorated function
-    then becomes a function from string to list of strings.
-    
-    If the input doesn't match the given regex, the original string
-    is returned.
-    
-    The inner function may still decide to do nothing by returning None.
-    
-    To erase the matched input return the empty list.
-
-    This decorator also works on class methods. It is then assumed that
-    the method has signature `(self, m: re.Match)`.
-    """
-    def _decorator(f):
-        global _filter_creation_order
-        method = len(f.__qualname__.split('.')) > 1
-        if method:
-            @wraps(f)
-            def _impl(self, inp):
-                return match_filter(expr, partial(f, self), inp)
-            _impl._is_rule = _filter_creation_order  # add tag to method
-            _filter_creation_order += 1
-            return _impl
-        else:
-            return wraps(f)(partial(match_filter, expr, f))
-    return _decorator
-
-
-def always(f):
-    """Suppose you have a rule with `@on_match(r".*")`, then it is better
-    not to run the regex machinery at all and just pass on the string.
-    In that case it is better to use `@always`."""
-    global _filter_creation_order
-    method = len(f.__qualname__.split('.')) > 1
-    if method:
-        f._is_rule = _filter_creation_order  # add tag to method
-        _filter_creation_order += 1
-        return f
-    else:
-        return f
-
-
-Rule = Callable[[str], list[str]]
-
-
-def run(rules: list[Rule], inp: str, exclusive=True) -> str:
-    """Takes a list of rules, being function from `str` to `list[str]`.
-    The input string is split into lines, after which each line is fed
-    through the list of rules. All the results are colected into a list
-    of strings and then joined by newline.
-    """
-    lines = inp.splitlines()
-    result = []
-    for l in lines:
-        for r in rules:
-            v = r(l)
-            if v is not None:
-                result.extend(v)
-                if exclusive:
-                    break
-        else:
-            result.append(l)
-    return "\n".join(result)
-
-
-class RuleSet:
-    """To be used as a base class for classes that contain `on_match`
-    decorated methods."""
-    def list_rules(self):
-        members = (getattr(self, m) for m in dir(self) if m[0] != '_')
-        rules = [m for m in members if hasattr(m, '_is_rule')]
-        return sorted(rules, key=lambda r: r._is_rule)
-
-    def run(self, inp: str, exclusive=True) -> str:
-        """Runs all rules in the class on input."""
-        return run(self.list_rules(), inp, exclusive)