Metadata-Version: 2.1
Name: rubysubs
Version: 0.1.0
Summary: Tool/library to add ruby text to subtitles
Home-page: https://github.com/RicBent/rubysubs
Author: Bent
Author-email: bent@mail.de
License: UNKNOWN
Description: # Migaku rubysubs
        
        Tool/library to add ruby text to Advanced SubStation Alpha (.ass) subtitles.
        
        rubysubs is licensed under LGPLv3. See LICENSE for further detail.
        
        ## Installation
        
        Run the following to install:
        
        ```
        pip install rubysubs
        ```
        For binary releases refer to the [releases page](https://github.com/RicBent/rubysubs/releases/).
        
        ## Usage as tool
        
        ```
        rubysubs <source subtitle> <output subtitle> [<tag parser> [arg0] [arg1] ...]
        ```
        
        - Source subtilte: Path to source subtitle file
        - Output subtilte: Path to output subtitle file
        - Tag parser (optional):
          - ruby (default): Ruby square bracket tags, no arguments
          - ja: Migaku Japanese tag parser
            - arg0: mode (furigana/kanji/kana, default: furigana)
            - arg1: pitch highlighting (yes/no, default: yes)
            - arg2: pitch shapes (yes/no, default: no)
            - arg3: unknown word underlining (yes/no, default: yes)
            - arg4: 1T word highlighting (yes/no, default: yes)
        
        Examples:
        
        ```
        rubysubs source.ass out.ass
        rubysubs source_ja.ass out_ja_furigana_no_markings.ass ja furigana no no no no
        rubysubs source_ja.ass out_ja_kana_all_markings.ass ja kana yes yes yes yes
        ```
        
        Notes:
        - Style info is pulled from the style called ``Default``
          - ``ScaleX`` and ``ScaleY`` are reset to 100
          - ``Spacing`` and ``Angle`` are reset to 0
          - ``Italic``, ``Underline`` and ``Strikeout`` are reset. ``Bold`` is supported
          - ``Alignment`` is currently fixed to bottom-center with ``MarginV`` being considered
        - ``PlayResX`` and ``PlayResY`` script info tags should be set to allow screen postion calculations. Defaults to 1920x1080
        - No ASS tags are supported
        
        ## Usage as library
        
        ```python
        import sys
        import rubysubs
        from PyQt5.QtGui import QGuiApplication
        
        # Required for QFontMetrics
        qapp = QGuiApplication(sys.argv)
        
        rubysubs.convert_sub_file('source.ass', 'out.ass', rubysubs.tag_parse_ruby.parse)
        rubysubs.convert_sub_file('source_jp.ass', 'out_ja.ass', rubysubs.tag_parse_migaku_ja.parse)
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
