Contents¶
Overview¶
docs | |
---|---|
tests | |
package |
Twelve-tone matrix to generate dodecaphonic melodies.

Following a process created by the composer Arnold Schoenberg, this library computes a matrix to create twelve-tone serialism melodies which compose each of the 12 semitones of the chromatic scale with equal importance.
- Save your compositions to MIDI
- Free software: BSD license
Installation¶
pip install twelve-tone
Quick Start¶
You can quickly generate a random twelve-tone melody with the CLI
$ twelve-tone
['C# / Db', 'A# / Bb', 'F', 'D', 'G# / Ab', 'D# / Eb', 'F# / Gb',
'A', 'C', 'G', 'B', 'E']
Or you can use the following methods in a script:
>>> from twelve_tone.composer import Composer
>>> c = Composer()
>>> c.compose()
>>> c.get_melody()
['C# / Db', 'A# / Bb', 'F', 'D', 'G# / Ab', 'D# / Eb', 'F# / Gb',
'A', 'C', 'G', 'B', 'E']
After you have composed a matrix of tone rows, you can save the composition to MIDI:
>>> c.compose()
>>> c.save_to_midi(filename='TWELVE_TONE.mid')
The new MIDI file will be created in your current working directory. If you do not specify a filename for your file, it will default to example.mid.
Documentation¶
Development¶
To run the all tests run:
tox
Note, to combine the coverage data from all the tox environments run:
Windows | set PYTEST_ADDOPTS=--cov-append
tox
|
---|---|
Other | PYTEST_ADDOPTS=--cov-append tox
|
Usage¶
To use Twelve Tone in a project:
import twelve_tone
You can quickly generate a random twelve-tone melody with the CLI
$ twelve-tone
['C# / Db', 'A# / Bb', 'F', 'D', 'G# / Ab', 'D# / Eb', 'F# / Gb',
'A', 'C', 'G', 'B', 'E']
Or you can use the following methods in a script:
>>> from twelve_tone.composer import Composer
>>> c = Composer()
>>> c.compose()
>>> c.get_melody()
['C# / Db', 'A# / Bb', 'F', 'D', 'G# / Ab', 'D# / Eb', 'F# / Gb',
'A', 'C', 'G', 'B', 'E']
After you have composed a matrix of tone rows, you can save the composition to MIDI:
>>> c.compose()
>>> c.save_to_midi(filename='TWELVE_TONE.mid')
You can even select either a specific row or column when generating a melody.
from twelve_tone.composer import Composer
c = Composer()
c.compose()
melody_row = c.get_melody(row=3)
melody_col = c.get_melody(column=7)
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Documentation improvements¶
Twelve Tone could always use more documentation, whether as part of the official Twelve Tone docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/accraze/python-twelve-tone/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up python-twelve-tone for local development:
Fork python-twelve-tone (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:your_name_here/python-twelve-tone.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
tox
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
tox
) [1]. - Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rst
about the changes. - Add yourself to
AUTHORS.rst
.
[1] | If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though … |
Tips¶
To run a subset of tests:
tox -e envname -- py.test -k test_myfeature
To run all the test environments in parallel (you need to pip install detox
):
detox
Authors¶
- Andy Craze - https://github.com/accraze
Changelog¶
0.4.2 (2021-03-11)¶
### 0.4.1 (2021-3-11)
- requirements: added missing dependency click - (#22) - @jgarte
0.4.1 (2019-12-31)¶
### 0.4.1 (2019-12-31)
- composer: matrix should only hold values of type ‘int’ (#20)
0.4.0 (2018-7-08)¶
- composer: added/fixed column tonerow support
0.3.0 (2018-7-04)¶
- cli: added random melody generator command
0.2.1 (2016-8-27)¶
- build: added miditime to setup install requirements
0.2.0 (2016-8-27)¶
- composer: Added save to MIDI capability
0.1.0 (2016-8-20)¶
- First release on PyPI.