Metadata-Version: 2.1
Name: ms3
Version: 1.1.2
Summary: A parser for annotated MuseScore 3 files.
Home-page: https://github.com/johentsch/ms3
Author: Johannes Hentschel
Author-email: johannes.hentschel@epfl.ch
License: gpl3
Project-URL: Documentation, https://johentsch.github.io/ms3/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/x-rst; charset=UTF-8
Provides-Extra: testing
License-File: LICENSE.txt
License-File: AUTHORS.rst

|license| |version| |release|  |size|

.. |license| image:: https://img.shields.io/github/license/johentsch/ms3?color=%230000ff
    :alt: GitHub

.. |release| image:: https://img.shields.io/github/release-date/johentsch/ms3
    :alt: GitHub Release Date

.. |size| image:: https://img.shields.io/github/repo-size/johentsch/ms3
    :alt: GitHub repo size

.. .. |tests| image:: https://img.shields.io/github/workflow/status/johentsch/ms3/run_tests/main?label=tests
    :alt: GitHub Workflow Status (branch)

.. |version| image:: https://img.shields.io/pypi/v/ms3?color=%2300
    :alt: PyPI


=========================
ms3 - Parsing MuseScore 3
=========================

..
    Plan to use
    .. include:: ./docs/intro.rst
    failed because of PyPi


Welcome to **ms3**, a Python library for parsing annotated `MuseScore 3 <https://musescore.org/en/download>`__ files. It

* parses uncompressed MuseScore 3 files (``*.mscx``),
* also parses compressed MuseScore 2 & 3 files (``*.mscz``), and cap, capx, midi, and musicxml formats by temporally converting them
* stores the contained information (notes, harmonies, lyrics etc.) in a tabular format (``*.tsv``),
* deletes and writes annotation labels to MuseScore's <Harmony> layer,
* parses and transforms labels following the `DCML harmonic annotation standard <https://github.com/DCMLab/standards>`__

View the documentation on `GitHub <https://johentsch.github.io/ms3/>`__.

Video `available on YouTube <https://youtu.be/UBY3wuIS4wc>`__

Note
====

This project has been set up using PyScaffold 3.2.3. For details and usage
information on PyScaffold see https://pyscaffold.org/.
