pydez: Python bindings for Dezrann

Dezrann is an open platform to hear, study, and annotate music on the web. Pydez is a simple, spec-compliant Python library for working with Dezrann file formats:

• .dez files (Analysis and Label data), as defined in Encoding music annotations
• .json files (Corpus, Piece, Source, and Metadata), as defined in Specifying corpus and piece (meta)data

Features

• Label: Individual annotation with start, duration, tag, type, comment, and custom attributes
• Analysis: Collection of Labels, possibly with layout rules
• Source: Base class with subclasses for different source types
• Piece: Collection of Sources, with piece/opus metadata
• Corpus: Collection of Pieces, with corpus metadata

All classes support:

• build(dict) → Create from dict (with error handling)
• dump() → Convert to dict

The Analysis, Piece and Corpus classes further support:

• load(filepath) → Load from .json file
• save(filepath) → Save to .json file
• += → Combine instances, or adding another Label/Source/Piece to an existing Analysis/Piece/Corpus

The Piece and Corpus classes further support publish (experimental) to publish corpus/pieces on a Dezrann server.

Installation

pip install pydez

# or, for development
git clone https://gitlab.com/algomus.fr/dezrann/pydez.git
cd pydez
pip install -e .

Example usage

Working with analyses, pieces, and corpora

cd examples
python generate-analysis.py
python generate-piece.py
python load_modify.py
python generate-corpus.py

Creating a service handling music data, as described in External services

python examples/service.py
python examples/service-test.py

Running tests

cd pydez
python -m pytest tests/

License

Dezrann is open-source, and developped with the help of many contributors in the Algomus computer music team and elsewhere. The Python bindings are licensed under the LGPL version 3 or any later version.