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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
Metadata-Version: 2.4
Name: python-ly
Version: 0.9.9
Summary: Tool and library for manipulating LilyPond files
Project-URL: Homepage, https://github.com/frescobaldi/python-ly
Project-URL: Documentation, https://python-ly.readthedocs.io
Project-URL: Repository, https://github.com/frescobaldi/python-ly
Project-URL: Issue tracker, https://github.com/frescobaldi/python-ly/issues
Maintainer-email: Wilbert Berendsen <info@frescobaldi.org>
License: GPL
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Text Editors
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
====================
README for python-ly
====================
This package provides a Python library `ly` containing various Python
modules to parse, manipulate or create documents in LilyPond format.
A command line program `ly` is also provided that can be used to do various
manipulations with LilyPond files.
The LilyPond format is a plain text input format that is used by the
GNU music typesetter LilyPond (www.lilypond.org).
The python-ly package is Free Software, licensed under the GPL. This package
is written by the Frescobaldi developers and is used extensively by the
Frescobaldi project. The main author is Wilbert Berendsen.
| Download from: https://pypi.org/project/python-ly
| Development homepage: https://github.com/frescobaldi/python-ly
The `ly` command line tool
--------------------------
With `ly` you can reformat, or re-indent LilyPond files, transpose music,
translate pitch names, convert LilyPond to syntax-colored HTML, etc.
There is also experimental support for converting LilyPond to MusicXML.
Use::
ly -h
to get a full list of the features of the `ly` command.
Here is an example to re-indent and transpose a LilyPond file::
ly "indent; transpose c d" -o output.ly file.ly
To test the `ly` module from the current directory without installing, use::
python -m ly <args...>
This will behave like running the `ly` command when the package is installed.
The `ly` Python module
----------------------
The `ly` module requires Python 3. This is a short description
of some modules:
* ``ly.slexer``: generic tools to build parsers using regular expressions
* ``ly.node``: a generic list-like node object to build tree structures with
* ``ly.document``: a tokenized text document (LilyPond file)
* ``ly.lex``: a parser for LilyPond, Scheme, and other formats, using `slexer`
* ``ly.music``: a tree structure of the contents of a document
* ``ly.pitch``: functions for translating, transposing etc
* ``ly.indent``: indent LilyPond text
* ``ly.reformat``: format LilyPond text
* ``ly.dom``: (deprecated) tree structure to build LilyPond text from
* ``ly.words``: words for highlighting and autocompletion
* ``ly.data``: layout objects, properties, interfaces, font glyphs etc extracted
from LilyPond
Documentation
-------------
The documentation is built using Sphinx and located in the doc directory.
If you have Sphinx installed, you can build nicely formatted HTML documentation
by typing ``make html`` in the doc directory.
You can also read the docs online at http://python-ly.readthedocs.org/.
|
