pycaption 2.2.20__tar.gz → 2.2.22__tar.gz

{pycaption-2.2.20/pycaption.egg-info → pycaption-2.2.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycaption
-Version: 2.2.20
+Version: 2.2.22
 Summary: Closed caption converter
 Author: Joe Norton
 Author-email: joey@nortoncrew.com
@@ -51,7 +51,7 @@ output the CaptionSet into captions of your desired format.
 Tested with Python versions 3.10, 3.11 and 3.12.
 (for Python 2 use pycaption < 1.0.0)
 
-For details, see the `documentation <http://pycaption.readthedocs.org>`__.
+For details, see the `documentation <https://pycaption.readthedocs.io>`__.
 
 License
 -------

{pycaption-2.2.20 → pycaption-2.2.22}/README.rst

@@ -10,7 +10,7 @@ output the CaptionSet into captions of your desired format.
 Tested with Python versions 3.10, 3.11 and 3.12.
 (for Python 2 use pycaption < 1.0.0)
 
-For details, see the `documentation <http://pycaption.readthedocs.org>`__.
+For details, see the `documentation <https://pycaption.readthedocs.io>`__.
 
 License
 -------

pycaption-2.2.22/pycaption/__init__.py

@@ -0,0 +1,66 @@
+from .base import Caption, CaptionConverter, CaptionList, CaptionNode, CaptionSet
+from .dfxp import DFXPReader, DFXPWriter
+from .exceptions import (
+    CaptionLineLengthError,
+    CaptionReadError,
+    CaptionReadNoCaptions,
+    CaptionReadSyntaxError,
+)
+from .microdvd import MicroDVDReader, MicroDVDWriter
+from .sami import SAMIReader, SAMIWriter
+from .scc import SCCReader, SCCWriter
+from .scc.translator import translate_scc
+from .srt import SRTReader, SRTWriter
+from .transcript import TranscriptWriter
+from .webvtt import WebVTTReader, WebVTTWriter
+
+__all__ = [
+    "CaptionConverter",
+    "DFXPReader",
+    "DFXPWriter",
+    "MicroDVDReader",
+    "MicroDVDWriter",
+    "SAMIReader",
+    "SAMIWriter",
+    "SRTReader",
+    "SRTWriter",
+    "SCCReader",
+    "SCCWriter",
+    "translate_scc",
+    "WebVTTReader",
+    "WebVTTWriter",
+    "CaptionReadError",
+    "CaptionReadNoCaptions",
+    "CaptionReadSyntaxError",
+    "detect_format",
+    "CaptionNode",
+    "Caption",
+    "CaptionList",
+    "CaptionSet",
+    "TranscriptWriter",
+]
+
+SUPPORTED_READERS = (
+    DFXPReader,
+    MicroDVDReader,
+    WebVTTReader,
+    SAMIReader,
+    SRTReader,
+    SCCReader,
+)
+
+
+def detect_format(caps):
+    """
+    Detect the format of the provided caption string.
+
+    :returns: the reader class for the detected format.
+    """
+    if not len(caps):
+        raise CaptionReadNoCaptions("Empty caption file")
+
+    for reader in SUPPORTED_READERS:
+        if reader().detect(caps):
+            return reader
+
+    return None

pycaption-2.2.22/pycaption/dfxp/__init__.py

@@ -0,0 +1,2 @@
+from .base import *  # noqa: F401, F403
+from .extras import LegacyDFXPWriter, SinglePositioningDFXPWriter  # noqa: F401