mirror of
https://github.com/kennethreitz/pytheory.git
synced 2026-06-05 23:00:20 +00:00
kennethreitz
4a77f9163e
- User guide: quickstart, tones, scales, chords, fretboard, playback - API reference: autodoc for all modules - alabaster theme with Napoleon for Google/NumPy docstrings - Update project description in pyproject.toml - Add sphinx to docs dependency group Build with: uv run --group docs sphinx-build -b html docs docs/_build/html Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
63 lines
1.5 KiB
ReStructuredText
63 lines
1.5 KiB
ReStructuredText
Quickstart
|
|
==========
|
|
|
|
Installation
|
|
------------
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install pytheory
|
|
|
|
Or with `uv <https://github.com/astral-sh/uv>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
uv add pytheory
|
|
|
|
Basic Usage
|
|
-----------
|
|
|
|
Create tones, build scales, and explore music theory:
|
|
|
|
.. code-block:: python
|
|
|
|
from pytheory import Tone, TonedScale, Fretboard, CHARTS
|
|
|
|
# Create a tone
|
|
c4 = Tone.from_string("C4")
|
|
print(c4) # C4
|
|
print(c4.frequency) # 261.63 Hz
|
|
|
|
# Tone arithmetic
|
|
e4 = c4 + 4 # Major third up
|
|
g4 = c4 + 7 # Perfect fifth up
|
|
print(e4, g4) # E4 G4
|
|
|
|
# Measure intervals
|
|
print(g4 - c4) # 7 (semitones)
|
|
|
|
# Build a scale
|
|
c_major = TonedScale(tonic="C4")["major"]
|
|
print(c_major.note_names)
|
|
# ['C', 'D', 'E', 'F', 'G', 'A', 'B', 'C']
|
|
|
|
# Build chords from the scale
|
|
I = c_major.triad(0) # C major
|
|
IV = c_major.triad(3) # F major
|
|
V = c_major.triad(4) # G major
|
|
|
|
# Guitar chord fingerings
|
|
fb = Fretboard.guitar()
|
|
fingering = CHARTS["western"]["Am"].fingering(fretboard=fb)
|
|
print(fingering) # (0, 1, 2, 2, 0, 0)
|
|
|
|
What's Included
|
|
---------------
|
|
|
|
- **12-tone Western system** with all chromatic notes
|
|
- **Scales**: major, minor, harmonic minor, and all 7 modes
|
|
- **Pitch calculation** in equal, Pythagorean, and meantone temperaments
|
|
- **Chord charts** with 144 pre-built chords (12 roots x 12 qualities)
|
|
- **Fingering generation** for any fretted instrument
|
|
- **Audio playback** with sine, sawtooth, and triangle wave synthesis
|