mpl-richtext 0.1.0__tar.gz

mpl_richtext-0.1.0/.gitignore

@@ -0,0 +1,143 @@
+# 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
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Generated images from examples/tests
+*.png
+*.jpg
+*.jpeg
+*.pdf
+!docs/images/*.png
+!docs/images/*.jpg
+!examples/*.png

mpl_richtext-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rabin Katel
+
+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.

mpl_richtext-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: mpl-richtext
+Version: 0.1.0
+Summary: Rich text rendering for Matplotlib with multi-color and multi-style support
+Home-page: https://github.com/ra8in/mpl-richtext
+Author: Rabin Katel
+Author-email: Rabin Katel <kattelrabinraja13@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ra8in/mpl-richtext
+Project-URL: Documentation, https://github.com/ra8in/mpl-richtext#readme
+Project-URL: Repository, https://github.com/ra8in/mpl-richtext
+Project-URL: Bug Tracker, https://github.com/ra8in/mpl-richtext/issues
+Keywords: matplotlib,text,color,rich-text,multi-color,visualization,plotting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: flake8>=5.0; extra == "dev"
+Requires-Dist: mypy>=0.990; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# mpl-richtext
+
+**Rich text rendering for Matplotlib** - Create beautiful multi-color, multi-style text in a single line.
+
+[![PyPI version](https://badge.fury.io/py/mpl-richtext.svg)](https://pypi.org/project/mpl-richtext/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+
+## Why mpl-richtext?
+
+Standard Matplotlib only supports single-color text. To create multi-colored text, you need to manually position each piece and calculate spacing - tedious and error-prone!
+
+**mpl-richtext** solves this by letting you specify colors and styles for each text segment in one simple function call.
+
+![mpl-richtext Showcase](examples/mpl_richtext_examples.png)
+
+## Installation
+
+```bash
+pip install mpl-richtext
+```
+
+## Quick Start
+
+```python
+import matplotlib.pyplot as plt
+from mpl_richtext import richtext
+
+fig, ax = plt.subplots()
+
+# Create multi-colored text in one line!
+richtext(0.5, 0.5, 
+         strings=["hello", ", ", "world"],
+         colors=["red", "blue", "green"],
+         ax=ax, fontsize=20, transform=ax.transAxes)
+
+plt.show()
+```
+
+
+
+## Features
+
+
+
+✨ **Multi-color text** - Different colors for each word or character  
+🎨 **Multi-style text** - Mix font sizes, weights, families, and styles (italic/oblique)  
+📦 **Flexible input** - Lists, dicts, or tuples for colors and properties  
+📏 **Auto word-wrapping** - Specify `box_width` for automatic text wrapping  
+🎯 **Full alignment** - Left, center, right horizontal and vertical alignment  
+✨ **Decorations** - Support for **underlines** and **background colors**  
+🔄 **Transformations** - Support for text **rotation**  
+👻 **Transparency** - Support for **alpha** values per segment  
+⚡ **Easy to use** - Simple API, works with any Matplotlib axes
+
+
+
+## API Reference
+
+### `richtext(x, y, strings, colors=None, ax=None, **kwargs)`
+
+**Parameters:**
+
+- **x, y** : `float`  
+  Starting position of the text
+
+- **strings** : `list of str`  
+  List of text segments, e.g., `["hello", ", ", "world"]`
+
+- **colors** : `str`, `list`, or `dict`, optional  
+  Colors for each segment. Can be:
+  - Single string: `"red"` (applies to all)
+  - List: `["red", "blue", "green"]` (one per segment)
+  - Dict: `{0: "red", 2: "green"}` (specific indices)
+  - Tuple keys: `{(0, 2): "red"}` (multiple indices same color)
+
+- **ax** : `matplotlib.axes.Axes`, optional  
+  Axes to draw on. If `None`, uses current axes.
+
+- **kwargs** : Additional properties  
+  - **Global:** `box_width`, `linespacing`, `ha`, `va`, `transform`, `zorder`
+  - **Per-segment:** `fontsize`/`fontsizes`, `fontweight`/`fontweights`, `fontfamily`/`fontfamilies`, etc.
+  - Any property can be:
+    - Single value (applies to all)
+    - List (one per segment, auto-extends)
+    - Dict (specific indices)
+
+**Returns:**
+- `list of Text` - List of created matplotlib Text objects
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+- **PyPI:** https://pypi.org/project/mpl-richtext/
+- **GitHub:** https://github.com/ra8in/mpl-richtext
+- **Issues:** https://github.com/ra8in/mpl-richtext/issues
+
+---
+
+Made with ❤️ for the Matplotlib community

mpl_richtext-0.1.0/README.md

@@ -0,0 +1,113 @@
+# mpl-richtext
+
+**Rich text rendering for Matplotlib** - Create beautiful multi-color, multi-style text in a single line.
+
+[![PyPI version](https://badge.fury.io/py/mpl-richtext.svg)](https://pypi.org/project/mpl-richtext/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+
+## Why mpl-richtext?
+
+Standard Matplotlib only supports single-color text. To create multi-colored text, you need to manually position each piece and calculate spacing - tedious and error-prone!
+
+**mpl-richtext** solves this by letting you specify colors and styles for each text segment in one simple function call.
+
+![mpl-richtext Showcase](examples/mpl_richtext_examples.png)
+
+## Installation
+
+```bash
+pip install mpl-richtext
+```
+
+## Quick Start
+
+```python
+import matplotlib.pyplot as plt
+from mpl_richtext import richtext
+
+fig, ax = plt.subplots()
+
+# Create multi-colored text in one line!
+richtext(0.5, 0.5, 
+         strings=["hello", ", ", "world"],
+         colors=["red", "blue", "green"],
+         ax=ax, fontsize=20, transform=ax.transAxes)
+
+plt.show()
+```
+
+
+
+## Features
+
+
+
+✨ **Multi-color text** - Different colors for each word or character  
+🎨 **Multi-style text** - Mix font sizes, weights, families, and styles (italic/oblique)  
+📦 **Flexible input** - Lists, dicts, or tuples for colors and properties  
+📏 **Auto word-wrapping** - Specify `box_width` for automatic text wrapping  
+🎯 **Full alignment** - Left, center, right horizontal and vertical alignment  
+✨ **Decorations** - Support for **underlines** and **background colors**  
+🔄 **Transformations** - Support for text **rotation**  
+👻 **Transparency** - Support for **alpha** values per segment  
+⚡ **Easy to use** - Simple API, works with any Matplotlib axes
+
+
+
+## API Reference
+
+### `richtext(x, y, strings, colors=None, ax=None, **kwargs)`
+
+**Parameters:**
+
+- **x, y** : `float`  
+  Starting position of the text
+
+- **strings** : `list of str`  
+  List of text segments, e.g., `["hello", ", ", "world"]`
+
+- **colors** : `str`, `list`, or `dict`, optional  
+  Colors for each segment. Can be:
+  - Single string: `"red"` (applies to all)
+  - List: `["red", "blue", "green"]` (one per segment)
+  - Dict: `{0: "red", 2: "green"}` (specific indices)
+  - Tuple keys: `{(0, 2): "red"}` (multiple indices same color)
+
+- **ax** : `matplotlib.axes.Axes`, optional  
+  Axes to draw on. If `None`, uses current axes.
+
+- **kwargs** : Additional properties  
+  - **Global:** `box_width`, `linespacing`, `ha`, `va`, `transform`, `zorder`
+  - **Per-segment:** `fontsize`/`fontsizes`, `fontweight`/`fontweights`, `fontfamily`/`fontfamilies`, etc.
+  - Any property can be:
+    - Single value (applies to all)
+    - List (one per segment, auto-extends)
+    - Dict (specific indices)
+
+**Returns:**
+- `list of Text` - List of created matplotlib Text objects
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+- **PyPI:** https://pypi.org/project/mpl-richtext/
+- **GitHub:** https://github.com/ra8in/mpl-richtext
+- **Issues:** https://github.com/ra8in/mpl-richtext/issues
+
+---
+
+Made with ❤️ for the Matplotlib community

mpl_richtext-0.1.0/examples/basic_usage.py

@@ -0,0 +1,140 @@
+"""
+Basic usage examples for mpl-richtext showcasing various features.
+"""
+
+import matplotlib.pyplot as plt
+from mpl_richtext import richtext
+
+def create_example():
+    # Set up a clean figure
+    fig = plt.figure(figsize=(15, 12), facecolor='white')
+    fig.suptitle('mpl-richtext Feature Showcase', fontsize=24, fontweight='bold', y=0.95)
+    
+    # 1. Colors & Gradients
+    ax1 = fig.add_subplot(3, 3, 1)
+    ax1.axis('off')
+    ax1.set_title('1. Multi-Color Text', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.6,
+             strings=["Red", "Blue", "Green", "Purple"],
+             colors=["#E74C3C", "#3498DB", "#2ECC71", "#9B59B6"],
+             fontsize=24, fontweight='bold',
+             ha='center', va='center', ax=ax1)
+             
+    richtext(0.5, 0.3,
+             strings=list("RAINBOW"),
+             colors=["red", "orange", "gold", "green", "blue", "indigo", "violet"],
+             fontsize=18, fontweight='bold',
+             ha='center', va='center', ax=ax1)
+
+    # 2. Font Styles & Weights
+    ax2 = fig.add_subplot(3, 3, 2)
+    ax2.axis('off')
+    ax2.set_title('2. Fonts & Styles', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.7,
+             strings=["Bold", "Italic", "Light"],
+             colors=["black"]*3,
+             fontweights=["bold", "normal", "light"],
+             fontstyles=["normal", "italic", "normal"],
+             fontsize=20, ha='center', ax=ax2)
+             
+    richtext(0.5, 0.4,
+             strings=["Serif", "Sans", "Mono"],
+             colors=["#34495E"]*3,
+             fontfamilies=["serif", "sans-serif", "monospace"],
+             fontsize=18, ha='center', ax=ax2)
+
+    # 3. Decorations (Underline & Background)
+    ax3 = fig.add_subplot(3, 3, 3)
+    ax3.axis('off')
+    ax3.set_title('3. Decorations', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.7,
+             strings=["Underlined", "Text"],
+             colors=["#2C3E50", "#E67E22"],
+             underlines=[True, True],
+             fontsize=20, ha='center', ax=ax3)
+             
+    richtext(0.5, 0.3,
+             strings=[" Highlighted ", " Box "],
+             colors=["white", "black"],
+             backgroundcolors=["#E74C3C", "#F1C40F"],
+             fontsize=18, ha='center', ax=ax3)
+
+    # 4. Sizing & Spacing
+    ax4 = fig.add_subplot(3, 3, 4)
+    ax4.axis('off')
+    ax4.set_title('4. Sizes & Spacing', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.5,
+             strings=["Small", "Medium", "Large"],
+             colors=["#7F8C8D", "#34495E", "#2C3E50"],
+             fontsizes=[12, 20, 32],
+             ha='center', va='center', ax=ax4)
+
+    # 5. Syntax Highlighting (Code)
+    ax5 = fig.add_subplot(3, 3, 5)
+    ax5.axis('off')
+    ax5.set_title('5. Syntax Highlighting', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.1, 0.6,
+             strings=["def ", "hello_world", "():"],
+             colors=["#C678DD", "#61AFEF", "#ABB2BF"],
+             fontfamily='monospace', fontsize=16, ax=ax5)
+             
+    richtext(0.1, 0.4,
+             strings=["    return ", "'Success!'"],
+             colors=["#C678DD", "#98C379"],
+             fontfamily='monospace', fontsize=16, ax=ax5)
+
+    # 6. Advanced Alignment
+    ax6 = fig.add_subplot(3, 3, 6)
+    ax6.axis('off')
+    ax6.set_title('6. Alignment', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.8, ["Left Aligned"], ["black"], ha='left', fontsize=14, ax=ax6)
+    richtext(0.5, 0.5, ["Center Aligned"], ["#E67E22"], ha='center', fontsize=14, ax=ax6)
+    richtext(0.5, 0.2, ["Right Aligned"], ["#2980B9"], ha='right', fontsize=14, ax=ax6)
+    ax6.axvline(0.5, color='#BDC3C7', linestyle='--', zorder=0)
+
+    # 7. Targeted Overrides (Dictionary)
+    ax7 = fig.add_subplot(3, 3, 7)
+    ax7.axis('off')
+    ax7.set_title('7. Targeted Overrides', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.5,
+             strings=["Normal", "Red", "Normal", "Blue"], color="green",
+             colors={1: "red", 3: "blue"}, fontsizes={1: 20, 3: 30}, fontsize=15,  # Target specific indices
+             fontweights={1: "bold", 3: "bold"},
+             ha='center', va='center', ax=ax7)
+
+    # 8. Rotated Text
+    ax8 = fig.add_subplot(3, 3, 8)
+    ax8.axis('off')
+    ax8.set_title('8. Rotated Text', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.5,
+             strings=["Rotated ", "Text"],
+             colors=["#8E44AD", "#2C3E50"],
+             rotation=45,
+             fontsize=24, ha='center', va='center', ax=ax8)
+
+    # 9. Transparency (Alpha)
+    ax9 = fig.add_subplot(3, 3, 9)
+    ax9.axis('off')
+    ax9.set_title('9. Transparency', loc='left', fontsize=14, fontweight='bold', pad=10)
+    
+    richtext(0.5, 0.5,
+             strings=["Solid", "Fade", "Ghost"],
+             colors=["#2C3E50"]*3,
+             alphas=[1.0, 0.6, 0.2],
+             fontsize=24, fontweight='bold',
+             ha='center', va='center', ax=ax9)
+
+    plt.tight_layout(rect=[0, 0.03, 1, 0.95])
+    plt.savefig('examples/mpl_richtext_examples.png', dpi=200, bbox_inches='tight')
+    print("Example image saved.")
+
+if __name__ == "__main__":
+    create_example()

mpl_richtext-0.1.0/mpl_richtext/__init__.py

@@ -0,0 +1,12 @@
+"""
+mpl-richtext: Rich text rendering for Matplotlib
+"""
+
+from .core import richtext
+from .version import __version__
+
+__all__ = ['richtext', '__version__']
+
+__author__ = 'Rabin Katel'
+__email__ = 'kattelrabinraja13@gmail.com'
+__license__ = 'MIT'