streamdown 0.31.0__tar.gz → 0.32.0__tar.gz

{streamdown-0.31.0 → streamdown-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamdown
-Version: 0.31.0
+Version: 0.32.0
 Summary: A streaming markdown renderer for modern terminals with syntax highlighting
 Project-URL: Homepage, https://github.com/day50-dev/Streamdown
 Project-URL: Bug Tracker, https://github.com/day50-dev/Streamdown/issues
@@ -39,7 +39,7 @@ Description-Content-Type: text/markdown
 
 Streamdown works with any streaming markdown such as [simonw's llm](https://github.com/simonw/llm) or even something basic like curl. 
 
-It just works. 
+It's made to be compatible with and consistently render the wide variety of markdown from various llms. 
 
 It supports standard piping and files as arguments like any normal pager but can also run as a wrapper so you retain full keyboard interactivity. Arrow keys, control, alt, all still work.
 ```bash
@@ -97,7 +97,7 @@ It is designed for AI and can be used to do parser based sophisticated pipelines
 You can also just use it like a normal person.
 ## Configuration 
 
-It's located at `~/.config/streamdown/config.toml` in Linux and `~/Library/Application Support/streamdown/config.toml` in macOS. If this file does not exist upon first run, it will be created with default values. 
+The location it's stored is platform specific and can be seen with the `-h` flag. If this file does not exist upon first run, it will be created with default values. 
 
 Here are the sections:
 
@@ -138,7 +138,7 @@ 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.
-*   `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`.
+*   `Savebrace` (boolean, default: `true`): Saves the code blocks of a conversation to the append file `$TMP/sd/$UID/savebrace` so you can `fzf` or whatever you want through it. See how it's used in DAY50's [sidechat](https://github.com/day50-dev/sidechat).
 
 Example:
 ```toml
@@ -154,7 +154,7 @@ The most exciting feature here is `--exec` with it you can do full readline supp
 $ sd --exec "llm chat"
 ```
 
-And now you have all your readline stuff. It's pretty great. (Also see the Day50 shellwrap project.)
+And now you have all your readline stuff. It's pretty great. (Also see the DAY50 shellwrap project.)
 
 It's also worth noting that things like the `-c` aren't "broken" with regard to file input. You can do something like this:
 
@@ -168,7 +168,12 @@ To override the margin.
 usage: sd [-h] [-l LOGLEVEL] [-b BASE] [-c CONFIG] [-w WIDTH] [-e EXEC]
           [-s SCRAPE] [filenameList ...]
 
-Streamdown - A Streaming markdown renderer for modern terminals
+Streamdown is a Streaming markdown renderer for modern terminals.
+https://github.com/day50-dev/Streamdown
+
+paths:
+  config                /home/chris/.config/streamdown/config.toml
+  logs                  /tmp/sd/1000
 
 positional arguments:
   filenameList          Input file to process (also takes stdin)
@@ -185,8 +190,11 @@ optional arguments:
   -e EXEC, --exec EXEC  Wrap a program EXEC for more 'proper' i/o handling
   -s SCRAPE, --scrape SCRAPE
                         Scrape code snippets to a directory SCRAPE
+  -v, --version         Show version information
 ```
 
+**Note**: Some features are not supported on some OSs. Please file a ticket if you need a feature on your platform that isn't working.
+
 ## Demo
 Do this
 

{streamdown-0.31.0 → streamdown-0.32.0}/README.md

@@ -9,7 +9,7 @@
 
 Streamdown works with any streaming markdown such as [simonw's llm](https://github.com/simonw/llm) or even something basic like curl. 
 
-It just works. 
+It's made to be compatible with and consistently render the wide variety of markdown from various llms. 
 
 It supports standard piping and files as arguments like any normal pager but can also run as a wrapper so you retain full keyboard interactivity. Arrow keys, control, alt, all still work.
 ```bash
@@ -67,7 +67,7 @@ It is designed for AI and can be used to do parser based sophisticated pipelines
 You can also just use it like a normal person.
 ## Configuration 
 
-It's located at `~/.config/streamdown/config.toml` in Linux and `~/Library/Application Support/streamdown/config.toml` in macOS. If this file does not exist upon first run, it will be created with default values. 
+The location it's stored is platform specific and can be seen with the `-h` flag. If this file does not exist upon first run, it will be created with default values. 
 
 Here are the sections:
 
@@ -108,7 +108,7 @@ 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.
-*   `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`.
+*   `Savebrace` (boolean, default: `true`): Saves the code blocks of a conversation to the append file `$TMP/sd/$UID/savebrace` so you can `fzf` or whatever you want through it. See how it's used in DAY50's [sidechat](https://github.com/day50-dev/sidechat).
 
 Example:
 ```toml
@@ -124,7 +124,7 @@ The most exciting feature here is `--exec` with it you can do full readline supp
 $ sd --exec "llm chat"
 ```
 
-And now you have all your readline stuff. It's pretty great. (Also see the Day50 shellwrap project.)
+And now you have all your readline stuff. It's pretty great. (Also see the DAY50 shellwrap project.)
 
 It's also worth noting that things like the `-c` aren't "broken" with regard to file input. You can do something like this:
 
@@ -138,7 +138,12 @@ To override the margin.
 usage: sd [-h] [-l LOGLEVEL] [-b BASE] [-c CONFIG] [-w WIDTH] [-e EXEC]
           [-s SCRAPE] [filenameList ...]
 
-Streamdown - A Streaming markdown renderer for modern terminals
+Streamdown is a Streaming markdown renderer for modern terminals.
+https://github.com/day50-dev/Streamdown
+
+paths:
+  config                /home/chris/.config/streamdown/config.toml
+  logs                  /tmp/sd/1000
 
 positional arguments:
   filenameList          Input file to process (also takes stdin)
@@ -155,8 +160,11 @@ optional arguments:
   -e EXEC, --exec EXEC  Wrap a program EXEC for more 'proper' i/o handling
   -s SCRAPE, --scrape SCRAPE
                         Scrape code snippets to a directory SCRAPE
+  -v, --version         Show version information
 ```
 
+**Note**: Some features are not supported on some OSs. Please file a ticket if you need a feature on your platform that isn't working.
+
 ## Demo
 Do this
 

{streamdown-0.31.0 → streamdown-0.32.0}/pyproject.toml

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

{streamdown-0.31.0 → streamdown-0.32.0}/streamdown/sd.py

@@ -37,6 +37,8 @@ from term_image.image import from_file, from_url
 import pygments.util
 from wcwidth import wcwidth
 from functools import reduce
+import textwrap
+import argparse
 from argparse import ArgumentParser
 from pygments import highlight
 from pygments.lexers import get_lexer_by_name
@@ -119,7 +121,12 @@ split_up = lambda line: re.findall(r'(\x1b[^m]*m|[^\x1b]*)', line)
 def gettmpdir():
     tmp_dir_all = os.path.join(tempfile.gettempdir(), "sd")
     os.makedirs(tmp_dir_all, mode=0o777, exist_ok=True)
-    tmp_dir = os.path.join(tmp_dir_all, str(os.getuid()))
+
+    if os.name != 'nt':
+        tmp_dir = os.path.join(tmp_dir_all, str(os.getuid()))
+    else:
+        tmp_dir = tmp_dir_all
+
     os.makedirs(tmp_dir, exist_ok=True)
     return tmp_dir
 
@@ -1079,7 +1086,15 @@ def width_calc():
     ]
 
 def main():
-    parser = ArgumentParser(description="Streamdown - A Streaming markdown renderer for modern terminals.  Latest version: https://github.com/day50-dev/Streamdown")
+    parser = ArgumentParser(
+            formatter_class=argparse.RawDescriptionHelpFormatter, description=textwrap.dedent(f"""
+    Streamdown is a Streaming markdown renderer for modern terminals.
+    https://github.com/day50-dev/Streamdown
+
+    paths:
+      config                {os.path.join(appdirs.user_config_dir('streamdown'), 'config.toml')}
+      logs                  {gettmpdir()}
+    """))
     parser.add_argument("filenameList", nargs="*", help="Input file to process (also takes stdin)")
     parser.add_argument("-l", "--loglevel", default="INFO", help="Set the logging level")
     parser.add_argument("-b", "--base", default=None, help="Set the hsv base: h,s,v")