txt2ebook 0.1.129__py3-none-any.whl → 0.1.131__py3-none-any.whl

txt2ebook/__init__.py

@@ -18,6 +18,7 @@
 import argparse
 import logging
 import platform
+from typing import Optional
 import sys
 
 import langdetect
@@ -28,39 +29,39 @@ __version__ = "0.1.126"
 
 
 def setup_logger(config: argparse.Namespace) -> None:
-    """Sets up logging configuration based on command-line arguments.
+    """Configures logging based on command-line arguments.
 
     Args:
-        config (argparse.Namespace): Namespace containing parsed arguments.
+        config: Namespace containing parsed arguments.
     """
     if config.quiet:
         logging.disable(logging.NOTSET)
         return
 
-    level = logging.DEBUG if config.debug else logging.INFO
-    format_string = (
+    log_level = logging.DEBUG if config.debug else logging.INFO
+    log_format = (
         "%(levelname)5s: %(message)s" if config.debug else "%(message)s"
     )
 
     logging.basicConfig(
-        level=level,
-        format=format_string,
+        level=log_level,
+        format=log_format,
         stream=sys.stdout,
         datefmt="%Y-%m-%d %H:%M:%S",
     )
 
 
-def log_or_raise_on_warning(msg: str, raise_on_warning: bool = False) -> None:
-    """Log warnings or raise it as exception.
+def log_or_raise_on_warning(message: str, raise_on_warning: bool = False) -> None:
+    """Logs a warning message or raises an exception.
 
     Args:
-        msg(str): Warning message.
-        raise_on_warning(bool): To raise exception instead of logging.
+        message: The warning message to log or raise.
+        raise_on_warning: If True, raises a RuntimeError instead of logging.
     """
     if raise_on_warning:
-        raise RuntimeError(msg)
+        raise RuntimeError(message)
 
-    logger.warning(msg)
+    logger.warning(message)
 
 
 def print_env() -> None:
@@ -75,7 +76,18 @@ def print_env() -> None:
 
 
 def detect_and_expect_language(content: str, config_language: str) -> str:
-    """Detect and expect the language of the txt content."""
+    """Detects the content language and compares it to the configured language.
+
+    If no config_language is provided, the detected language is used.
+
+    Args:
+        content: The text content to analyze.
+        config_language: The language specified in the configuration.
+
+    Returns:
+        The configured language, or the detected language if none is
+        configured.
+"""
     detect_language = langdetect.detect(content)
     config_language = config_language or detect_language
     logger.info("Config language: %s", config_language)

txt2ebook/cli.py

@@ -30,6 +30,8 @@ from txt2ebook import __version__, setup_logger
 
 logger = logging.getLogger(__name__)
 
+DEFAULT_OUTPUT_FOLDER = "output"
+
 
 def build_parser(
     _args: Optional[Sequence[str]] = None,
@@ -48,7 +50,7 @@ def build_parser(
         "-of",
         "--output-folder",
         dest="output_folder",
-        default="output",
+        default=DEFAULT_OUTPUT_FOLDER,
         help="set default output folder (default: '%(default)s')",
     )
 

txt2ebook/exceptions.py

@@ -17,4 +17,4 @@
 
 
 class EmptyFileError(Exception):
-    """Empty file content in txt file."""
+    """Raised when the input file has no content."""

txt2ebook/subcommands/env.py

@@ -35,10 +35,10 @@ def build_subparser(subparsers) -> None:
 
 
 def run(_args: argparse.Namespace) -> None:
-    """Run env subcommand.
+    """Run the env subcommand to print environment information.
 
     Args:
-        config (argparse.Namespace): Config from command line arguments
+        _args (argparse.Namespace): Config from command line arguments (unused).
 
     Returns:
         None

txt2ebook/subcommands/gmi.py

@@ -29,7 +29,7 @@ logger = logging.getLogger(__name__)
 def build_subparser(subparsers) -> None:
     """Build the subparser."""
     gmi_parser = subparsers.add_parser(
-        "gmi", help="generate ebook in Markdown format"
+        "gmi", help="generate ebook in Gemtext format"
     )
 
     gmi_parser.set_defaults(func=run)

{txt2ebook-0.1.129.dist-info → txt2ebook-0.1.131.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: txt2ebook
-Version: 0.1.129
+Version: 0.1.131
 Summary: CLI tool to convert txt file to ebook format
 Home-page: https://github.com/kianmeng/txt2ebook
 License: AGPL-3.0-or-later

{txt2ebook-0.1.129.dist-info → txt2ebook-0.1.131.dist-info}/RECORD

@@ -1,7 +1,7 @@
-txt2ebook/__init__.py,sha256=pYny7KkuC0o1Sgd_O1DW8qkfwhaa9H9zEOvYBVE00wI,2706
+txt2ebook/__init__.py,sha256=wnrJownTB3sKXv3BpcXn4exkpWRSCXhKYWKJib5APNI,3073
 txt2ebook/__main__.py,sha256=L29rlfPSx9XMnVaHBYP2dyYgDmutJvONR3yUejjYwRY,855
-txt2ebook/cli.py,sha256=D0jseJLlFDjLfX-yiGCC0e98a5IJ1IbRFx_mVGyYIxc,4241
-txt2ebook/exceptions.py,sha256=oVtVMCqrxWq-CZ5GQYOBioil9i2kJ2mqD08IQ9A636Q,847
+txt2ebook/cli.py,sha256=Ed-58FCFYQQbBFJjA1f2aUTLhsxkoD4t67Y5WxWUNHQ,4288
+txt2ebook/exceptions.py,sha256=PT3m85PE5QopHHUfRwEQzp0kJ4AA9yjLO6V6lYC8WhQ,858
 txt2ebook/formats/__init__.py,sha256=yNF426_jHKNCKenKj1JTbOs22vEBuGScEk6TKhFaZUk,1716
 txt2ebook/formats/base.py,sha256=ODguJ7OBPXfRQLLeoL-G66NZihroXb4kG5-56ZrlygI,5819
 txt2ebook/formats/epub.py,sha256=IVz-FmYQlcChOw38YqfKy46bPVSIrHyxA_94iz06N3Y,6941
@@ -34,9 +34,9 @@ txt2ebook/models/chapter.py,sha256=6YvUDHzR6amGMZgkQl_xHWrYZUmlfpF7mnDLilG2BpA,1
 txt2ebook/models/volume.py,sha256=koz1KfWjvGWLFbmGEQlZ23frsP93cDsuBMySYBHiXm8,1597
 txt2ebook/parser.py,sha256=ClcmWdFMSLfU-76vVnoHVAb6N7qYhCy6zmIwK0MPx9M,9006
 txt2ebook/subcommands/__init__.py,sha256=ldhzvsrMsR8lZmhZef77JFz0jValpV3pytFfwJSkjls,1146
-txt2ebook/subcommands/env.py,sha256=Fx2IXNmmlW-6jlMjRPI-nYp90Sbi77Z2SeL4q3cGg2w,1495
+txt2ebook/subcommands/env.py,sha256=NoebfEzrxjfrUTUvOHc14euyvrAD0W4SfUrBQQycJR8,1541
 txt2ebook/subcommands/epub.py,sha256=JDDucrRiiQW1B7ycKz5zS1X5SMQZ82GBtlE2_SBYIdw,3507
-txt2ebook/subcommands/gmi.py,sha256=zVvP2ZjLtDdqew4Vlab2_R3H2OmQkpMKdfND6qgppiU,3320
+txt2ebook/subcommands/gmi.py,sha256=IE6NsQJz7Rz8mXmYgJJXuaaPP7gznf0ZNhxhWFxjjm0,3319
 txt2ebook/subcommands/massage.py,sha256=EuC-C03NMJk9V1_PEUOa-n4SmQCRpj1TJ_GwSJE8_Ss,11809
 txt2ebook/subcommands/md.py,sha256=P-oFtb2u-v2F_KU8t249-f5Ihjb_TCT_NWMlOYoq5p4,3330
 txt2ebook/subcommands/parse.py,sha256=FaYTWa2yqkowwPAmHWJC7iCii2Rnus3SUHG10GjjJp4,3022
@@ -45,8 +45,8 @@ txt2ebook/subcommands/tex.py,sha256=X6ZBfuAs_mcJe8PNjzoW339ecPynZduVbcCq0henjiA,
 txt2ebook/subcommands/typ.py,sha256=r4Xf7xSINbYfaIKkVzdyQDlUMWPvOIcbvOwC71spu6w,3682
 txt2ebook/tokenizer.py,sha256=H9AaZVmNP43L3ONvj58u_5weZAjFG9SzQSeS9upGN1U,9642
 txt2ebook/zh_utils.py,sha256=0Yq9r-JL4HntW68vFR6TBP9yQim1a07mfsh_sp-XmaE,4887
-txt2ebook-0.1.129.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
-txt2ebook-0.1.129.dist-info/METADATA,sha256=bms5_2Fl1zZ7wV6ScfOxrsrfP0J3g8Ype4Z5-gnGaAc,4969
-txt2ebook-0.1.129.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-txt2ebook-0.1.129.dist-info/entry_points.txt,sha256=AFikuCV6fqf8_GHwsvWuo9jTGNrCkWY1TJWk5GfMWSk,71
-txt2ebook-0.1.129.dist-info/RECORD,,
+txt2ebook-0.1.131.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
+txt2ebook-0.1.131.dist-info/METADATA,sha256=zCXiM7s9xQoFAyNmv5NU--hc_DeR98OxCwV0M7SML8c,4969
+txt2ebook-0.1.131.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+txt2ebook-0.1.131.dist-info/entry_points.txt,sha256=AFikuCV6fqf8_GHwsvWuo9jTGNrCkWY1TJWk5GfMWSk,71
+txt2ebook-0.1.131.dist-info/RECORD,,