0.5.1 release (#43)

* Replace 3.9 list with 3.8 List. Closes #42 Signed-off-by: houfu <[email protected]> * Bump to 0.5.1 Signed-off-by: houfu <[email protected]> * Add claude_xml.yml workflow Signed-off-by: houfu <[email protected]> * Fix error Signed-off-by: houfu <[email protected]> * New cli command markdown Signed-off-by: houfu <[email protected]> * New image for Readme Signed-off-by: houfu <[email protected]> * Convert files to a list Signed-off-by: houfu <[email protected]> * Let's try this again... Signed-off-by: houfu <[email protected]> * Update claude_xml.yml * Update claude_xml.yml * Delete .github/workflows/claude_xml.yml --------- Signed-off-by: houfu <[email protected]>
houfu · Nov 7, 2024 · 894f82e · 894f82e
1 parent c5c1c24
commit 894f82e
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 6 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
 
     steps:
     - uses: actions/checkout@v3

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "redlines"
-version = "0.5.0"
+version = "0.5.1"
 description = "Compare text, and produce human-readable differences or deltas which look like track changes in Microsoft Word."
 readme = "README.md"
 dependencies = [
@@ -24,7 +24,7 @@ redlines = 'redlines.cli:cli'
 
 [tool.poetry]
 name = "redlines"
-version = "0.5.0"
+version = "0.5.1"
 description = "Compare text, and produce human-readable differences or deltas which look like track changes in Microsoft Word."
 authors = ["houfu <[email protected]>"]
 license = "MIT"

diff --git a/redlines/cli.py b/redlines/cli.py
@@ -29,6 +29,11 @@
 ```
 Compares the strings SOURCE and TEST and outputs the redline in the terminal.
 
+```sh
+markdown
+```
+Compares the strings SOURCE and TEST and outputs the redline as a markdown.
+
 ## OPTIONS
 ```sh
 -h, --help
@@ -140,3 +145,27 @@ def simple_text(source, test):
 
     redlines = Redlines(source, test)
     print(redlines.output_rich)
+
+
+@cli.command()
+@click.argument("source", required=True)
+@click.argument("test", required=True)
+@click.option(
+    "markdown_style",
+    "--markdown-style",
+    "-m",
+    type=click.Choice(["red_green", "none", "red", "ghfm", "bbcode", "streamlit"]),
+    default="red_green",
+    help="The markdown style to use.",
+)
+def markdown(source, test, markdown_style):
+    """
+    Compares the strings SOURCE and TEST and outputs the redline as a markdown.
+
+    \f
+    @private
+    """
+    from rich import print
+
+    redlines = Redlines(source, test, markdown_style=markdown_style)
+    print(redlines.output_markdown)
diff --git a/redlines/processor.py b/redlines/processor.py
@@ -35,11 +35,11 @@
 """It is used to detect space."""
 
 
-def tokenize_text(text: str) -> list[str]:
+def tokenize_text(text: str) -> List[str]:
     return re.findall(tokenizer, text)
 
 
-def split_paragraphs(text: str) -> list[str]:
+def split_paragraphs(text: str) -> List[str]:
     """
     Splits a string into a list of paragraphs. One or more `\n` splits the paragraphs.
     For example, if the text is "Hello\nWorld\nThis is a test", the result will be:

diff --git a/repository-open-graph.png b/repository-open-graph.png
diff --git a/uv.lock b/uv.lock