markrender 1.0.7__tar.gz → 1.1.0__tar.gz

markrender-1.1.0/.gitignore

@@ -0,0 +1,74 @@
+# 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
+.ruff_cache/
+markrender/_version.py
+
+
+# test files
+test_all_fixes.py
+test_emoji.py    
+test_simple.py

{markrender-1.0.7 → markrender-1.1.0}/LICENSE

@@ -1,21 +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.
+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.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+# CI configuration is not needed in the source distribution.
+prune .github

markrender-1.1.0/PKG-INFO

@@ -0,0 +1,405 @@
+Metadata-Version: 2.4
+Name: markrender
+Version: 1.1.0
+Summary: Professional terminal markdown renderer for streaming LLM responses
+Author: Praneeth Gandodi
+License: 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: License :: OSI Approved :: MIT License
+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.7.0
+Requires-Dist: emoji>=2.8.0
+Requires-Dist: tomli>=2.0.0; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.10.0; extra == "dev"
+Dynamic: license-file
+
+# MarkRender
+
+**Professional Terminal Markdown Renderer for Streaming LLM Responses**
+
+MarkRender is a Python library that renders markdown in terminals, designed for streaming LLM responses. It provides syntax highlighting, multiple color themes, and supports markdown features without flickering.
+
+## Features
+
+- **Streaming Support** - Designed for chunk-by-chunk LLM response rendering
+- **7 Themes** - github-dark, monokai, dracula, nord, one-dark, solarized-dark, solarized-light
+- **Syntax Highlighting** - Powered by Pygments with 500+ languages
+- **Dim Mode** - Render content in dimmed/reduced colors for "thinking" sections
+- **Theme Preview** - Preview all themes with sample content via CLI
+- **Line Numbers** - Optional line numbers in code blocks
+- **Tables** - Table rendering with borders and overflow truncation
+- **Checkboxes** - Task list support
+- **Emoji Support** - Converts `:emoji_name:` to actual emojis
+- **Links** - Styled hyperlinks with URLs
+- **Full Markdown** - Headings, lists, blockquotes, horizontal rules, alerts, and more
+- **Force Color** - Force color output even in non-tty terminals
+- **Customizable** - Custom colors, backgrounds, and formatting options
+- **Python 3.7+** - Compatible with Python 3.7 and above
+
+## Installation
+
+```bash
+pip install git+https://github.com/Praneeth-Gandodi/markrender.git
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/Praneeth-Gandodi/markrender.git
+cd markrender
+pip install -e .
+```
+
+## Quick Start
+
+````python
+from markrender import MarkdownRenderer
+
+# Create renderer with default theme
+renderer = MarkdownRenderer()
+
+# Render markdown content
+markdown_text = """
+# Hello World
+
+This is **bold** and this is *italic*.
+
+```python
+def hello():
+    print("Hello from MarkRender!")
+```
+
+## Features
+- Item 1
+- Item 2
+- [x] Completed task
+- [ ] Pending task
+"""
+
+renderer.render(markdown_text)
+renderer.finalize()
+````
+
+### Streaming LLM Responses
+
+Perfect for rendering streaming responses from LLM APIs:
+
+```python
+from markrender import MarkdownRenderer
+from openai import OpenAI
+
+client = OpenAI()
+renderer = MarkdownRenderer(theme='github-dark')
+
+stream = client.chat.completions.create(
+    model="gpt-4",
+    messages=[{"role": "user", "content": "Explain quantum computing"}],
+    stream=True
+)
+
+for chunk in stream:
+    content = chunk.choices[0].delta.content
+    if content:
+        renderer.render(content)
+
+renderer.finalize()
+```
+
+### Dim Mode
+
+Use dim mode for "thinking" sections or less prominent content:
+
+```python
+from markrender import MarkdownRenderer
+
+renderer = MarkdownRenderer()
+
+# Normal rendering
+renderer.render("This is **normal** content")
+
+# Dim/reduced color rendering
+renderer.render("This content is dimmed and less prominent", dim_mode=True)
+```
+
+### Theme Preview
+
+Preview all available themes from the CLI:
+
+```bash
+markrender --preview-themes
+```
+
+## Themes
+
+MarkRender includes 7 professional color themes:
+
+```python
+themes = [
+    'github-dark',      # GitHub's dark theme (default)
+    'monokai',          # Popular Monokai theme
+    'dracula',          # Dracula theme
+    'nord',             # Nord color palette
+    'one-dark',         # Atom One Dark
+    'solarized-dark',   # Solarized Dark
+    'solarized-light'   # Solarized Light
+]
+
+renderer = MarkdownRenderer(theme='dracula')
+```
+
+List available themes:
+
+```bash
+markrender --list-themes
+```
+
+## Configuration
+
+### Python API
+
+```python
+from markrender import MarkdownRenderer
+from markrender.colors import rgb
+
+renderer = MarkdownRenderer(
+    theme='monokai',                       # Color theme
+    code_background=False,                 # Show background in code blocks
+    line_numbers=True,                     # Show line numbers in code
+    inline_code_color=rgb(255, 100, 200),  # Custom inline code color
+    width=100,                             # Terminal width (auto-detect by default)
+    force_color=False,                     # Force color output
+    stream_code=True                       # Stream code lines as they arrive
+)
+```
+
+### Parameters
+
+- **theme** (str): Color theme name (default: `'github-dark'`)
+- **code_background** (bool): Show background in code blocks (default: `False`)
+- **line_numbers** (bool): Show line numbers in code blocks (default: `True`)
+- **inline_code_color** (str): Custom ANSI color code for inline code (default: theme default)
+- **width** (int): Terminal width in characters (default: auto-detect)
+- **force_color** (bool): Force color output even if terminal does not support it (default: `False`)
+- **stream_code** (bool): Render code lines as they arrive instead of buffering (default: `True`)
+- **output** (file): Output stream (default: `sys.stdout`)
+
+### CLI Usage
+
+```bash
+markrender README.md
+markrender --theme dracula file.md
+cat file.md | markrender
+markrender --preview-themes
+markrender --list-themes
+markrender --no-line-numbers --code-background file.md
+markrender --width 80 --force-color file.md
+```
+
+### Config File
+
+MarkRender supports TOML configuration files. Place a `.markrender.toml` in your current directory or `~/.markrender/config.toml`:
+
+```toml
+[theme]
+name = "github-dark"
+
+[rendering]
+code_background = false
+line_numbers = true
+
+[output]
+# width = 80
+force_color = false
+
+[features]
+stream_code = true
+```
+
+## Supported Markdown Features
+
+### Headings
+```markdown
+# H1 Heading
+## H2 Heading
+### H3 Heading
+#### H4 Heading
+##### H5 Heading
+###### H6 Heading
+```
+
+### Code Blocks
+````markdown
+```python
+def example():
+    return "Syntax highlighted!"
+```
+````
+
+### Inline Code
+```markdown
+Use `inline code` for short snippets.
+```
+
+### Tables
+```markdown
+| Feature | Supported |
+|---------|-----------|
+| Tables  | Yes       |
+| Borders | Yes       |
+```
+
+### Lists
+```markdown
+- Unordered item 1
+- Unordered item 2
+  - Nested item
+
+1. Ordered item 1
+2. Ordered item 2
+```
+
+### Checkboxes
+```markdown
+- [x] Completed task
+- [ ] Pending task
+```
+
+### Blockquotes
+```markdown
+> This is a blockquote
+> It can span multiple lines
+```
+
+### Alerts (GitHub-flavored)
+```markdown
+> [!NOTE]
+> Useful information users should know
+
+> [!TIP]
+> Helpful advice
+
+> [!IMPORTANT]
+> Key information
+
+> [!WARNING]
+> Urgent information
+
+> [!CAUTION]
+> Potential negative consequences
+```
+
+### Links
+```markdown
+[Link text](https://example.com)
+```
+
+### Text Formatting
+```markdown
+**Bold text**
+*Italic text*
+***Bold and italic***
+~~Strikethrough~~
+```
+
+### Emojis
+```markdown
+Hello :wave: Let's :rocket: go!
+```
+
+### Horizontal Rules
+```markdown
+---
+```
+
+## Use Cases
+
+- **AI Chat Applications** - Render LLM responses in CLI tools
+- **Documentation Viewers** - Display markdown documentation in terminal
+- **Code Review Tools** - Show code diffs and comments
+- **Note-Taking Apps** - Terminal-based markdown note viewers
+- **Log Viewers** - Render structured logs with markdown
+
+## Development
+
+### Setup Development Environment
+
+```bash
+git clone https://github.com/Praneeth-Gandodi/markrender.git
+cd markrender
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/ -v
+pytest tests/ --cov=markrender --cov-report=html --cov-report=term
+```
+
+### Run Examples
+
+```bash
+python examples/basic_usage.py
+python examples/streaming_demo.py
+python examples/theme_showcase.py
+```
+
+### Releasing
+
+The package version is derived from git tags by `setuptools_scm`, so there is
+no version number to edit by hand.
+
+1. Open **Actions → Publish → Run workflow**.
+2. Choose `auto` (recommended) or an explicit `patch`, `minor`, or `major` bump.
+3. The workflow runs the tests, creates the next `vX.Y.Z` tag, builds the
+   sdist and wheel, publishes to PyPI, and creates a GitHub release.
+
+With `auto`, commit messages since the last tag decide the bump:
+
+- `feat!:` or a `BREAKING CHANGE:` footer → major
+- `feat:` → minor
+- everything else → patch
+
+Publishing uses PyPI Trusted Publishing (OIDC), so no API token is stored in
+the repository. Configure it once:
+
+- **PyPI:** project `markrender` → Publishing → add a trusted publisher with
+  owner `Praneeth-Gandodi`, repository `markrender`, workflow `publish.yml`,
+  environment `pypi`.
+- **GitHub:** Settings → Environments → create an environment named `pypi`.
+
+The repository default workflow permission can stay read-only; the workflow
+requests `contents: write` only for the jobs that create the tag and release.
+
+You can also publish an existing tag directly:
+
+```bash
+git tag v1.1.0
+git push origin v1.1.0
+```
+
+To publish automatically after every merge to `main`, uncomment the `branches:
+[main]` trigger in `.github/workflows/publish.yml`.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.