markrender 1.0.0__tar.gz

markrender-1.0.0/.gitignore

@@ -0,0 +1,66 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+*.log

markrender-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Praneeth Gandodi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

markrender-1.0.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: markrender
+Version: 1.0.0
+Summary: Professional terminal markdown renderer for streaming LLM responses
+Author: Praneeth Gandodi
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Praneeth-Gandodi/markrender
+Project-URL: Documentation, https://github.com/Praneeth-Gandodi/markrender#readme
+Project-URL: Repository, https://github.com/Praneeth-Gandodi/markrender
+Project-URL: Bug Tracker, https://github.com/Praneeth-Gandodi/markrender/issues
+Keywords: markdown,terminal,rendering,streaming,llm,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygments~=2.19.2
+Requires-Dist: emoji~=2.15.0
+Requires-Dist: rich~=14.3.2
+Requires-Dist: colorama~=0.4.6
+Provides-Extra: dev
+Requires-Dist: pytest~=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov~=2.10.0; extra == "dev"
+Dynamic: license-file
+
+# MarkRender 🎨
+
+**A professional terminal markdown renderer built for streaming LLM responses.**
+
+MarkRender is a Python library designed to bring beautifully rendered markdown directly to your terminal. It's especially good for displaying streaming output from large language models, ensuring a smooth, flicker-free experience with rich formatting and syntax highlighting.
+
+## ✨ Features You'll Love
+
+* **Streaming Optimized**: Renders markdown chunks as they arrive, perfect for LLM interactions.
+* **Gorgeous Themes**: Comes with several built-in color themes to match your terminal aesthetic.
+* **Smart Syntax Highlighting**: Powered by Pygments, it makes your code blocks pop.
+* **Full Markdown Support**: Handles everything from headings and lists to tables, checkboxes, emojis, and links with robust streaming support.
+* **Cross-Platform**: Works on Windows, macOS, and Linux.
+
+## 🚀 Get Started
+
+### Installation
+
+It's super easy to get MarkRender up and running:
+
+```bash
+pip install git+https://github.com/Praneeth-Gandodi/markrender.git
+```
+
+Or, for development, clone the repository and install in editable mode:
+```bash
+git clone https://github.com/Praneeth-Gandodi/markrender.git
+cd markrender
+pip install -e .
+```
+
+### Quick Usage
+
+Here's how to render a simple markdown string
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer() 
+
+markdown_text = """
+# Project Title  
+This is a comprehensive markdown example that demonstrates various features.  
+It includes headers, lists, links, images, and code blocks.  
+
+## Subsection Explanation  
+- **Headers** are defined using `#` symbols.  
+- **Lists** can be ordered or unordered.  
+- **Links** use the syntax: `[text](url)`.  
+- **Images** are added via `![alternative text](path)`.  
+
+---
+
+### Installation 
+To get started, run the following command in your terminal:  
+`pip install markrender`
+
+### Feature Comparison
+| Feature | Syntax |
+| :--- | :--- |
+| Bold | **text** |
+| Italic | *text* |
+| Inline Code | `code` |
+
+> **Note:** Ensure your renderer is finalized after use to prevent memory leaks.
+"""
+
+renderer.render(markdown_text)
+renderer.finalize()
+```
+
+How to render streaming api responses
+
+```python
+from openai import OpenAI
+
+renderer = MarkdownRenderer(theme='github-dark', line_numbers=True)
+
+API_KEY = # Your openai api key
+
+client = OpenAI(api_key=API_KEY)
+
+stream = client.chat.completions.create(
+    model="openai/gpt-oss-120b",
+    messages=[
+    {
+        "role": "system",
+        "content": "You are a highly capable AI assistant that answers clearly and concisely."
+    },
+    {
+        "role": "user",
+        "content": "Whats the difference between C and C++?"
+    }
+    ],
+    stream=True
+)
+for chunk in stream:
+    data = chunk.choices[0].delta.content
+    if data: 
+        renderer.render(data)
+
+renderer.finalize() 
+```
+
+## 🎨 Advanced Configuration
+
+You can customize the renderer's appearance and behavior with the following parameters:
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer(
+    theme='monokai',         # Set the color style
+    line_numbers=True,       # Show numbers next to code lines
+    code_background=True,    # Add a background color to code blocks
+    force_color=True,        # Always show colors
+    stream_code=True         # Render code blocks line-by-line
+)
+```
+
+### Non-Streaming Code Blocks
+
+If you prefer to render code blocks all at once after the entire block has been received, you can set `stream_code=False`. This is useful if you want to avoid seeing incomplete code blocks during streaming.
+
+```python
+renderer = MarkdownRenderer(stream_code=False)
+```
+
+## Available themes
+
+* github-dark
+* monokai
+* dracula
+* nord
+* one-dark
+* solarized-dark
+* solarized-light
+
+
+---
+
+## 📊 Table Rendering Excellence
+
+MarkRender provides robust table rendering powered by the `rich` library. Tables are beautifully formatted with proper alignment, borders, and theme-appropriate colors. The renderer handles streaming edge cases gracefully, ensuring tables render correctly even when content arrives in chunks.
+
+## 🤝 Contributing
+
+We welcome contributions! Feel free to open issues or pull requests on our [GitHub repository](https://github.com/Praneeth-Gandodi/markrender).
+
+## 📄 License
+
+MarkRender is released under the MIT License. See the [LICENSE](LICENSE) file for more details.

markrender-1.0.0/README.md

@@ -0,0 +1,152 @@
+# MarkRender 🎨
+
+**A professional terminal markdown renderer built for streaming LLM responses.**
+
+MarkRender is a Python library designed to bring beautifully rendered markdown directly to your terminal. It's especially good for displaying streaming output from large language models, ensuring a smooth, flicker-free experience with rich formatting and syntax highlighting.
+
+## ✨ Features You'll Love
+
+* **Streaming Optimized**: Renders markdown chunks as they arrive, perfect for LLM interactions.
+* **Gorgeous Themes**: Comes with several built-in color themes to match your terminal aesthetic.
+* **Smart Syntax Highlighting**: Powered by Pygments, it makes your code blocks pop.
+* **Full Markdown Support**: Handles everything from headings and lists to tables, checkboxes, emojis, and links with robust streaming support.
+* **Cross-Platform**: Works on Windows, macOS, and Linux.
+
+## 🚀 Get Started
+
+### Installation
+
+It's super easy to get MarkRender up and running:
+
+```bash
+pip install git+https://github.com/Praneeth-Gandodi/markrender.git
+```
+
+Or, for development, clone the repository and install in editable mode:
+```bash
+git clone https://github.com/Praneeth-Gandodi/markrender.git
+cd markrender
+pip install -e .
+```
+
+### Quick Usage
+
+Here's how to render a simple markdown string
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer() 
+
+markdown_text = """
+# Project Title  
+This is a comprehensive markdown example that demonstrates various features.  
+It includes headers, lists, links, images, and code blocks.  
+
+## Subsection Explanation  
+- **Headers** are defined using `#` symbols.  
+- **Lists** can be ordered or unordered.  
+- **Links** use the syntax: `[text](url)`.  
+- **Images** are added via `![alternative text](path)`.  
+
+---
+
+### Installation 
+To get started, run the following command in your terminal:  
+`pip install markrender`
+
+### Feature Comparison
+| Feature | Syntax |
+| :--- | :--- |
+| Bold | **text** |
+| Italic | *text* |
+| Inline Code | `code` |
+
+> **Note:** Ensure your renderer is finalized after use to prevent memory leaks.
+"""
+
+renderer.render(markdown_text)
+renderer.finalize()
+```
+
+How to render streaming api responses
+
+```python
+from openai import OpenAI
+
+renderer = MarkdownRenderer(theme='github-dark', line_numbers=True)
+
+API_KEY = # Your openai api key
+
+client = OpenAI(api_key=API_KEY)
+
+stream = client.chat.completions.create(
+    model="openai/gpt-oss-120b",
+    messages=[
+    {
+        "role": "system",
+        "content": "You are a highly capable AI assistant that answers clearly and concisely."
+    },
+    {
+        "role": "user",
+        "content": "Whats the difference between C and C++?"
+    }
+    ],
+    stream=True
+)
+for chunk in stream:
+    data = chunk.choices[0].delta.content
+    if data: 
+        renderer.render(data)
+
+renderer.finalize() 
+```
+
+## 🎨 Advanced Configuration
+
+You can customize the renderer's appearance and behavior with the following parameters:
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer(
+    theme='monokai',         # Set the color style
+    line_numbers=True,       # Show numbers next to code lines
+    code_background=True,    # Add a background color to code blocks
+    force_color=True,        # Always show colors
+    stream_code=True         # Render code blocks line-by-line
+)
+```
+
+### Non-Streaming Code Blocks
+
+If you prefer to render code blocks all at once after the entire block has been received, you can set `stream_code=False`. This is useful if you want to avoid seeing incomplete code blocks during streaming.
+
+```python
+renderer = MarkdownRenderer(stream_code=False)
+```
+
+## Available themes
+
+* github-dark
+* monokai
+* dracula
+* nord
+* one-dark
+* solarized-dark
+* solarized-light
+
+
+---
+
+## 📊 Table Rendering Excellence
+
+MarkRender provides robust table rendering powered by the `rich` library. Tables are beautifully formatted with proper alignment, borders, and theme-appropriate colors. The renderer handles streaming edge cases gracefully, ensuring tables render correctly even when content arrives in chunks.
+
+## 🤝 Contributing
+
+We welcome contributions! Feel free to open issues or pull requests on our [GitHub repository](https://github.com/Praneeth-Gandodi/markrender).
+
+## 📄 License
+
+MarkRender is released under the MIT License. See the [LICENSE](LICENSE) file for more details.

markrender-1.0.0/check_truecolor.py

@@ -0,0 +1,30 @@
+
+from pygments import highlight
+from pygments.lexers import PythonLexer
+from pygments.formatters import Terminal256Formatter, TerminalTrueColorFormatter
+from rich.text import Text
+from rich.console import Console
+
+code = "def hello():\n    print('world')"
+lexer = PythonLexer()
+
+print("--- Terminal256Formatter ---")
+formatter256 = Terminal256Formatter(style='monokai')
+ansi256 = highlight(code, lexer, formatter256)
+rich_text256 = Text.from_ansi(ansi256)
+print(f"ANSI len: {len(ansi256)}")
+print(f"First span style: {rich_text256.spans[0] if rich_text256.spans else 'None'}")
+
+print("\n--- TerminalTrueColorFormatter ---")
+formatterTC = TerminalTrueColorFormatter(style='monokai')
+ansiTC = highlight(code, lexer, formatterTC)
+rich_textTC = Text.from_ansi(ansiTC)
+print(f"ANSI len: {len(ansiTC)}")
+print(f"First span style: {rich_textTC.spans[0] if rich_textTC.spans else 'None'}")
+
+print("\n--- Visual Check ---")
+console = Console()
+console.print("256:")
+console.print(rich_text256)
+console.print("TrueColor:")
+console.print(rich_textTC)

markrender-1.0.0/examples/basic_usage.py

@@ -0,0 +1,76 @@
+"""
+Basic usage example for MarkRender
+Demonstrates rendering static markdown content
+"""
+
+from markrender import MarkdownRenderer
+
+
+def main():
+    """Basic markdown rendering example"""
+    
+    # Create renderer with default theme
+    renderer = MarkdownRenderer(theme='github-dark')
+    
+    # Sample markdown content
+    markdown = """
+# MarkRender Demo
+
+Welcome to **MarkRender** - a professional terminal markdown renderer!
+
+## Features
+
+Here are some key features:
+
+- 🎨 Beautiful syntax highlighting
+- 📊 Table rendering
+- ✅ Task lists
+- 😊 Emoji support
+- And much more!
+
+## Code Example
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer()
+renderer.render("# Hello World")
+renderer.finalize()
+```
+
+## Task List
+
+- [x] Install MarkRender
+- [x] Read documentation
+- [ ] Build something awesome!
+
+## Table Example
+
+| Feature | Status |
+|---------|--------|
+| Headings | ✓ |
+| Code Blocks | ✓ |
+| Tables | ✓ |
+
+## Links and Formatting
+
+Visit [GitHub](https://github.com) for more info.
+
+Use `inline code` for short snippets.
+
+> This is a blockquote.
+> It can span multiple lines!
+
+---
+
+Made with ❤️ using MarkRender
+"""
+    
+    # Render the markdown
+    print("Rendering markdown content...\n")
+    renderer.render(markdown)
+    renderer.finalize()
+
+
+if __name__ == '__main__':
+    main()

markrender-1.0.0/examples/streaming_demo.py

@@ -0,0 +1,134 @@
+"""
+Streaming demo for MarkRender
+Simulates LLM streaming response
+"""
+
+import time
+from markrender import MarkdownRenderer
+
+
+def simulate_streaming():
+    """Simulate streaming LLM response"""
+    
+    # Simulated markdown response chunks
+    response = """
+# Quantum Computing Explained
+
+Quantum computing is a revolutionary technology that leverages the principles of **quantum mechanics** to process information.
+
+## Key Concepts
+
+### 1. Qubits
+
+Unlike classical bits that can only be 0 or 1, **qubits** can exist in a *superposition* of both states simultaneously.
+
+```python
+# Classical bit
+bit = 0  # or 1
+
+# Qubit (conceptual)
+qubit = alpha|0⟩ + beta|1⟩
+```
+
+### 2. Superposition
+
+Superposition allows quantum computers to:
+- Process multiple possibilities at once
+- Explore solution spaces exponentially faster
+- Solve certain problems classical computers cannot
+
+### 3. Entanglement
+
+When qubits become entangled:
+- [x] Their states become correlated
+- [x] Measuring one affects the other
+- [x] Distance doesn't matter
+
+## Comparison Table
+
+| Aspect | Classical | Quantum |
+|--------|-----------|---------|
+| Basic unit | Bit (0 or 1) | Qubit (superposition) |
+| Gates | AND, OR, NOT | Hadamard, CNOT, etc. |
+| Speed | Linear | Exponential (for some problems) |
+
+## Applications
+
+> Quantum computing promises to revolutionize fields like cryptography, drug discovery, and optimization problems.
+
+Some exciting applications include:
+
+1. **Cryptography** - Breaking current encryption :lock:
+2. **Drug Discovery** - Simulating molecular interactions :pill:
+3. **Optimization** - Solving complex logistics problems :package:
+4. **AI/ML** - Accelerating machine learning :robot:
+
+## Example Algorithm
+
+```python
+from qiskit import QuantumCircuit
+
+# Create a quantum circuit
+qc = QuantumCircuit(2, 2)
+
+# Apply Hadamard gate
+qc.h(0)
+
+# Apply CNOT gate
+qc.cx(0, 1)
+
+# Measure
+qc.measure([0, 1], [0, 1])
+```
+
+### Challenges
+
+Current quantum computers face several challenges:
+
+- **Decoherence** - Qubits lose their quantum state quickly
+- **Error rates** - High error rates require error correction
+- **Scalability** - Building large-scale quantum computers is difficult
+
+---
+
+*For more information, visit [IBM Quantum](https://www.ibm.com/quantum)*
+
+Hope this helps! :wave:
+"""
+    
+    # Split into chunks (simulating streaming)
+    chunk_size = 10  # characters per chunk
+    for i in range(0, len(response), chunk_size):
+        chunk = response[i:i + chunk_size]
+        yield chunk
+        time.sleep(0.01)  # Simulate network delay
+
+
+def main():
+    """Streaming markdown rendering demo"""
+    
+    print("Simulating streaming LLM response...\n")
+    print("=" * 80)
+    print()
+    
+    # Create renderer
+    renderer = MarkdownRenderer(
+        theme='github-dark',
+        code_background=False,
+        line_numbers=True
+    )
+    
+    # Render streaming chunks
+    for chunk in simulate_streaming():
+        renderer.render(chunk)
+    
+    # Finalize rendering
+    renderer.finalize()
+    
+    print()
+    print("=" * 80)
+    print("\n\nStreaming complete! ✓")
+
+
+if __name__ == '__main__':
+    main()