mdhtml2term 0.1.0__py3-none-any.whl

mdhtml2term/__init__.py

@@ -0,0 +1,3 @@
+__version__ = "0.1.0"
+
+from .core import md_blocks

mdhtml2term/core.py

@@ -0,0 +1,127 @@
+"Render MDHTML Markdown as Rich renderables for the terminal, one per top-level block."
+import mdhtml
+from fastcore.meta import delegates
+from rich import box
+from rich.cells import cell_len
+from rich.console import Group
+from rich.segment import Segment
+from rich.style import Style
+from rich.syntax import Syntax
+from rich.table import Table
+from rich.text import Text
+
+__all__ = ['md_blocks']
+
+INLINE = {'strong': 'bold', 'em': 'italic', 'code': 'cyan', 'del': 'strike', 'a': 'underline bright_blue', 'mark': 'reverse'}
+HEADINGS = {'h1', 'h2', 'h3', 'h4', 'h5', 'h6'}
+BLOCKS = HEADINGS | {'p', 'pre', 'ul', 'ol', 'blockquote', 'hr', 'table', 'div', 'section', 'aside', 'figure', 'figcaption', 'details', 'summary', 'dl', 'dt', 'dd'}
+
+class Prefixed:
+    "Renders `rends` one after another, with `first` before the first line and `rest` before each later line"
+    def __init__(self, rends, first, rest=None, style=''):
+        self.rends,self.first,self.rest = rends,first,first if rest is None else rest
+        self.style = Style.parse(style) if style else None
+
+    def __rich_console__(self, console, options):
+        opts = options.update_width(max(1, options.max_width - cell_len(self.first)))
+        lines = [l for r in self.rends for l in console.render_lines(r, opts, pad=False)] or [[]]
+        for i,line in enumerate(lines):
+            yield Segment(self.first if i == 0 else self.rest, self.style)
+            yield from line
+            yield Segment.line()
+
+def _elem(c, t, style=''):
+    nm = getattr(c, 'name', None)
+    if nm == '#text': return t.append(c.text, style=style or None)
+    if nm == 'br': return t.append('\n')
+    a = c.attrs or {}
+    if nm == 'img': return t.append(f"[{a.get('alt') or 'image'}]", style=f'{style} dim'.strip())
+    if nm == 'input' and a.get('type') == 'checkbox': return t.append('[x]' if 'checked' in a else '[ ]', style=style or None)
+    sty = f"{style} {INLINE.get(nm, '')}".strip()
+    href = nm == 'a' and a.get('href')
+    if href: sty = f'{sty} link {href}'
+    n = len(t)
+    _inline(c, t, sty)
+    if href and t.plain[n:] != href: t.append(f' ({href})', style='dim')
+
+def _inline(node, t, style=''):
+    for c in node.children: _elem(c, t, style)
+    return t
+
+def _find(el, name):
+    for c in getattr(el, 'children', []):
+        if getattr(c, 'name', None) == name: yield c
+        else: yield from _find(c, name)
+
+def _code_block(pre, theme):
+    code = next(_find(pre, 'code'), None)
+    if code is None: return _inline(pre, Text())
+    src = ''.join(c.text for c in code.children if getattr(c, 'name', None) == '#text')
+    cls = (code.attrs or {}).get('class') or ''
+    lang = next((w.removeprefix('language-') for w in cls.split() if w.startswith('language-')), 'text')
+    return Syntax(src.rstrip('\n'), lang, theme=theme)
+
+def _list(el, theme):
+    ordered = el.name == 'ol'
+    n = int((el.attrs or {}).get('start', 1))
+    items = []
+    for li in el.children:
+        if getattr(li, 'name', None) != 'li': continue
+        bullet = f'{n}. ' if ordered else '• '
+        items.append(Prefixed(_blocks(li, theme), bullet, ' ' * cell_len(bullet), style='bold'))
+        n += 1
+    return Group(*items)
+
+def _cells(tr): return [c for c in tr.children if getattr(c, 'name', None) in ('td', 'th')]
+
+def _table(el):
+    head, rows = None, []
+    for sec in el.children:
+        nm = getattr(sec, 'name', None)
+        if nm == 'thead': head = next(_find(sec, 'tr'), None)
+        elif nm in ('tbody', 'tfoot'): rows += list(_find(sec, 'tr'))
+        elif nm == 'tr': rows.append(sec)
+    first = head if head is not None else rows[0] if rows else None
+    t = Table(box=box.SIMPLE_HEAD, show_header=head is not None, show_edge=False, pad_edge=False)
+    if first is None: return t
+    for c in _cells(first): t.add_column(_inline(c, Text()) if head is not None else '', justify=(c.attrs or {}).get('align') or 'left')
+    for tr in rows: t.add_row(*[_inline(c, Text()) for c in _cells(tr)])
+    return t
+
+def _block(el, theme):
+    nm = el.name
+    if nm in HEADINGS: return _inline(el, Text('#' * int(nm[1]) + ' ', style='bold magenta'), 'bold magenta')
+    if nm == 'p': return _inline(el, Text())
+    if nm == 'pre': return _code_block(el, theme)
+    if nm in ('ul', 'ol'): return _list(el, theme)
+    if nm == 'blockquote': return Prefixed(_blocks(el, theme), '│ ', style='dim')
+    if nm == 'hr': return Text('─' * 40, style='dim')
+    if nm == 'table': return _table(el)
+    return Group(*_blocks(el, theme))
+
+def _blocks(el, theme):
+    "One renderable per block child of `el`, plus one `Text` per run of inline content between them"
+    out, t = [], Text()
+    def flush():
+        nonlocal t
+        t.rstrip()
+        if t.plain: out.append(t)
+        t = Text()
+    for c in getattr(el, 'children', []):
+        nm = getattr(c, 'name', None)
+        if nm in BLOCKS:
+            flush()
+            out.append(_block(c, theme))
+        elif nm == '#text' and not t.plain: t.append(c.text.lstrip())
+        else: _elem(c, t)
+    flush()
+    return out
+
+@delegates(mdhtml.md2dom)
+def md_blocks(
+    md:str, # Markdown source
+    theme:str='ansi_dark', # Pygments theme for code blocks
+    **kwargs
+):
+    "One Rich renderable per top-level block of `md`"
+    return _blocks(mdhtml.md2dom(md, **kwargs), theme)

mdhtml2term-0.1.0.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: mdhtml2term
+Version: 0.1.0
+Summary: Render MDHTML in the terminal with Rich
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/mdhtml2term
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mdhtml>=0.1.39
+Requires-Dist: fastcore
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# mdhtml2term
+
+Render [MDHTML](https://github.com/AnswerDotAI/mdhtml) Markdown in the terminal with [Rich](https://github.com/Textualize/rich).
+
+`md_blocks` parses Markdown with `mdhtml` and returns one Rich renderable per top-level block. A terminal app can then print, fold or replace each block on its own. ipyai uses it to render AI replies.
+
+## Install
+
+```bash
+pip install mdhtml2term
+```
+
+## Usage
+
+```python
+from rich.console import Console
+from mdhtml2term import md_blocks
+
+console = Console()
+for block in md_blocks(markdown_text): console.print(block)
+```
+
+`md_blocks` takes a Markdown string and returns a list of Rich renderables. `theme` names the Pygments theme for code blocks, and defaults to `ansi_dark`. Other keyword arguments go to `mdhtml.md2dom`.
+
+## Supported content
+
+- Headings, paragraphs, block quotes, lists, code blocks, tables and horizontal rules. Block quotes and list items can hold any other block, including code and further quotes.
+- Bold, italic, inline code, strikethrough, highlight and line breaks.
+- Links, as OSC 8 hyperlinks followed by their address in brackets.
+- Images, as their alt text in square brackets.
+- Task list checkboxes, as `[ ]` and `[x]`.
+- A numbered list that resumes after other content keeps its numbering.
+
+Other inline elements show their text. Other block containers render their children.

mdhtml2term-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+mdhtml2term/__init__.py,sha256=l1uFtn4AIPYK_zfdrdh7Q4xsiJWBN7O_4XGB0NYJ8qA,51
+mdhtml2term/core.py,sha256=i-OoZ1m_TJqavGshqnmqNoN9H1GA19pY2QQt5b6VoHE,5301
+mdhtml2term-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+mdhtml2term-0.1.0.dist-info/METADATA,sha256=SuhLYAHgCOxssZF5Uyn0oDFuq2FxvwjYZLkAGQBu2Zw,2076
+mdhtml2term-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+mdhtml2term-0.1.0.dist-info/top_level.txt,sha256=e7Lrwn6wolBksdBx7XRo8qpKHLdRdXQaq9hsbP7vXu4,12
+mdhtml2term-0.1.0.dist-info/RECORD,,

mdhtml2term-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mdhtml2term-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mdhtml2term-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+mdhtml2term