Alto
latest

API reference

Every public module, class and function in Alto, with its signature and docstring. Names that begin with an underscore are internal and are left out. The pages are written from the docstrings by scripts/api_docs.py, so they match the code.

alto

Alto: a music theory trainer that learns what you find hard and asks it more often.

Module What it is
alto.audio Note playback: recorded instrument samples (University of Iowa), with pitch-shifting for missing notes.
alto.circle_schemes The colour schemes of the circle of fifths: the presets, and the schemes a user makes.
alto.instrument_info What is known about each instrument’s recordings, for the summary shown in the instrument settings.
alto.location Where Alto keeps its practice history and its settings, and how to keep them somewhere else with ALTO_HOME.
alto.selfupdate Replacing a packaged copy of Alto with a newer release: whether it can, getting the update, checking it, and handing over.
alto.settings User settings. Pure Python (no Qt); persistence lives in ui/settings_panel.py.
alto.updates What kind of copy of Alto is running, how it can be updated, and the commands and answers that checking involves.

alto.exercises

The exercises and the framework they are built on.

Module What it is
alto.exercises.base Exercise framework. To add an exercise: subclass Exercise, decorate with @register.
alto.exercises.library The exercises: note names, intervals, key signatures, scales, chords, arpeggios, keyboard keys and note construction.

alto.learning

Spaced repetition: who is learning (profiles), what they answered (a database) and what to ask next.

Module What it is
alto.learning.backup Backup files: everything Alto keeps, in one file that can be read back into a clean install. Pure Python (no Qt).
alto.learning.database The SQLite store: profiles, every answer given, and what is known about each question. Pure Python (no Qt).
alto.learning.learner Ties the profile, the database and the scheduler together for the exercise screen.
alto.learning.scheduler How a question’s history turns into how soon it comes back. Pure Python, no database and no Qt.
alto.learning.stats Numbers and series for the statistics screen, worked out from the answers in the database. Pure Python, no Qt.

alto.lessons

The lessons: guided walks through a topic, with small exercises along the way.

Module What it is
alto.lessons.base What a lesson is made of: steps, and the small tasks inside them.
alto.lessons.circle_of_fifths The lesson on the circle of fifths, taught from nothing.
alto.lessons.clef_basics The lesson on clefs, taught from nothing.

alto.theory

Music theory, with no user interface.

Module What it is
alto.theory.fifths The circle of fifths: the twelve keys in order, each major with its relative minor.
alto.theory.pitch Pitches and intervals, spelled correctly (C# is not Db).
alto.theory.scales Scales, modes, key signatures and chords, built from spelled intervals.

alto.ui

The windows, widgets and drawing code. Everything that needs Qt is in here.

Module What it is
alto.ui.app_settings The application-wide settings dialog.
alto.ui.backup_flow Exporting a backup and importing one: the file dialogs, the questions asked, and the safety copy made before anything is replaced.
alto.ui.charts Small charts drawn with QPainter, in the application’s theme colours.
alto.ui.circle The circle of fifths: twelve wedges, the major keys on the outside and their relative minors on the inside.
alto.ui.circle_colours The pages of the circle of fifths settings that choose its colours: a grid of schemes to pick from, and an editor to make one.
alto.ui.colors Mixing colours. The interface blends palette colours to get its soft tints and highlights.
alto.ui.database_page A read-only look at what is stored: every answer, every question’s record, and the profiles.
alto.ui.engraving Drawing notation with SMuFL music fonts (Bravura, Leland, Petaluma, MuseJazz and others).
alto.ui.exercise_view The exercise screen: a question, its answer buttons, the score, and a pane of settings that slides in from the right.
alto.ui.home The start screen: a card for every exercise, or for every lesson, in rows.
alto.ui.icons Small monochrome icons drawn from SVG, tinted with the current theme’s text colour.
alto.ui.instrument_picker Choosing the instrument that plays notes, with a summary of what each one is made from.
alto.ui.key_fork The fork: a picker for a key signature, shaped like a tuning fork lying on its side.
alto.ui.keyboard The on-screen piano keyboard, drawn to real proportions, and a miniature of the whole piano for choosing a span of keys.
alto.ui.keyboard_styles Keyboard styles: the colours and materials the on-screen piano keys are drawn in.
alto.ui.lesson The lesson pages: a page that walks through one lesson step by step.
alto.ui.lesson_nav The list on the left in lesson mode: the lessons, and the steps of the one that is open.
alto.ui.main_window The main window: a menu, the exercise list on the left that can be collapsed, and the page on the right.
alto.ui.notation Notation styles: which music font the staff, clefs, notes and accidentals are engraved in.
alto.ui.notes Engraved notes built from the Noto Music font’s glyphs, the way notation software draws them.
alto.ui.package_update The window that updates a packaged copy of Alto: the download and its checks with their progress, then what happens next.
alto.ui.pictures Small pictures of musical things (clefs, note values, key signatures, note ranges …) for the settings panes.
alto.ui.profile_dialog Choosing who is practising. There is no password: a profile is just a name that keeps its own history.
alto.ui.question_preview A popup showing a stored question the way the exercise showed it, with its answer.
alto.ui.reference The reference pane: an interactive circle of fifths to look things up on, with an explanation under it.
alto.ui.settings_panel The settings panels that slide in beside an exercise, and the small widgets they are built from.
alto.ui.staff The staff: lines, clefs, key signatures and notes, drawn on a rounded white “paper”.
alto.ui.staff_input The staffs you click to place notes or a clef.
alto.ui.stats_dialog The statistics screen: a few numbers and charts about how practice is going.
alto.ui.store The application’s saved settings (a thin layer over QSettings).
alto.ui.style Application-wide stylesheet: rounded corners on buttons, panes, lists and scroll bars.
alto.ui.theme The colour theme: follow the system, force light or dark, or use a theme with colours of its own.
alto.ui.theme_cards The card of a theme in the settings.
alto.ui.theme_editor The editor for a theme of the user’s own: a name, and a colour for every part of its light and dark versions.
alto.ui.transition_preview A preview of a transition for the settings.
alto.ui.transitions The transitions between the exercises and the lessons on the home page.
alto.ui.update_flow Checking for a newer Alto and installing it: the questions asked, the progress shown, and the restart afterwards.
alto.ui.widgets Small widgets shared by several screens: the sidebar toggle, the help button and a segmented control.