py-caption
==========

|Build Status| |Python Versions| |Pre-Commit| |Dependencies| |License|

``pycaption`` is a caption reading/writing module. Use one of the given Readers
to read content into a CaptionSet object, and then use one of the Writers to
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 <https://pycaption.readthedocs.io>`__.

License
-------

This module is Copyright (c) 2012-2026 PBS.org and is available under the `Apache
License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`__.

.. |Build Status| image:: https://github.com/pbs/pycaption/actions/workflows/unit_tests.yml/badge.svg
    :target: https://github.com/pbs/pycaption/actions/workflows/unit_tests.yml
    :alt: Unit Tests

.. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

.. |Dependencies| image:: https://img.shields.io/librariesio/release/pypi/pycaption
    :target: https://libraries.io/pypi/pycaption
    :alt: Dependencies

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pycaption
    :target: https://pypi.org/project/pycaption/
    :alt: Python Versions

.. |License| image:: https://img.shields.io/github/license/pbs/pycaption
    :target: https://github.com/pbs/pycaption/blob/main/LICENSE
    :alt: License