aulos 0.1.2

Python library for speech processing and analysis from a music theory perspective.

aulos

Python library for speech processing and analysis from a music theory perspective.

CI/CD
Package
Meta

Features ✨

• Comprehensive tools for audio processing and analysis based on music theory principles.
• A structured framework for organizing and working with music theory objects.
• Flexible and extensible design, allowing seamless customization and expansion.

Installation 🛠️

Install the package using pip:

pip install aulos

Usage 📖

from aulos.TET12 import Note, PitchClass

print(Note("C#4"))
# stdout:
# <Note: C#4, scale: None>

print(PitchClass("C#"))
# stdout:
# <PitchClass: C#, scale: None>

from aulos.TET12 import Key
from aulos.TET12 import Major, Dorian, Pentatonic

print(Major(Key("C")))
# stdout:
# <Major: <Key: C>>

print(Dorian(Key("C")).components)
# stdout:
# (<PitchClass: C, scale: <Dorian: <Key: C>>>,
#  <PitchClass: D, scale: <Dorian: <Key: C>>>,
#  <PitchClass: Eb, scale: <Dorian: <Key: C>>>,
#  <PitchClass: F, scale: <Dorian: <Key: C>>>,
#  <PitchClass: G, scale: <Dorian: <Key: C>>>,
#  <PitchClass: A, scale: <Dorian: <Key: C>>>,
#  <PitchClass: Bb, scale: <Dorian: <Key: C>>>)

print(Pentatonic(Key("C")).components)
# stdout:
# (<PitchClass: C, scale: <Pentatonic: <Key: C>>>,
#  <PitchClass: D, scale: <Pentatonic: <Key: C>>>,
#  <PitchClass: E, scale: <Pentatonic: <Key: C>>>,
#  <PitchClass: G, scale: <Pentatonic: <Key: C>>>,
#  <PitchClass: A, scale: <Pentatonic: <Key: C>>>)

from aulos.TET12 import Chord
from aulos.TET12 import Major

print(Chord("C").components)
# stdout:
# (<Note: ['Dbb4', 'C4', 'B#3', 'A###3'], scale: None>,
#  <Note: ['Gbbb4', 'Fb4', 'E4', 'D##4'], scale: None>,
#  <Note: ['Abb4', 'G4', 'F##4', 'E###4'], scale: None>)

print(Chord("CM7", scale=Major("C")).components)
# stdout:
# (<Note: C4, scale: <Major: <Key: C>>>,
#  <Note: E4, scale: <Major: <Key: C>>>,
#  <Note: G4, scale: <Major: <Key: C>>>,
#  <Note: B4, scale: <Major: <Key: C>>>)

from aulos.TET12 import Note
from aulos.TET12 import JustIntonationTuner, Equal12Tuner

print(Note("C4", tuner=Equal12Tuner(440)).hz)
# stdout:
# 440.0

print(Note("A4", tuner=JustIntonationTuner(440)).hz)
# stdout:
# 733.3333333333333

Dependencies 🧩

This project uses the following libraries and tools for development and testing.

Runtime Dependencies 📂

This project's final product depends only on Python's standard library. No third-party libraries are required at runtime.

Development Libraries 🛠️

The following libraries are used during development and testing but are not included in the final product

• pytest
• pytest-cov
• ruff
• mypy

GitHub Actions ⚙️

• robvanderleek/create-issue-branch
• release-drafter/release-drafter
• pypa/gh-action-pypi-publish
• codecov/codecov-action

License 📜

This project is distributed under the MIT License. For more information, refer to the LICENSE file.

Contact 📬

• Email: [e-mail]