Kassia is a scoring program for creating music written in Byzantine notation. It takes an XML file, parses the neumes and lyrics, and generates a formatted PDF using ReportLab.
Python 3.7+
- Make sure Python 3.7 or higher is installed
- Install poetry
- Install the required packages by running
poetry install - Start a poetry shell by running
poetry shell - Re-create the sample score in /examples to make sure everything works properly by running
python kassia.py examples/sample.xml examples/sample.pdf
python kassia.py [input_xml_file] [output_pdf_file]
The examples folder has sample scores to experiment with. Input files must be XML files, using the syntax of the sample scores. Output files will be in PDF format.
Scores are saved as XML files (called BNML). Our wiki page explains the structure of a score.
Kassia can utilize true type fonts files to draw neumes. To add new neume fonts, create a folder with the font name, place TTF files in the folder, and create classes.yaml and glyphnames.yaml files. The wiki has more information about how the YAML files should be structured.
Some sample fonts are included for headings and lyrics (Alegreya, EB Garamond, and Gentium Plus). Kassia will scan the /fonts folder and use any TTF files found there.
We need your help with documentation, testing, and submitting fixes and features!
Before submitting a pull request, make sure your changes pass all tests.
- Install imagemagick and poppler
- Run tests:
pytestflake8isort . --recursive --diff