manimpango 0.2.5__tar.gz → 0.2.6__tar.gz

{ManimPango-0.2.5 → ManimPango-0.2.6}/ManimPango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ManimPango
-Version: 0.2.5
+Version: 0.2.6
 Summary: Bindings for Pango for using with Manim.
 Home-page: https://manimpango.manim.community/
 Author: Naveen M K
@@ -37,6 +37,15 @@ Description: # ManimPango
         
         For **Linux Users**, there are no Wheels. You must have a C compiler as well as **Pango** and its dependencies along with the **Pango** development headers. See [BUILDING](#BUILDING) for more information.
         
+        ## WORKFLOW SETUP / CONTRIBUTING
+        
+        To make it easier for developers to contribute, we have a pre-commit workflow that will check for `black` formatting and `flake` checking.
+        
+        ```sh
+        pip install pre-commit
+        pre-commit install
+        ```
+        
         ## BUILDING
         
         ### Linux/MacOS
@@ -65,7 +74,7 @@ Description: # ManimPango
         
         Or similar in your system's package manager.
         
-        ##### Using `tar` archives
+        #### Using `tar` archives
         
         If you don't want to contribute to this repository, you can use the tar archives published in PyPi, or just use `pip` to install using
         
@@ -75,7 +84,15 @@ Description: # ManimPango
         
         **Note**: `pip` by default uses wheels, so make sure to pass the `--no-binary` parameter.
         
-        ##### Using `git` clones / Contributing
+        #### Using `git` clones / Contributing
+        
+        Please remember to do this inside your virtual environment, if you want to use your **Manimpango** with **Manim**.
+        
+        ```sh
+        python -m venv ./venv
+        source venv/bin/activate # Linux/macOS
+        venv\Scripts\activate # Windows
+        ```
         
         If you are using a clone of this repository, you will need [Cython](https://cython.org) which can be easily installed using `pip`:
         
@@ -86,12 +103,23 @@ Description: # ManimPango
         After that you can use `pip` to install the clone with the following command:
         
         ```sh
-        pip install .
+        pip install -e .
+        pip install -r requirements-dev.txt .
         ```
         
-        You will need to this way if you want to *contribute* to **ManimPango**.
+        Next, run the setup script:
+        
+        ```sh
+        python setup.py build_ext -i
+        ```
+        
+        After installation is complete, you should be able to run pytest:
         
-        Please remember to do this inside your poetry shell, if you want to use your **Manimpango** with **Manim**.
+        ```sh
+        pytest
+        ```
+        
+        You will need to this way if you want to *contribute* to **ManimPango**.
         
         ### Contributing with Windows
         

{ManimPango-0.2.5 → ManimPango-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ManimPango
-Version: 0.2.5
+Version: 0.2.6
 Summary: Bindings for Pango for using with Manim.
 Home-page: https://manimpango.manim.community/
 Author: Naveen M K
@@ -37,6 +37,15 @@ Description: # ManimPango
         
         For **Linux Users**, there are no Wheels. You must have a C compiler as well as **Pango** and its dependencies along with the **Pango** development headers. See [BUILDING](#BUILDING) for more information.
         
+        ## WORKFLOW SETUP / CONTRIBUTING
+        
+        To make it easier for developers to contribute, we have a pre-commit workflow that will check for `black` formatting and `flake` checking.
+        
+        ```sh
+        pip install pre-commit
+        pre-commit install
+        ```
+        
         ## BUILDING
         
         ### Linux/MacOS
@@ -65,7 +74,7 @@ Description: # ManimPango
         
         Or similar in your system's package manager.
         
-        ##### Using `tar` archives
+        #### Using `tar` archives
         
         If you don't want to contribute to this repository, you can use the tar archives published in PyPi, or just use `pip` to install using
         
@@ -75,7 +84,15 @@ Description: # ManimPango
         
         **Note**: `pip` by default uses wheels, so make sure to pass the `--no-binary` parameter.
         
-        ##### Using `git` clones / Contributing
+        #### Using `git` clones / Contributing
+        
+        Please remember to do this inside your virtual environment, if you want to use your **Manimpango** with **Manim**.
+        
+        ```sh
+        python -m venv ./venv
+        source venv/bin/activate # Linux/macOS
+        venv\Scripts\activate # Windows
+        ```
         
         If you are using a clone of this repository, you will need [Cython](https://cython.org) which can be easily installed using `pip`:
         
@@ -86,12 +103,23 @@ Description: # ManimPango
         After that you can use `pip` to install the clone with the following command:
         
         ```sh
-        pip install .
+        pip install -e .
+        pip install -r requirements-dev.txt .
         ```
         
-        You will need to this way if you want to *contribute* to **ManimPango**.
+        Next, run the setup script:
+        
+        ```sh
+        python setup.py build_ext -i
+        ```
+        
+        After installation is complete, you should be able to run pytest:
         
-        Please remember to do this inside your poetry shell, if you want to use your **Manimpango** with **Manim**.
+        ```sh
+        pytest
+        ```
+        
+        You will need to this way if you want to *contribute* to **ManimPango**.
         
         ### Contributing with Windows
         

{ManimPango-0.2.5 → ManimPango-0.2.6}/README.md

@@ -25,6 +25,15 @@ pip install manimpango
 
 For **Linux Users**, there are no Wheels. You must have a C compiler as well as **Pango** and its dependencies along with the **Pango** development headers. See [BUILDING](#BUILDING) for more information.
 
+## WORKFLOW SETUP / CONTRIBUTING
+
+To make it easier for developers to contribute, we have a pre-commit workflow that will check for `black` formatting and `flake` checking.
+
+```sh
+pip install pre-commit
+pre-commit install
+```
+
 ## BUILDING
 
 ### Linux/MacOS
@@ -53,7 +62,7 @@ apt install libpango1.0-dev pkg-config python3-dev
 
 Or similar in your system's package manager.
 
-##### Using `tar` archives
+#### Using `tar` archives
 
 If you don't want to contribute to this repository, you can use the tar archives published in PyPi, or just use `pip` to install using
 
@@ -63,7 +72,15 @@ pip install manimpango --no-binary :all:
 
 **Note**: `pip` by default uses wheels, so make sure to pass the `--no-binary` parameter.
 
-##### Using `git` clones / Contributing
+#### Using `git` clones / Contributing
+
+Please remember to do this inside your virtual environment, if you want to use your **Manimpango** with **Manim**.
+
+```sh
+python -m venv ./venv
+source venv/bin/activate # Linux/macOS
+venv\Scripts\activate # Windows
+```
 
 If you are using a clone of this repository, you will need [Cython](https://cython.org) which can be easily installed using `pip`:
 
@@ -74,12 +91,23 @@ pip install Cython
 After that you can use `pip` to install the clone with the following command:
 
 ```sh
-pip install .
+pip install -e .
+pip install -r requirements-dev.txt .
 ```
 
-You will need to this way if you want to *contribute* to **ManimPango**.
+Next, run the setup script:
+
+```sh
+python setup.py build_ext -i
+```
+
+After installation is complete, you should be able to run pytest:
 
-Please remember to do this inside your poetry shell, if you want to use your **Manimpango** with **Manim**.
+```sh
+pytest
+```
+
+You will need to this way if you want to *contribute* to **ManimPango**.
 
 ### Contributing with Windows
 

ManimPango-0.2.6/manimpango/__init__.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+import os
+import sys
+
+from ._version import __version__  # noqa: F403,F401
+
+if os.name == "nt":  # pragma: no cover
+    os.environ["PATH"] = (
+        f"{os.path.abspath(os.path.dirname(__file__))}"
+        f"{os.pathsep}"
+        f"{os.environ['PATH']}"
+    )
+try:
+    from .cmanimpango import *  # noqa: F403,F401
+    from .enums import *  # noqa: F403,F401
+    from .register_font import *  # noqa: F403,F401
+except ImportError as ie:  # pragma: no cover
+    py_ver = ".".join(map(str, sys.version_info[:3]))
+    msg = f"""
+
+ManimPango could not import and load the necessary shared libraries.
+This error may occur when ManimPango and its dependencies are improperly set up.
+Please make sure the following versions are what you expect:
+
+    * ManimPango v{__version__}, Python v{py_ver}
+
+If you believe there is a greater problem,
+feel free to contact us or create an issue on GitHub:
+
+    * Discord: https://discord.gg/mMRrZQW
+    * GitHub: https://github.com/ManimCommunity/ManimPango/issues
+
+Original error: {ie}
+"""
+    raise ImportError(msg)

{ManimPango-0.2.5 → ManimPango-0.2.6}/manimpango/_version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = "0.2.5"
+__version__ = "0.2.6"

{ManimPango-0.2.5 → ManimPango-0.2.6}/manimpango/cmanimpango.pyx

@@ -2,6 +2,7 @@ from xml.sax.saxutils import escape
 from .utils import *
 from .enums import Alignment
 import warnings
+import typing
 
 class TextSetting:
     """Formatting for slices of a :class:`manim.mobject.svg.text_mobject.Text` object."""
@@ -31,14 +32,14 @@ def text2svg(
     START_Y:int,
     width:int,
     height:int,
-    orig_text:str
+    orig_text:str,
+    pango_width: typing.Union[int, None] = None,
 ) -> int:
     """Render an SVG file from a :class:`manim.mobject.svg.text_mobject.Text` object."""
     cdef cairo_surface_t* surface
     cdef cairo_t* cr
     cdef PangoFontDescription* font_desc
     cdef PangoLayout* layout
-    cdef double width_layout = width
     cdef double font_size_c = size
     cdef cairo_status_t status
     cdef int temp_width
@@ -67,12 +68,16 @@ def text2svg(
 
     layout = pango_cairo_create_layout(cr)
 
-    if layout==NULL:
+    if layout == NULL:
         cairo_destroy(cr)
         cairo_surface_destroy(surface)
         raise MemoryError("Pango.Layout can't be created from Cairo Context.")
 
-    pango_layout_set_width(layout, pango_units_from_double(width_layout))
+    if pango_width is None:
+        pango_layout_set_width(layout, pango_units_from_double(width))
+    else:
+        pango_layout_set_width(layout, pango_units_from_double(pango_width))
+
     for setting in settings:
         family = setting.font
         style = PangoUtils.str2style(setting.slant)
@@ -151,7 +156,8 @@ class MarkupUtils:
         justify: bool = None,
         indent: float = None,
         line_spacing: float = None,
-        alignment: Alignment = None
+        alignment: Alignment = None,
+        pango_width: typing.Union[int, None] = None,
     ) -> int:
         """Render an SVG file from a :class:`manim.mobject.svg.text_mobject.MarkupText` object."""
         cdef cairo_surface_t* surface
@@ -159,7 +165,6 @@ class MarkupUtils:
         cdef PangoFontDescription* font_desc
         cdef PangoLayout* layout
         cdef cairo_status_t status
-        cdef double width_layout = width - 50
         cdef double font_size = size
         cdef int temp_int # a temporary C integer for conversion
 
@@ -186,12 +191,15 @@ class MarkupUtils:
 
         cairo_move_to(context,START_X,START_Y)
         layout = pango_cairo_create_layout(context)
-        if layout==NULL:
+        if layout == NULL:
             cairo_destroy(context)
             cairo_surface_destroy(surface)
             raise MemoryError("Pango.Layout can't be created from Cairo Context.")
 
-        pango_layout_set_width(layout, pango_units_from_double(width_layout))
+        if pango_width is None:
+            pango_layout_set_width(layout, pango_units_from_double(width))
+        else:
+            pango_layout_set_width(layout, pango_units_from_double(pango_width))
 
         if justify:
             pango_layout_set_justify(layout, justify)

ManimPango-0.2.6/manimpango/utils.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+import re
+
+from .enums import Style, Weight
+
+
+class PangoUtils:
+    @staticmethod
+    def str2style(string: str) -> Style:
+        """Internally used function. Converts text to Pango Understandable Styles."""
+        styles = {
+            "NORMAL": Style.NORMAL,
+            "ITALIC": Style.ITALIC,
+            "OBLIQUE": Style.OBLIQUE,
+        }
+        try:
+            return styles[string]
+        except KeyError:
+            raise AttributeError("There is no Style Called %s" % string)
+
+    @staticmethod
+    def str2weight(string: str) -> Weight:
+        """Internally used function. Convert text to Pango Understandable Weight"""
+        weights = {
+            "NORMAL": Weight.NORMAL,
+            "BOLD": Weight.BOLD,
+            "THIN": Weight.THIN,
+            "ULTRALIGHT": Weight.ULTRALIGHT,
+            "LIGHT": Weight.LIGHT,
+            "BOOK": Weight.BOOK,
+            "MEDIUM": Weight.MEDIUM,
+            "SEMIBOLD": Weight.SEMIBOLD,
+            "ULTRABOLD": Weight.ULTRABOLD,
+            "HEAVY": Weight.HEAVY,
+            "ULTRAHEAVY": Weight.ULTRAHEAVY,
+        }
+        try:
+            return weights[string]
+        except KeyError:
+            raise AttributeError("There is no Font Weight Called %s" % string)
+
+    @staticmethod
+    def remove_last_M(file_name: str) -> None:
+        """Remove element from the SVG file in order to allow comparison."""
+        with open(file_name, "r") as fpr:
+            content = fpr.read()
+        content = re.sub(r'Z M [^A-Za-z]*? "\/>', 'Z "/>', content)
+        with open(file_name, "w") as fpw:
+            fpw.write(content)

{ManimPango-0.2.5 → ManimPango-0.2.6}/tests/_manim.py

@@ -26,6 +26,7 @@ class MarkupText:
         alignment: Alignment = None,
         # for the tests
         filename: str = "test.svg",
+        wrap_text: bool = True,
         **kwargs,
     ):
         self.text = text
@@ -42,6 +43,7 @@ class MarkupText:
         self.justify = justify
         self.indent = indent
         self.alignment = alignment
+        self.wrap_text = wrap_text
         if not MarkupUtils.validate(self.text):
             raise ValueError(
                 f"Pango cannot parse your markup in {self.text}. "
@@ -58,24 +60,47 @@ class MarkupText:
         if not os.path.exists(dir_name):
             os.makedirs(dir_name)
         file_name = self.filename
-        return MarkupUtils.text2svg(
-            f"{self.text}",
-            self.font,
-            self.slant,
-            self.weight,
-            size,
-            True,  # stray positional argument
-            disable_liga,
-            file_name,
-            20,
-            20,
-            600,  # width
-            400,  # height
-            justify=self.justify,
-            indent=self.indent,
-            line_spacing=self.line_spacing,
-            alignment=self.alignment,
-        )
+        if self.wrap_text:
+            return MarkupUtils.text2svg(
+                f"{self.text}",
+                self.font,
+                self.slant,
+                self.weight,
+                size,
+                True,  # stray positional argument
+                disable_liga,
+                file_name,
+                20,
+                20,
+                600,  # width
+                400,  # height
+                justify=self.justify,
+                indent=self.indent,
+                line_spacing=self.line_spacing,
+                alignment=self.alignment,
+            )
+        else:
+            return MarkupUtils.text2svg(
+                f"{self.text}",
+                self.font,
+                self.slant,
+                self.weight,
+                size,
+                True,  # stray positional argument
+                disable_liga,
+                file_name,
+                20,
+                20,
+                600,  # width
+                400,  # height
+                justify=self.justify,
+                indent=self.indent,
+                line_spacing=self.line_spacing,
+                alignment=self.alignment,
+                pango_width=-1,
+            )
+            # -1 for no wrapping
+            # default is full width and then wrap.
 
     def __repr__(self):
         return f"MarkupText({repr(self.original_text)})"

{ManimPango-0.2.5 → ManimPango-0.2.6}/tests/test_markup.py

@@ -97,3 +97,14 @@ def test_markup_style(tmpdir):
     s = SVGStyleTester(gotSVG=expected, expectedSVG=test_case)
     assert len(s.got_svg_style) == len(s.expected_svg_style)
     assert s.got_svg_style == s.expected_svg_style
+
+
+def test_wrap_text(tmpdir):
+    tmpdir = Path(tmpdir)
+    wrapped = tmpdir / "wrap.svg"
+    nowrap = tmpdir / "nowarap.svg"
+
+    MarkupText(ipsum_text, wrap_text=False, filename=str(nowrap))
+    MarkupText(ipsum_text, filename=str(wrapped))
+
+    assert wrapped.read_text() != nowrap.read_text()

ManimPango-0.2.5/manimpango/__init__.py

@@ -1,17 +0,0 @@
-# -*- coding: utf-8 -*-
-import os
-
-from ._version import __version__  # noqa: F403,F401
-
-if os.name == "nt":  # pragma: no cover
-    os.environ["PATH"] = (
-        f"{os.path.abspath(os.path.dirname(__file__))}"
-        f"{os.pathsep}"
-        f"{os.environ['PATH']}"
-    )
-try:
-    from .cmanimpango import *  # noqa: F403,F401
-    from .enums import *  # noqa: F403,F401
-    from .register_font import *  # noqa: F403,F401
-except ImportError:  # pragma: no cover
-    raise ImportError("Couldn't load the necessary Shared Libraries.")

ManimPango-0.2.5/manimpango/utils.py

@@ -1,55 +0,0 @@
-# -*- coding: utf-8 -*-
-import re
-
-from .enums import Style, Weight
-
-
-class PangoUtils:
-    @staticmethod
-    def str2style(string: str) -> Style:
-        """Internally used function. Converts text to Pango Understandable Styles."""
-        if string == "NORMAL":
-            return Style.NORMAL
-        elif string == "ITALIC":
-            return Style.ITALIC
-        elif string == "OBLIQUE":
-            return Style.OBLIQUE
-        else:
-            raise AttributeError("There is no Style Called %s" % string)
-
-    @staticmethod
-    def str2weight(string: str) -> Weight:
-        """Internally used function. Convert text to Pango Understandable Weight"""
-        if string == "NORMAL":
-            return Weight.NORMAL
-        elif string == "BOLD":
-            return Weight.BOLD
-        elif string == "THIN":
-            return Weight.THIN
-        elif string == "ULTRALIGHT":
-            return Weight.ULTRALIGHT
-        elif string == "LIGHT":
-            return Weight.LIGHT
-        elif string == "BOOK":
-            return Weight.BOOK
-        elif string == "MEDIUM":
-            return Weight.MEDIUM
-        elif string == "SEMIBOLD":
-            return Weight.SEMIBOLD
-        elif string == "ULTRABOLD":
-            return Weight.ULTRABOLD
-        elif string == "HEAVY":
-            return Weight.HEAVY
-        elif string == "ULTRAHEAVY":
-            return Weight.ULTRAHEAVY
-        else:
-            raise AttributeError("There is no Font Weight Called %s" % string)
-
-    @staticmethod
-    def remove_last_M(file_name: str) -> None:
-        """Remove element from the SVG file in order to allow comparison."""
-        with open(file_name, "r") as fpr:
-            content = fpr.read()
-        content = re.sub(r'Z M [^A-Za-z]*? "\/>', 'Z "/>', content)
-        with open(file_name, "w") as fpw:
-            fpw.write(content)