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>
46 lines
1016 B
ReStructuredText
46 lines
1016 B
ReStructuredText
PyTheory: Music Theory for Humans
|
|
=================================
|
|
|
|
**PyTheory** is a Python library that makes exploring music theory approachable.
|
|
Work with tones, scales, chords, and fretboards using a clean, Pythonic API.
|
|
|
|
.. code-block:: python
|
|
|
|
from pytheory import TonedScale, Fretboard, CHARTS
|
|
|
|
# Build a C major scale
|
|
c_major = TonedScale(tonic="C4")["major"]
|
|
print(c_major.note_names)
|
|
# ['C', 'D', 'E', 'F', 'G', 'A', 'B', 'C']
|
|
|
|
# Build a triad from the scale
|
|
chord = c_major.triad(0) # C major triad
|
|
for tone in chord:
|
|
print(f"{tone}: {tone.frequency:.1f} Hz")
|
|
|
|
# Get guitar fingerings
|
|
fb = Fretboard.guitar()
|
|
print(CHARTS["western"]["C"].fingering(fretboard=fb))
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User Guide
|
|
|
|
guide/quickstart
|
|
guide/tones
|
|
guide/scales
|
|
guide/chords
|
|
guide/fretboard
|
|
guide/playback
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: API Reference
|
|
|
|
api/tones
|
|
api/scales
|
|
api/chords
|
|
api/charts
|
|
api/play
|
|
api/systems
|