streamdown 0.16.0__tar.gz → 0.18.0__tar.gz

{streamdown-0.16.0 → streamdown-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamdown
-Version: 0.16.0
+Version: 0.18.0
 Summary: A streaming markdown renderer for modern terminals with syntax highlighting
 Project-URL: Homepage, https://github.com/kristopolous/Streamdown
 Project-URL: Bug Tracker, https://github.com/kristopolous/Streamdown/issues
@@ -31,18 +31,22 @@ Description-Content-Type: text/markdown
 <img src=https://github.com/user-attachments/assets/0468eac0-2a00-4e98-82ca-09e6ac679357/>
 <br/>
 <a href=https://pypi.org/project/streamdown><img src=https://badge.fury.io/py/streamdown.svg/></a>
+<br/><strong>Terminal streaming markdown that rocks</strong>
+
 </p>
 
-The streaming markdown renderer for the terminal that rocks!
-Streamdown works with [simonw's llm](https://github.com/simonw/llm) along with any other streaming markdown. You even get full readline and keyboard navigation support.
+
+Streamdown works with [simonw's llm](https://github.com/simonw/llm) along with any other streaming markdown, even something basic like curl. 
+It supports standard piping like any normal pager and a clean `execvp` option for robustly wrapping around interactive programs with readline or their own ANSI stuff to manage.
 ```bash
 $ pip install streamdown
 ```
 ![Streamdown is Amazing](https://github.com/user-attachments/assets/268cb340-78cc-4df0-a773-c5ac95eceeeb)
 
 ### Provides clean copyable code for long code lines
-You may have noticed *inferior* renderers inject line breaks when copying code that wraps around. We're better and now you are too!
+Some *inferior* renderers inject line breaks when copying code that wraps around. We're better and now you are too!
 ![Handle That Mandle](https://github.com/user-attachments/assets/a27aa70c-f691-4796-84f0-c2eb18c7de23)
+**Tip**: You can make things prettier if you don't mind if this guarantee is broken. See the `PrettyBroken` flag below!
 
 ### Supports images
 Here's kitty and alacritty. Try to do that in glow...
@@ -57,6 +61,9 @@ Here's kitty and alacritty. Try to do that in glow...
 As well as everything else...
 ![dunder](https://github.com/user-attachments/assets/d41d7fec-6dec-4387-b53d-f2098f269a5e)
 
+Very ... Carefully ... Supported ... 
+![cjk1](https://github.com/user-attachments/assets/75162ade-4734-440e-aaa3-5ffc17a0dd46)
+
 ### Colors are highly (and quickly) configurable for people who care a lot, or just a little.
 ![configurable](https://github.com/user-attachments/assets/19ca2ec9-8ea1-4a79-87ca-8352789269fe)
 
@@ -67,7 +74,7 @@ For instance, here is the [latex plugin](https://github.com/kristopolous/Streamd
 
 ## TOML Configuration 
 
-Streamdown uses a TOML configuration file located at `~/.config/streamdown/config.toml` (following the XDG Base Directory Specification). If this file does not exist upon first run, it will be created with default values. 
+It's located at `~/.config/streamdown/config.toml` (following the XDG Base Directory Specification). If this file does not exist upon first run, it will be created with default values. 
 
 Here are the sections:
 
@@ -85,12 +92,15 @@ Defines the base Hue (H), Saturation (S), and Value (V) from which all other pal
 *   `Margin` (integer, default: `2`): The left and right indent for the output. 
 *   `Width` (integer, default: `0`): Along with the `Margin`, `Width` specifies the base width of the content, which when set to 0, means use the terminal width. See [#6](https://github.com/kristopolous/Streamdown/issues/6) for more details
 *   `PrettyPad` (boolean, default: `false`): Uses a unicode vertical pad trick to add a half height background to code blocks. This makes copy/paste have artifacts. See [#2](https://github.com/kristopolous/Streamdown/issues/2). I like it on. But that's just me
+*   `PrettyBroken` (boolean, default: `false`): This will break the copy/paste assurance above. The output is much prettier, but it's also broken. So it's pretty broken. Works nicely with PrettyPad.
 *   `ListIndent` (integer, default: `2`): This is the recursive indent for the list styles.
 *   `Syntax` (string, default `monokai`): This is the syntax [highlighting theme which come via pygments](https://pygments.org/styles/).
 
 Example:
 ```toml
 [style]
+PrettyPad = true
+PrettyBroken = true
 HSV = [0.7, 0.5, 0.5]
 Dark = { H = 1.0, S = 1.2, V = 0.25 } # Make dark elements less saturated and darker
 Symbol = { H = 1.0, S = 1.8, V = 1.8 } # Make symbols more vibrant
@@ -103,16 +113,13 @@ Controls optional features:
 *   `CodeSpaces` (boolean, default: `true`): Enables detection of code blocks indented with 4 spaces. Set to `false` to disable this detection method (triple-backtick blocks still work).
 *   `Clipboard` (boolean, default: `true`): Enables copying the last code block encountered to the system clipboard using OSC 52 escape sequences upon exit. Set to `false` to disable.
 *   `Logging` (boolean, default: `false`): Enables logging to tmpdir (/tmp/sd) of the raw markdown for debugging and bug reporting. The logging uses an emoji as a record separator so the actual streaming delays can be simulated and replayed. If you use the `filename` based invocation, that is to say, `sd <filename>`, this type of logging is always off.
-*   `Timeout` (float, default: `0.5`): This is a workaround to the [buffer parsing bugs](https://github.com/kristopolous/Streamdown/issues/4). By increasing the select timeout, the parser loop only gets triggerd on newline which means that having to resume from things like a code block, inside a list, inside a table, between buffers, without breaking formatting doesn't need to be done. I assert (2025-04-09) this is no longer a bug. Feel free to turn on `Logging` and post an issue if you find a repeatable one. 
+*   `Savebrace` (boolean, default: `true`): Saves the code blocks of a conversation to the append file `/tmp/sd/savebrace` so you can fzf or whatever you want through it. See how it's used in my [llmehelp](https://github.com/kristopolous/llmehelp) scripts, specifically `screen-query` and `sd-picker`.
 
 Example:
 ```toml
 [features]
 CodeSpaces = false
 Clipboard = false
-Margin = 4
-Width = 120
-Timeout = 1.0
 ```
 
 ## Command Line
@@ -146,7 +153,7 @@ Do this
     $ ./streamdown/sd.py tests/*md
 
 ## Install from source
-After the git clone least one of these should work, hopefully. it's using the modern uv pip tool.
+After the git clone least one of these should work, hopefully. it's using the modern uv pip tool but is also backwards compatible to the `pip3 install -r requirements.txt` flow.
 
     $ pipx install -e .
     $ pip install -e .
@@ -154,9 +161,5 @@ After the git clone least one of these should work, hopefully. it's using the mo
 
 ### Future work
 
-#### CSS
-I'm really considering using `tinycss2` and making an actual stylesheet engine. This is related to another problem - getting a modern HTML renderer in the terminal that is actually navigable. I *think* it's probably a separate project.
-
-#### scrape
-This is already partially implemented. The idea is every code block can get extracted and put in a directory so you can have a conversation to generate every piece of a project, similar to Aider, Claude or Goose,  but in the most hands-off yet still convenient way possible.
-
+#### Glow styles
+I'm going to try to be compatible with other popular markdown styles to help for a smoother transition. Glow compatible json sheets is on my radar. There's also mdless and frogmouth. Might be others

{streamdown-0.16.0 → streamdown-0.18.0}/README.md

@@ -2,18 +2,22 @@
 <img src=https://github.com/user-attachments/assets/0468eac0-2a00-4e98-82ca-09e6ac679357/>
 <br/>
 <a href=https://pypi.org/project/streamdown><img src=https://badge.fury.io/py/streamdown.svg/></a>
+<br/><strong>Terminal streaming markdown that rocks</strong>
+
 </p>
 
-The streaming markdown renderer for the terminal that rocks!
-Streamdown works with [simonw's llm](https://github.com/simonw/llm) along with any other streaming markdown. You even get full readline and keyboard navigation support.
+
+Streamdown works with [simonw's llm](https://github.com/simonw/llm) along with any other streaming markdown, even something basic like curl. 
+It supports standard piping like any normal pager and a clean `execvp` option for robustly wrapping around interactive programs with readline or their own ANSI stuff to manage.
 ```bash
 $ pip install streamdown
 ```
 ![Streamdown is Amazing](https://github.com/user-attachments/assets/268cb340-78cc-4df0-a773-c5ac95eceeeb)
 
 ### Provides clean copyable code for long code lines
-You may have noticed *inferior* renderers inject line breaks when copying code that wraps around. We're better and now you are too!
+Some *inferior* renderers inject line breaks when copying code that wraps around. We're better and now you are too!
 ![Handle That Mandle](https://github.com/user-attachments/assets/a27aa70c-f691-4796-84f0-c2eb18c7de23)
+**Tip**: You can make things prettier if you don't mind if this guarantee is broken. See the `PrettyBroken` flag below!
 
 ### Supports images
 Here's kitty and alacritty. Try to do that in glow...
@@ -28,6 +32,9 @@ Here's kitty and alacritty. Try to do that in glow...
 As well as everything else...
 ![dunder](https://github.com/user-attachments/assets/d41d7fec-6dec-4387-b53d-f2098f269a5e)
 
+Very ... Carefully ... Supported ... 
+![cjk1](https://github.com/user-attachments/assets/75162ade-4734-440e-aaa3-5ffc17a0dd46)
+
 ### Colors are highly (and quickly) configurable for people who care a lot, or just a little.
 ![configurable](https://github.com/user-attachments/assets/19ca2ec9-8ea1-4a79-87ca-8352789269fe)
 
@@ -38,7 +45,7 @@ For instance, here is the [latex plugin](https://github.com/kristopolous/Streamd
 
 ## TOML Configuration 
 
-Streamdown uses a TOML configuration file located at `~/.config/streamdown/config.toml` (following the XDG Base Directory Specification). If this file does not exist upon first run, it will be created with default values. 
+It's located at `~/.config/streamdown/config.toml` (following the XDG Base Directory Specification). If this file does not exist upon first run, it will be created with default values. 
 
 Here are the sections:
 
@@ -56,12 +63,15 @@ Defines the base Hue (H), Saturation (S), and Value (V) from which all other pal
 *   `Margin` (integer, default: `2`): The left and right indent for the output. 
 *   `Width` (integer, default: `0`): Along with the `Margin`, `Width` specifies the base width of the content, which when set to 0, means use the terminal width. See [#6](https://github.com/kristopolous/Streamdown/issues/6) for more details
 *   `PrettyPad` (boolean, default: `false`): Uses a unicode vertical pad trick to add a half height background to code blocks. This makes copy/paste have artifacts. See [#2](https://github.com/kristopolous/Streamdown/issues/2). I like it on. But that's just me
+*   `PrettyBroken` (boolean, default: `false`): This will break the copy/paste assurance above. The output is much prettier, but it's also broken. So it's pretty broken. Works nicely with PrettyPad.
 *   `ListIndent` (integer, default: `2`): This is the recursive indent for the list styles.
 *   `Syntax` (string, default `monokai`): This is the syntax [highlighting theme which come via pygments](https://pygments.org/styles/).
 
 Example:
 ```toml
 [style]
+PrettyPad = true
+PrettyBroken = true
 HSV = [0.7, 0.5, 0.5]
 Dark = { H = 1.0, S = 1.2, V = 0.25 } # Make dark elements less saturated and darker
 Symbol = { H = 1.0, S = 1.8, V = 1.8 } # Make symbols more vibrant
@@ -74,16 +84,13 @@ Controls optional features:
 *   `CodeSpaces` (boolean, default: `true`): Enables detection of code blocks indented with 4 spaces. Set to `false` to disable this detection method (triple-backtick blocks still work).
 *   `Clipboard` (boolean, default: `true`): Enables copying the last code block encountered to the system clipboard using OSC 52 escape sequences upon exit. Set to `false` to disable.
 *   `Logging` (boolean, default: `false`): Enables logging to tmpdir (/tmp/sd) of the raw markdown for debugging and bug reporting. The logging uses an emoji as a record separator so the actual streaming delays can be simulated and replayed. If you use the `filename` based invocation, that is to say, `sd <filename>`, this type of logging is always off.
-*   `Timeout` (float, default: `0.5`): This is a workaround to the [buffer parsing bugs](https://github.com/kristopolous/Streamdown/issues/4). By increasing the select timeout, the parser loop only gets triggerd on newline which means that having to resume from things like a code block, inside a list, inside a table, between buffers, without breaking formatting doesn't need to be done. I assert (2025-04-09) this is no longer a bug. Feel free to turn on `Logging` and post an issue if you find a repeatable one. 
+*   `Savebrace` (boolean, default: `true`): Saves the code blocks of a conversation to the append file `/tmp/sd/savebrace` so you can fzf or whatever you want through it. See how it's used in my [llmehelp](https://github.com/kristopolous/llmehelp) scripts, specifically `screen-query` and `sd-picker`.
 
 Example:
 ```toml
 [features]
 CodeSpaces = false
 Clipboard = false
-Margin = 4
-Width = 120
-Timeout = 1.0
 ```
 
 ## Command Line
@@ -117,7 +124,7 @@ Do this
     $ ./streamdown/sd.py tests/*md
 
 ## Install from source
-After the git clone least one of these should work, hopefully. it's using the modern uv pip tool.
+After the git clone least one of these should work, hopefully. it's using the modern uv pip tool but is also backwards compatible to the `pip3 install -r requirements.txt` flow.
 
     $ pipx install -e .
     $ pip install -e .
@@ -125,9 +132,5 @@ After the git clone least one of these should work, hopefully. it's using the mo
 
 ### Future work
 
-#### CSS
-I'm really considering using `tinycss2` and making an actual stylesheet engine. This is related to another problem - getting a modern HTML renderer in the terminal that is actually navigable. I *think* it's probably a separate project.
-
-#### scrape
-This is already partially implemented. The idea is every code block can get extracted and put in a directory so you can have a conversation to generate every piece of a project, similar to Aider, Claude or Goose,  but in the most hands-off yet still convenient way possible.
-
+#### Glow styles
+I'm going to try to be compatible with other popular markdown styles to help for a smoother transition. Glow compatible json sheets is on my radar. There's also mdless and frogmouth. Might be others

{streamdown-0.16.0 → streamdown-0.18.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "streamdown"
-version = "0.16.0"
+version = "0.18.0"
 description = "A streaming markdown renderer for modern terminals with syntax highlighting"
 readme = "README.md"
 requires-python = ">=3.8"

streamdown-0.18.0/requirements.txt

@@ -0,0 +1,5 @@
+pygments
+pylatexenc
+appdirs
+term-image
+toml

streamdown-0.18.0/ss-new.py

@@ -0,0 +1,45 @@
+import os
+import pty
+import sys
+import tty
+import termios
+import select
+import re
+
+def main():
+    orig_attrs = termios.tcgetattr(sys.stdin)
+    try:
+        tty.setraw(sys.stdin)
+        pid, fd = pty.fork()
+
+        if pid == 0:
+            # Child process: run any command
+            os.execvp("llm", ["llm", "chat"])
+        else:
+            buffer = b""
+
+            while True:
+                r, _, _ = select.select([fd, sys.stdin], [], [])
+
+                if sys.stdin in r:
+                    data = os.read(sys.stdin.fileno(), 1024)
+                    if not data:
+                        break
+                    os.write(fd, data)
+
+                if fd in r:
+                    data = os.read(fd, 1024)
+                    if not data:
+                        break
+
+                    buffer += data
+                    # Replace "fizz" only in printable content
+                    output = re.sub(rb'fizz', b'fizzbuzz', buffer)
+                    os.write(sys.stdout.fileno(), output)
+                    buffer = b""
+    finally:
+        termios.tcsetattr(sys.stdin, termios.TCSADRAIN, orig_attrs)
+
+if __name__ == "__main__":
+    main()
+

streamdown-0.18.0/ss.py

@@ -0,0 +1,69 @@
+import os
+import pty
+import select
+import sys
+import tty
+import termios
+import fcntl
+import struct
+
+def set_pty_size(fd, target_fd):
+    """Set window size of PTY to match the real terminal."""
+    s = fcntl.ioctl(target_fd, termios.TIOCGWINSZ, b"\x00" * 8)
+    fcntl.ioctl(fd, termios.TIOCSWINSZ, s)
+
+def main():
+    # Save original terminal settings
+    orig_attrs = termios.tcgetattr(sys.stdin.fileno())
+    try:
+        tty.setraw(sys.stdin.fileno())  # raw mode to send Ctrl-C, etc.
+        pid, fd = pty.fork()
+
+        if pid == 0:
+            os.execvp("bash", ["bash"])
+        else:
+            set_pty_size(fd, sys.stdin.fileno())
+
+            while True:
+                r, _, _ = select.select([fd, sys.stdin], [], [])
+
+                if sys.stdin in r:
+                    user_input = os.read(sys.stdin.fileno(), 1024)
+                    if not user_input:
+                        break
+                    os.write(fd, user_input)
+
+                if fd in r:
+                    output = os.read(fd, 1024)
+                    if not output:
+                        break
+
+                    # Carefully handle ANSI sequences
+                    # Split on ANSI escape sequences to avoid breaking them
+                    chunks = []
+                    i = 0
+                    while i < len(output):
+                        if output[i:i+1] == b'\x1b':
+                            end = i + 1
+                            while end < len(output) and not (64 <= output[end] <= 126):
+                                end += 1
+                            end += 1  # include final letter
+                            chunks.append(output[i:end])
+                            i = end
+                        else:
+                            j = i
+                            while j < len(output) and output[j:j+1] != b'\x1b':
+                                j += 1
+                            # Perform replacement on plain text only
+                            text = output[i:j].replace(b"fizz", b"fizzbuzz")
+                            chunks.append(text)
+                            i = j
+
+                    os.write(sys.stdout.fileno(), b''.join(chunks))
+
+    finally:
+        termios.tcsetattr(sys.stdin.fileno(), termios.TCSADRAIN, orig_attrs)
+
+if __name__ == "__main__":
+    main()
+