MIDIDiff

Contents:

  • Installation
    • Requirements
    • Installation Methods
      • With Poetry (recommended for development)
      • Build and Install Locally
      • Core Library Only
  • Quick Start
    • Command-Line Interface
      • Basic Usage
      • Output Behavior
      • Version Information
      • Debug Information
    • Programmatic Usage
      • Basic Example
      • Advanced Usage
    • How Note Matching Works
  • Usage Guide
    • Command-Line Interface
      • Diff Command
      • Debug Info Command
      • Check Updates Command
      • Upgrade Command
      • Completion Command
      • Version Information
    • Architecture
      • CLI Sub-package (v1.0.0+)
    • API Stability
  • Shell Completions
    • Supported Shells
    • Environment Overrides
    • Generating Completion Scripts
    • Automatic Installation
    • Installation Instructions
      • Bash
      • Zsh
      • Fish
      • PowerShell
      • CMD (Command Prompt)
    • Testing Completions
    • Troubleshooting
      • Completions not working
      • Bash: “command not found” errors
      • Zsh: completions not loading
      • PowerShell: execution policy errors
    • Updating Completions
    • Advanced Usage
      • Custom completion locations
      • Combining with other tools
    • Contributing
  • Testing Guide
    • Development Installation
      • Editable Install with Poetry (Recommended)
      • Editable Install with pip (Alternative)
      • Manual Testing
      • Import Testing
    • Building the Package
    • Continuous Integration
    • Development Workflow
    • Verifying Editable Install
    • Common Issues
      • Editable install not working
      • Import errors after changes
      • Build-system not found error
    • Contributing
  • API Reference
    • Core Module
      • main()
    • MIDI Utilities Module
      • NoteEvent
        • NoteEvent.pitch
        • NoteEvent.start
        • NoteEvent.duration
        • NoteEvent.velocity
        • NoteEvent.PITCH_MIN
        • NoteEvent.PITCH_MAX
        • NoteEvent.VELOCITY_MIN
        • NoteEvent.VELOCITY_MAX
        • NoteEvent.__post_init__()
        • NoteEvent.identity_key()
        • NoteEvent.__init__()
      • extract_notes()
      • notes_to_midi()
    • CLI Module
      • cli()
      • CLI Main Module
        • run_cli()
        • build_parser()
      • CLI Version Module
        • print_version_info()
        • print_debug_info()
        • check_for_updates_command()
        • upgrade_package()
  • Contributing
    • Development Setup
    • Contribution Guidelines
      • Code Contributions
    • Building Documentation
      • Clean Build
      • Testing Documentation
    • Read the Docs
    • License
MIDIDiff
  • Index

Index

_ | B | C | D | E | I | M | N | P | R | S | U | V

_

  • __init__() (midi_diff.midi_utils.NoteEvent method)
  • __post_init__() (midi_diff.midi_utils.NoteEvent method)

B

  • build_parser() (in module midi_diff.cli.main)

C

  • check_for_updates_command() (in module midi_diff.cli.version)
  • cli() (in module midi_diff.cli)

D

  • duration (midi_diff.midi_utils.NoteEvent attribute)

E

  • extract_notes() (in module midi_diff.midi_utils)

I

  • identity_key() (midi_diff.midi_utils.NoteEvent method)

M

  • main() (in module midi_diff.core)
  • midi_diff.cli
    • module
  • midi_diff.cli.main
    • module
  • midi_diff.cli.version
    • module
  • midi_diff.core
    • module
  • midi_diff.midi_utils
    • module
  • module
    • midi_diff.cli
    • midi_diff.cli.main
    • midi_diff.cli.version
    • midi_diff.core
    • midi_diff.midi_utils

N

  • NoteEvent (class in midi_diff.midi_utils)
  • notes_to_midi() (in module midi_diff.midi_utils)

P

  • pitch (midi_diff.midi_utils.NoteEvent attribute)
  • PITCH_MAX (midi_diff.midi_utils.NoteEvent attribute)
  • PITCH_MIN (midi_diff.midi_utils.NoteEvent attribute)
  • print_debug_info() (in module midi_diff.cli.version)
  • print_version_info() (in module midi_diff.cli.version)

R

  • run_cli() (in module midi_diff.cli.main)

S

  • start (midi_diff.midi_utils.NoteEvent attribute)

U

  • upgrade_package() (in module midi_diff.cli.version)

V

  • velocity (midi_diff.midi_utils.NoteEvent attribute)
  • VELOCITY_MAX (midi_diff.midi_utils.NoteEvent attribute)
  • VELOCITY_MIN (midi_diff.midi_utils.NoteEvent attribute)

© Copyright 2026, Inspyre Softworks.

Built with Sphinx using a theme provided by Read the Docs.