Metadata-Version: 2.1
Name: pytitle
Version: 0.1.4
Summary: Subtitle manipulation library for python.
Home-page: https://github.com/sina-e/pytitle
Author: Sina Ebrahimi
Author-email: ebrahimisina78@gmail.com
License: MIT
Project-URL: Documentation, https://pytitle.readthedocs.io
Project-URL: Source, https://github.com/sina-e/pytitle
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.8
License-File: LICENSE

Subtitle manipulation library for Python
========================================

|PyPI| |PyPI - Downloads| |PyPI - Python Version| |PyPI - License| |Read
the Docs| |GitHub issues|

PyTitle is a subtitle manipulation library for python, it’s built on top
of Pydantic.

**note that development of this project is just started and it’s not
anywhere near complete or ready for production code. use it at your own
risk**

what this library can do?

well, it’s able to do a lot of things, and more in the future, but for now:

-  search for a text or pattern in a subtitle.
-  shift all the timestaps, or just one timestap to forward or backward.
-  split the subtitle from an index or timestamp.
-  fix common problems in a subtitle, such as:

   -  re-index .srt subtitles.
   -  remove or fix italic, bold and other formatting tags.
   -  add coloring or other formattings to a subtitle.
   -  fix enconding problems.
   -  fix arabic charachters, question marks and other formattings for
      persian subtitles.
   -  fix overlays in timestamps.

Installing PyTitle
------------------

``pip install pytitle``

Quick start
-----------

For now, the only supported subtitle format is ``.srt``. other formats
will be added to the library soon.

Open a .srt Subtitle:

.. code:: python

   from pytitle.srt import SrtSubtitle

   subtitle = SrtSubtitle.open("~/path/to/subtitle.srt")

shift all the timestamps for the opened subtitle 2 seconds forward:

.. code:: python

   subtitle.shift_forward(seconds=2)

or you can shift only one line, for example the 10th line(.srt indexes
start at 1):

.. code:: python

   subtitle.shift_forward(seconds=2, index=10)

and when you done editing, save the file:

.. code:: python

   subtitle.save()

the above method will override the existing file, if you want to save
the file in a different place or seperately:

.. code:: python

   subtitle.save(path="~/path/to/edited_subtitle.srt")

**Read the full documentation and
tutorial**\ `here <https://pytitle.readthedocs.io>`__\ **.**

supported formats:
~~~~~~~~~~~~~~~~~~

-  ☒ srt
-  ☐ ass
-  ☐ vtt

.. |PyPI| image:: https://img.shields.io/pypi/v/pytitle
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/pytitle
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/pytitle
.. |PyPI - License| image:: https://img.shields.io/pypi/l/pytitle
.. |Read the Docs| image:: https://img.shields.io/readthedocs/pytitle
.. |GitHub issues| image:: https://img.shields.io/github/issues/sina-e/pytitle


