midi-recorder 1.0.0__tar.gz

midi_recorder-1.0.0/.gitignore

@@ -0,0 +1,223 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+*.mid
+*.journal
+recordings/

midi_recorder-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maarten Boot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

midi_recorder-1.0.0/Makefile

@@ -0,0 +1,120 @@
+# midi-recorder: run and check everything inside a virtualenv.
+#   make            -> show targets
+#   make all        -> clean rebuild of the venv, then format, lint, typecheck and test
+#   make check      -> ruff check + ruff format --check + mypy --strict + pytest
+#   make build      -> check, then build sdist + wheel into dist/ and run twine check
+#   make testpypi   -> build, then upload dist/* to TestPyPI (repository section mboot_testpypi in ~/.pypirc)
+#   make pypi       -> only from a clean tree whose HEAD is tagged v<version>: build, then upload dist/* to PyPI after you retype the version
+#   make run ARGS="-o ~/midi --idle 20"
+
+PYTHON ?= python3
+VENV   ?= .venv
+
+ifeq ($(OS),Windows_NT)
+    VBIN := $(VENV)/Scripts
+else
+    VBIN := $(VENV)/bin
+endif
+
+STAMP := $(VENV)/.installed
+VERSION = $(shell sed -n 's/^__version__ = "\(.*\)"/\1/p' midi_recorder.py)
+PY    := midi_recorder.py midi_recorder_gui.py
+SRC   := $(PY) tests stubs
+
+.DEFAULT_GOAL := help
+.PHONY: help all venv lint format format-check typecheck test check build run run-gui clean distclean testpypi pypi pypi-guard
+
+help:
+	@echo "all           distclean + venv + lint + format + format-check + typecheck + test"
+	@echo "venv          create the virtualenv and install dependencies"
+	@echo "lint          ruff check"
+	@echo "format        ruff format (rewrites files)"
+	@echo "format-check  ruff format --check"
+	@echo "typecheck     mypy --strict"
+	@echo "test          pytest"
+	@echo "check         lint + format-check + typecheck + test"
+	@echo "build         build sdist + wheel into dist/ and run twine check"
+	@echo "run           run the recorder (ARGS=\"...\" passes options)"
+	@echo "run-gui       run the status window (needs tkinter; ARGS=\"...\" passes options)"
+	@echo "clean         remove caches"
+	@echo "distclean     clean + remove the virtualenv"
+	@echo "testpypi      check + build + upload dist/* to TestPyPI"
+	@echo "pypi          clean + tagged commit only; check + build + upload dist/* to PyPI after confirmation"
+
+all: distclean venv lint format format-check typecheck test
+
+venv: $(STAMP)
+
+$(STAMP): pyproject.toml
+	$(PYTHON) -m venv $(VENV)
+	$(VBIN)/python -m pip install --upgrade pip
+	$(VBIN)/python -m pip install -e ".[dev]"
+	touch $(STAMP)
+
+lint: $(STAMP)
+	$(VBIN)/ruff check $(SRC)
+
+format: $(STAMP)
+	$(VBIN)/ruff format $(SRC)
+
+format-check: $(STAMP)
+	$(VBIN)/ruff format --check $(SRC)
+
+typecheck: $(STAMP)
+	$(VBIN)/mypy $(PY) tests
+
+test: $(STAMP)
+	$(VBIN)/pytest
+
+check: lint format-check typecheck test
+
+build: $(STAMP) check
+	rm -rf dist
+	$(VBIN)/python -m build
+	$(VBIN)/twine check dist/*
+
+run: $(STAMP)
+	$(VBIN)/python midi_recorder.py $(ARGS)
+
+run-gui: $(STAMP)
+	$(VBIN)/python midi_recorder_gui.py $(ARGS)
+
+clean:
+	rm -rf .mypy_cache .ruff_cache .pytest_cache build dist *.egg-info
+	find . -name __pycache__ -not -path "./$(VENV)/*" -prune -exec rm -rf {} +
+
+distclean: clean
+	rm -rf $(VENV)
+
+# ---------------------------------------
+# Manual uploads. Credentials come from the repository sections in ~/.pypirc (username __token__, password = API token).
+# The normal way to publish is a GitHub release (.github/workflows/release.yml, trusted publishing, no token).
+# Every upload needs a new __version__ in midi_recorder.py: neither index accepts the same file twice.
+testpypi: build
+	$(VBIN)/twine upload \
+		--config-file=$${HOME}/.pypirc \
+		--repository=mboot_testpypi \
+		dist/*
+
+pypi-guard:
+	@set -e; \
+	version="$(VERSION)"; \
+	[ -n "$$version" ] || { echo "error: cannot read __version__ from midi_recorder.py"; exit 1; }; \
+	git rev-parse --git-dir >/dev/null 2>&1 || { echo "error: not a git checkout"; exit 1; }; \
+	if [ -n "$$(git status --porcelain)" ]; then \
+		echo "error: the working tree is not clean, commit or stash first:"; git status --short; exit 1; \
+	fi; \
+	tags="$$(git tag --points-at HEAD)"; \
+	if ! echo "$$tags" | grep -qxF -e "v$$version" -e "$$version"; then \
+		echo "error: HEAD is not tagged v$$version (tags at HEAD: $${tags:-none})"; exit 1; \
+	fi; \
+	echo "ok: clean tree, HEAD is tagged for $$version"
+
+pypi: pypi-guard build
+	@echo; echo "About to upload to PyPI, the real index. An upload can never be replaced:"; ls -1 dist
+	@printf "Type the version (%s) to upload, anything else aborts: " "$(VERSION)"; \
+	read -r answer || answer=""; \
+	[ "$$answer" = "$(VERSION)" ] || { echo "aborted, nothing uploaded"; exit 1; }
+	$(VBIN)/twine upload \
+		--repository=mboot_pypi \
+		dist/*

midi_recorder-1.0.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.5
+Name: midi-recorder
+Version: 1.0.0
+Summary: Record all incoming MIDI events to timestamped .mid files, saved automatically when playing stops
+Project-URL: Homepage, https://github.com/maarten-boot/recording-midi-data
+Project-URL: Issues, https://github.com/maarten-boot/recording-midi-data/issues
+Author: Maarten Boot
+License-Expression: MIT
+License-File: LICENSE
+Keywords: daw,midi,mido,piano,recorder
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Environment :: X11 Applications
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
+Requires-Python: >=3.10
+Requires-Dist: mido>=1.3
+Requires-Dist: python-rtmidi>=1.5.8
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# recording-midi-data
+
+**midi-recorder** records everything that comes in on your MIDI inputs and saves it as a standard MIDI file.
+There is nothing to press: the first note starts a recording, and when you stop playing the file is closed and saved.
+
+Each file is named after the moment the recording started: `2026-10-05_21-35-12.mid`.
+
+- Notes, sustain and other pedals, channel and polyphonic aftertouch, pitch bend and all other messages are kept. Only `clock` and `active_sensing` are dropped.
+- Listens on **all** MIDI inputs at once; inputs plugged in later are picked up automatically.
+- Plays back in real time in any DAW (1 tick = 1 ms).
+- Crash safe: a journal is written while you play, and recovered at the next start.
+- Command line, plus a small status window.
+- Linux, Windows and macOS.
+
+There is no live display of the notes; open the finished file in your DAW for that.
+
+## Install
+
+```
+pipx install midi-recorder        # or: pip install midi-recorder
+```
+
+Python 3.10 - 3.12. The MIDI backend `python-rtmidi` has no prebuilt wheels for Python 3.13 yet, so on 3.13 pip would have to compile it.
+
+| System | Notes |
+|---|---|
+| Linux (Debian, Ubuntu, Fedora) | Needs the ALSA sequencer, which any normal desktop install has. The status window needs tkinter: `sudo apt install python3-tk` (Debian/Ubuntu) or `sudo dnf install python3-tkinter` (Fedora). |
+| Windows 10, 11 | A MIDI input can usually be opened by only one program at a time. Close your DAW first, or route the keyboard through a loopback driver such as loopMIDI so both can listen. |
+| macOS | Should work through CoreMIDI. The automated tests run on macOS, but it has not been tried with a real keyboard. |
+
+## Quick start
+
+```
+midi-recorder --list              # show the MIDI inputs it can see
+midi-recorder -o ~/midi           # record into ~/midi, stop with Ctrl-C
+midi-recorder-gui -o ~/midi       # the same, with a status window
+```
+
+`midi-recorder --list` prints a short error instead of a traceback when no MIDI backend is available.
+
+If you leave out `-o`, files go into the current directory.
+
+## How a recording works
+
+1. A recording **starts** with the first event from any input.
+2. It **ends** when no event has arrived for `--idle` seconds (default 30), *and* no note is held and no sustain pedal is down. While a key or the pedal is held, it waits up to `--max-hold` seconds (default 120) instead, so a long held chord does not cut the file, and a stuck note cannot keep it open forever.
+3. The file is written as a type 1 MIDI file: a tempo track plus **one track per input**, named after the input. With only one keyboard you get one note track.
+4. Ctrl-C (or closing the window) saves the recording in progress before exiting.
+
+Timestamps are taken when the event reaches the program, so their accuracy is whatever your operating system's MIDI driver and scheduling give you, typically about a millisecond.
+
+## Options
+
+Both programs take the same options.
+
+| Option | Default | Meaning |
+|---|---|---|
+| `-o`, `--outdir` | `.` | Folder for the `.mid` files, created if missing. |
+| `--idle` | `30` | Seconds of silence that end a recording. |
+| `--max-hold` | `120` | Longest silence allowed while a note or the sustain pedal is held. |
+| `--log-level` | `INFO` | `DEBUG`, `INFO`, `WARNING` or `ERROR`. |
+| `--log-file` | `<outdir>/midi_recorder.log` | Where to write the log. |
+| `--no-log-file` | | Log to stderr only. |
+| `--list` | | `midi-recorder` only: list the MIDI inputs and exit. |
+
+## Status window
+
+`midi-recorder-gui` shows whether it is **recording** (with the number of events and the elapsed time) or **ready**, the inputs it is listening on, the recordings saved so far, and a button that opens the output folder.
+Closing the window saves the recording in progress.
+
+## If it crashes
+
+While you play, every event is also appended to `YYYY-MM-DD_HH-MM-SS.journal` in the output folder, and the file is flushed as events arrive.
+When a recording is saved normally the journal is deleted.
+If the program or the computer dies mid-recording, the next start turns each leftover journal into a `.mid` file and logs a warning. A write that was cut off by the crash is skipped. If a `.mid` with that name already exists, the recovered file gets `_recovered` in its name instead of overwriting it.
+
+Run only one recorder per output folder, otherwise one could mistake the other's live journal for a crash.
+
+## Logging
+
+Messages go to stderr and to `<outdir>/midi_recorder.log`, which is rotated at 1 MB and keeps 3 old files. A failing MIDI backend or an input that cannot be opened is logged once, not every few seconds.
+
+## Development
+
+```
+git clone https://github.com/maarten-boot/recording-midi-data
+cd recording-midi-data
+make check        # ruff, ruff format --check, mypy --strict, pytest (creates .venv)
+make all          # the same from a fresh venv, also runs ruff format
+make build        # checks, then builds the sdist and wheel into dist/ and runs twine check
+make run ARGS="-o ~/midi"
+```
+
+`make` with no target lists everything. The checks run on Linux, Windows and macOS in GitHub Actions.
+
+`mido` ships no type information, so a minimal stub for the part this program uses lives in `stubs/mido/`.
+
+## License
+
+MIT, see `LICENSE`.
+
+Thanks Claude.

midi_recorder-1.0.0/README.md

@@ -0,0 +1,102 @@
+# recording-midi-data
+
+**midi-recorder** records everything that comes in on your MIDI inputs and saves it as a standard MIDI file.
+There is nothing to press: the first note starts a recording, and when you stop playing the file is closed and saved.
+
+Each file is named after the moment the recording started: `2026-10-05_21-35-12.mid`.
+
+- Notes, sustain and other pedals, channel and polyphonic aftertouch, pitch bend and all other messages are kept. Only `clock` and `active_sensing` are dropped.
+- Listens on **all** MIDI inputs at once; inputs plugged in later are picked up automatically.
+- Plays back in real time in any DAW (1 tick = 1 ms).
+- Crash safe: a journal is written while you play, and recovered at the next start.
+- Command line, plus a small status window.
+- Linux, Windows and macOS.
+
+There is no live display of the notes; open the finished file in your DAW for that.
+
+## Install
+
+```
+pipx install midi-recorder        # or: pip install midi-recorder
+```
+
+Python 3.10 - 3.12. The MIDI backend `python-rtmidi` has no prebuilt wheels for Python 3.13 yet, so on 3.13 pip would have to compile it.
+
+| System | Notes |
+|---|---|
+| Linux (Debian, Ubuntu, Fedora) | Needs the ALSA sequencer, which any normal desktop install has. The status window needs tkinter: `sudo apt install python3-tk` (Debian/Ubuntu) or `sudo dnf install python3-tkinter` (Fedora). |
+| Windows 10, 11 | A MIDI input can usually be opened by only one program at a time. Close your DAW first, or route the keyboard through a loopback driver such as loopMIDI so both can listen. |
+| macOS | Should work through CoreMIDI. The automated tests run on macOS, but it has not been tried with a real keyboard. |
+
+## Quick start
+
+```
+midi-recorder --list              # show the MIDI inputs it can see
+midi-recorder -o ~/midi           # record into ~/midi, stop with Ctrl-C
+midi-recorder-gui -o ~/midi       # the same, with a status window
+```
+
+`midi-recorder --list` prints a short error instead of a traceback when no MIDI backend is available.
+
+If you leave out `-o`, files go into the current directory.
+
+## How a recording works
+
+1. A recording **starts** with the first event from any input.
+2. It **ends** when no event has arrived for `--idle` seconds (default 30), *and* no note is held and no sustain pedal is down. While a key or the pedal is held, it waits up to `--max-hold` seconds (default 120) instead, so a long held chord does not cut the file, and a stuck note cannot keep it open forever.
+3. The file is written as a type 1 MIDI file: a tempo track plus **one track per input**, named after the input. With only one keyboard you get one note track.
+4. Ctrl-C (or closing the window) saves the recording in progress before exiting.
+
+Timestamps are taken when the event reaches the program, so their accuracy is whatever your operating system's MIDI driver and scheduling give you, typically about a millisecond.
+
+## Options
+
+Both programs take the same options.
+
+| Option | Default | Meaning |
+|---|---|---|
+| `-o`, `--outdir` | `.` | Folder for the `.mid` files, created if missing. |
+| `--idle` | `30` | Seconds of silence that end a recording. |
+| `--max-hold` | `120` | Longest silence allowed while a note or the sustain pedal is held. |
+| `--log-level` | `INFO` | `DEBUG`, `INFO`, `WARNING` or `ERROR`. |
+| `--log-file` | `<outdir>/midi_recorder.log` | Where to write the log. |
+| `--no-log-file` | | Log to stderr only. |
+| `--list` | | `midi-recorder` only: list the MIDI inputs and exit. |
+
+## Status window
+
+`midi-recorder-gui` shows whether it is **recording** (with the number of events and the elapsed time) or **ready**, the inputs it is listening on, the recordings saved so far, and a button that opens the output folder.
+Closing the window saves the recording in progress.
+
+## If it crashes
+
+While you play, every event is also appended to `YYYY-MM-DD_HH-MM-SS.journal` in the output folder, and the file is flushed as events arrive.
+When a recording is saved normally the journal is deleted.
+If the program or the computer dies mid-recording, the next start turns each leftover journal into a `.mid` file and logs a warning. A write that was cut off by the crash is skipped. If a `.mid` with that name already exists, the recovered file gets `_recovered` in its name instead of overwriting it.
+
+Run only one recorder per output folder, otherwise one could mistake the other's live journal for a crash.
+
+## Logging
+
+Messages go to stderr and to `<outdir>/midi_recorder.log`, which is rotated at 1 MB and keeps 3 old files. A failing MIDI backend or an input that cannot be opened is logged once, not every few seconds.
+
+## Development
+
+```
+git clone https://github.com/maarten-boot/recording-midi-data
+cd recording-midi-data
+make check        # ruff, ruff format --check, mypy --strict, pytest (creates .venv)
+make all          # the same from a fresh venv, also runs ruff format
+make build        # checks, then builds the sdist and wheel into dist/ and runs twine check
+make run ARGS="-o ~/midi"
+```
+
+`make` with no target lists everything. The checks run on Linux, Windows and macOS in GitHub Actions.
+
+`mido` ships no type information, so a minimal stub for the part this program uses lives in `stubs/mido/`.
+
+## License
+
+MIT, see `LICENSE`.
+
+Thanks Claude.