Developer Reference

• Testing music21
  • Module-level testing
  • Documentation Testing
  • Running all tests
  • Continuous Integration Tests
  • Code Coverage Tests
  • Testing the User’s Guide
  • Conclusion
• Documenting music21
  • .rst format files
  • Jupyter Notebook (.ipynb) files
• Documenting modules and classes
  • Displaying only some of the test code in the documentation
  • Ordering Module-Level Class Names and Module-Level Functions
  • Ordering Class-Level Names
  • Documenting Class-Level Properties
  • Documenting Class-Level Attributes
  • Documenting Class-Level Methods
• Building Documentation
• Using music21 with the Jupyter (iPython) Notebook
  • Setting up the Jupyter environment
  • Using the web-based Jupyter Notebook
• Using music21 with Git
  • Installing Git
  • Install PyCharm
  • Forking music21 on GitHub
  • Committing, pushing and pulling
  • Sending pull requests to the official music21 repository
  • Getting your pull requests accepted
• Unofficial MusicXML Test Suite
  • 01 … Pitches
  • 02 … Rests
  • 03 … Rhythm
  • 11 … Time signatures
  • 12 … Clefs
  • 13 … Key signatures
  • 14 … Staff attributes
  • 21 … Chorded notes
  • 22 … Note settings, heads, etc.
  • 23 … Triplets, Tuplets
  • 24 … Grace notes
  • 31 … Dynamics and other single symbols
  • 32 … Notations and Articulations
  • 33 … Spanners
  • 41 … Multiple parts (staves)
  • 42 … Multiple voices per staff
  • 43 … One part on multiple staves
  • 45 … Repeats
  • 46 … Barlines, Measures
  • 51 … Header information
  • 52 … Page layout
  • 61 … Lyrics
  • 71 … Guitar notation
  • 72 … Transposing instruments
  • 73 … Percussion
  • 74 … Figured bass
  • 75 … Other instrumental notation
  • 90 … Compressed MusicXML files
  • 99 … Compatibility with broken MusicXML

Documentation and tests in progress

• Examples and Demonstrations
  • Searching the Corpus by Locale
  • Pitch and Duration Transformations
• Timespan Demos
• Inversion Demo