✨ feat: rename Danmaku2ASS to convert_to_ass

Author: SigureMo

packages/biliass/README.md

@@ -31,10 +31,10 @@ biliass danmaku.pb -s 1920x1080 -f protobuf -o danmaku.ass
 ```
 
 ```python
-from biliass import Danmaku2ASS
+from biliass import convert_to_ass
 
 # xml
-Danmaku2ASS(
+convert_to_ass(
     xml_text_or_bytes,
     width,
     height,
@@ -50,7 +50,7 @@ Danmaku2ASS(
 )
 
 # protobuf
-Danmaku2ASS(
+convert_to_ass(
     protobuf_bytes, # only bytes
     width,
     height,

packages/biliass/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
   { name = "Star Brilliant", email = "m13253@hotmail.com" },
   { name = "Nyakku Shigure", email = "sigure.qaq@gmail.com" },
 ]
-keywords = ["bilibili", "yutto", "Danmaku2ASS"]
+keywords = ["bilibili", "yutto", "danmaku", "ASS"]
 license = { text = "GPLv3" }
 classifiers = [
   "Operating System :: OS Independent",

packages/biliass/src/biliass/__init__.py

@@ -4,6 +4,7 @@
 
 from .biliass import (
     Danmaku2ASS as Danmaku2ASS,
+    convert_to_ass as convert_to_ass,
     read_comments_bilibili_protobuf as read_comments_bilibili_protobuf,
     read_comments_bilibili_xml as read_comments_bilibili_xml,
 )

packages/biliass/src/biliass/__main__.py

@@ -4,7 +4,7 @@
 import logging
 import sys
 
-from biliass import Danmaku2ASS
+from biliass import convert_to_ass
 from biliass.__version__ import VERSION as biliass_version
 
 
@@ -103,7 +103,7 @@ def main():
         fout = open(args.output, "w", encoding="utf-8-sig", errors="replace", newline="\r\n")  # noqa: PTH123
     else:
         fout = sys.stdout
-    output = Danmaku2ASS(
+    output = convert_to_ass(
         inputs,
         width,
         height,

packages/biliass/src/biliass/biliass.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from collections.abc import Callable
 from typing import TypeVar, cast
 
 from biliass._core import (
@@ -37,6 +38,40 @@ def Danmaku2ASS(
     duration_still: float = 5.0,
     comment_filter: str | None = None,
     is_reduce_comments: bool = False,
+    progress_callback: Callable[[int, int], None] | None = None,
+) -> str:
+    print("Function `Danmaku2ASS` is deprecated in biliass 2.0.0, Please use `convert_to_ass` instead.")
+    if progress_callback is not None:
+        print("`progress_callback` is deprecated in 2.0.0 and will be removed in 2.1.0")
+    return convert_to_ass(
+        inputs,
+        stage_width,
+        stage_height,
+        input_format,
+        reserve_blank,
+        font_face,
+        font_size,
+        text_opacity,
+        duration_marquee,
+        duration_still,
+        comment_filter,
+        is_reduce_comments,
+    )
+
+
+def convert_to_ass(
+    inputs: list[str | bytes] | str | bytes,
+    stage_width: int,
+    stage_height: int,
+    input_format: str = "xml",
+    reserve_blank: int = 0,
+    font_face: str = "sans-serif",
+    font_size: float = 25.0,
+    text_opacity: float = 1.0,
+    duration_marquee: float = 5.0,
+    duration_still: float = 5.0,
+    comment_filter: str | None = None,
+    is_reduce_comments: bool = False,
 ) -> str:
     comment_filters: list[str] = [comment_filter] if comment_filter is not None else []
     if not isinstance(inputs, list):