aulos 0.1.0__tar.gz

aulos-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Oujox
+
+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.

aulos-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+exclude ./src/run.py

aulos-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.2
+Name: aulos
+Version: 0.1.0
+Summary: Python library for speech processing and analysis from a music theory perspective.
+License: MIT License
+        
+        Copyright (c) 2024 Oujox
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/Oujox/aulos
+Project-URL: Repository, https://github.com/Oujox/aulos
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# aulos
+
+Python library for speech processing and analysis from a music theory perspective.
+
+| | |
+| --- | --- |
+| CI/CD | [![Test](https://github.com/Oujox/aulos/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Oujox/aulos/actions/workflows/ci.yml) [![Build & Publish](https://github.com/Oujox/aulos/actions/workflows/cd.yml/badge.svg?branch=main)](https://github.com/Oujox/aulos/actions/workflows/cd.yml) |
+| Package |  |
+| Meta | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://github.com/python/mypy) [![codecov](https://codecov.io/gh/Oujox/aulos/graph/badge.svg?token=UP6ZQP7HMK)](https://codecov.io/gh/Oujox/aulos) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/Oujox/aulos/blob/main/LICENSE) |
+
+## 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 🛠️
+
+## Usage 📖
+
+```python
+from aulos.TET12 import Note, PitchClass
+
+print(Note("C#4"))
+# stdout:
+# <Note: C#4, scale: None>
+
+print(PitchClass("C#"))
+# stdout:
+# <PitchClass: C#, scale: None>
+```
+
+```python
+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>>>)
+```
+
+```python
+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**](https://docs.pytest.org/en/latest/)
+- [**pytest-cov**](https://github.com/pytest-dev/pytest-cov)
+- [**ruff**](https://docs.astral.sh/ruff)
+- [**mypy**](https://www.mypy-lang.org/)
+
+### GitHub Actions ⚙️
+
+- [**robvanderleek/create-issue-branch**](https://github.com/robvanderleek/create-issue-branch)
+- [**release-drafter/release-drafter**](https://github.com/release-drafter/release-drafter)
+- [**pypa/gh-action-pypi-publish**](https://github.com/pypa/gh-action-pypi-publish)
+- [**codecov/codecov-action**](https://github.com/codecov/codecov-action)
+- [**actions/checkout**](https://github.com/actions/checkout)
+- [**actions/setup-python**](https://github.com/actions/setup-python)
+- [**actions/upload-artifact**](https://github.com/actions/upload-artifact)
+- [**actions/download-artifact**](https://github.com/actions/download-artifact)
+
+## License 📜
+
+This project is distributed under the MIT License. For more information, refer to the [LICENSE](https://github.com/Oujox/aulos/blob/main/LICENSE) file.
+
+## Contact 📬
+
+- Email: oujoxyz365@gmail.com

aulos-0.1.0/README.md

@@ -0,0 +1,107 @@
+# aulos
+
+Python library for speech processing and analysis from a music theory perspective.
+
+| | |
+| --- | --- |
+| CI/CD | [![Test](https://github.com/Oujox/aulos/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Oujox/aulos/actions/workflows/ci.yml) [![Build & Publish](https://github.com/Oujox/aulos/actions/workflows/cd.yml/badge.svg?branch=main)](https://github.com/Oujox/aulos/actions/workflows/cd.yml) |
+| Package |  |
+| Meta | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://github.com/python/mypy) [![codecov](https://codecov.io/gh/Oujox/aulos/graph/badge.svg?token=UP6ZQP7HMK)](https://codecov.io/gh/Oujox/aulos) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/Oujox/aulos/blob/main/LICENSE) |
+
+## 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 🛠️
+
+## Usage 📖
+
+```python
+from aulos.TET12 import Note, PitchClass
+
+print(Note("C#4"))
+# stdout:
+# <Note: C#4, scale: None>
+
+print(PitchClass("C#"))
+# stdout:
+# <PitchClass: C#, scale: None>
+```
+
+```python
+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>>>)
+```
+
+```python
+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**](https://docs.pytest.org/en/latest/)
+- [**pytest-cov**](https://github.com/pytest-dev/pytest-cov)
+- [**ruff**](https://docs.astral.sh/ruff)
+- [**mypy**](https://www.mypy-lang.org/)
+
+### GitHub Actions ⚙️
+
+- [**robvanderleek/create-issue-branch**](https://github.com/robvanderleek/create-issue-branch)
+- [**release-drafter/release-drafter**](https://github.com/release-drafter/release-drafter)
+- [**pypa/gh-action-pypi-publish**](https://github.com/pypa/gh-action-pypi-publish)
+- [**codecov/codecov-action**](https://github.com/codecov/codecov-action)
+- [**actions/checkout**](https://github.com/actions/checkout)
+- [**actions/setup-python**](https://github.com/actions/setup-python)
+- [**actions/upload-artifact**](https://github.com/actions/upload-artifact)
+- [**actions/download-artifact**](https://github.com/actions/download-artifact)
+
+## License 📜
+
+This project is distributed under the MIT License. For more information, refer to the [LICENSE](https://github.com/Oujox/aulos/blob/main/LICENSE) file.
+
+## Contact 📬
+
+- Email: oujoxyz365@gmail.com

aulos-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = [
+    "setuptools",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aulos"
+version = "0.1.0"
+description = "Python library for speech processing and analysis from a music theory perspective."
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+requires-python = ">=3.12"
+dependencies = []
+
+[project.scripts]
+aulos = "aulos.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/Oujox/aulos"
+Repository = "https://github.com/Oujox/aulos"
+
+[tool.setuptools]
+package-dir = { "" = "src" }

aulos-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

aulos-0.1.0/src/aulos/TET12/__init__.py

@@ -0,0 +1,88 @@
+"""
+12-TET (12 equal temperament)
+---
+
+This module provides classes and functions for working with notes, pitch classes,
+and scales in the 12-tone equal temperament system.
+It includes definitions for various musical scales and modes.
+"""
+
+from .note import Key, Note, PitchClass
+
+# Scales
+# Modes
+from .scale import (
+    Aeorian,
+    Aeorian_f5,
+    AlteredSuperLocrian,
+    Bluenote,
+    CombDiminish,
+    Diminish,
+    Dorian,
+    Dorian_f2,
+    Dorian_s4,
+    HarmonicMinor,
+    Ionian,
+    Ionian_s5,
+    Locrian,
+    Locrian_n6,
+    Lydian,
+    Lydian_f7,
+    Lydian_s2,
+    Lydian_s5,
+    Major,
+    MelodicMinor,
+    Minor,
+    MinorPentatonic,
+    Mixolydian,
+    Mixolydian_f6,
+    Mixolydian_f9,
+    Pentatonic,
+    Phrygian,
+    SuperLocrian,
+    Wholetone,
+)
+from .tuner import Equal12Tuner, JustIntonationTuner, MeantoneTuner, PythagoreanTuner
+
+__all__ = [
+    # Note classes
+    "Key",
+    "Note",
+    "PitchClass",
+    # Modes
+    "Aeorian",
+    "Aeorian_f5",
+    "AlteredSuperLocrian",
+    "Dorian",
+    "Dorian_f2",
+    "Dorian_s4",
+    "Ionian",
+    "Ionian_s5",
+    "Locrian",
+    "Locrian_n6",
+    "Lydian",
+    "Lydian_f7",
+    "Lydian_s2",
+    "Lydian_s5",
+    "Mixolydian",
+    "Mixolydian_f6",
+    "Mixolydian_f9",
+    "Phrygian",
+    "SuperLocrian",
+    # Scales
+    "Bluenote",
+    "CombDiminish",
+    "Diminish",
+    "HarmonicMinor",
+    "Major",
+    "MelodicMinor",
+    "Minor",
+    "MinorPentatonic",
+    "Pentatonic",
+    "Wholetone",
+    # tuners
+    "JustIntonationTuner",
+    "MeantoneTuner",
+    "PythagoreanTuner",
+    "Equal12Tuner",
+]

aulos-0.1.0/src/aulos/TET12/note.py

@@ -0,0 +1,41 @@
+from ..note import BaseKey, BaseNote, BasePitchClass
+
+
+class PitchClass(
+    BasePitchClass,
+    intervals=(2, 2, 1, 2, 2, 2, 1),
+    symbols_pitchclass=("C", "D", "E", "F", "G", "A", "B"),
+    symbols_accidental=("bbb", "bb", "b", "#", "##", "###"),
+):
+    """ """
+
+
+class Note(
+    BaseNote[PitchClass],
+    symbols_notenumber=range(128),
+    symbols_octave=(
+        "<N>-1",
+        "<N>0",
+        "<N>1",
+        "<N>2",
+        "<N>3",
+        "<N>4",
+        "<N>5",
+        "<N>6",
+        "<N>7",
+        "<N>8",
+        "<N>9",
+    ),
+    reference_notenumber=60,
+    reference_octave=5,
+    pitchclass=PitchClass,
+):
+    """ """
+
+
+class Key(
+    BaseKey[PitchClass],
+    accidental=1,
+    pitchclass=PitchClass,
+):
+    """ """