cavatina-converter/README.md_ at master · LexLuengas/cavatina-converter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Cavatina converter

This package contains a collection of scripts for parsing and translating music notation written in [Cavatina](https://github.com/LexLuengas/cavatina). It contains readers for rich text (.rtf) and plain text (.txt) and can translate to the MusicXML and MIDI formats.

The syntax of the Cavatina language is described on the [documentation page](http://www.cavatinafont.com/docs.html).

## Example usages

**Convert a RTF file to MusicXML.**

    $ python rtf2xml.py [path] [format]

**Convert a Cavatina string to MusicXML.**

    $ python translator.py [string] [format]

## Support

Currently supported keyboard layouts are:

-   English (International)

-   English (US)

-   English (UK, Apple)

-   English (UK, Windows)

-   French

-   German

-   Italian

-   Spanish

-   Spanish (ISO)

-   Portuguese (Brazil, Windows)

-   Portuguese (Portugal, Windows)

### Installation

Either install the library with pip via the usual `pip install cavatina`, or clone the repo and run `python setup.py install` on its root directory.

### Dependencies

-   [music21](https://github.com/cuthbertLab/music21)

### Services

The _services_ folder contains context menu shortcuts for the translator.

-   *MacOS:* run `./setup.sh` on the same folder as the workflow folders.

-   *Windows:* open and import the registry files.

### License

[LGPL](LICENSE) © 2019 Alexis Luengas