Metadata-Version: 2.4
Name: automuse
Version: 2.0.0
Summary: A computerisation of western music theory.
Author-email: Yiding Li <commit@lyodine.com>
Project-URL: Documentation, https://yidingli.com/docs/evokit/
Project-URL: Repository, https://yidingli.com/projects/evokit/
Keywords: Music Theory
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Artistic Software
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
Classifier: Typing :: Typed
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.12.0
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: mido>=1.3.3
Requires-Dist: matplotlib>=3.10.1
Dynamic: license-file

 AutoMuse

A computerisation of Western music theory.

Please see [this Notebook file](introduction.ipynb) for a brief tutorial. See the table below for more tutorials.

## Components

This library has the following modules:

| Module         | Components                                                   | Turorial                                                  |
| -------------- | ------------------------------------------------------------ | --------------------------------------------------------- |
| automuse         | Definition of the music space; functions that operate on single notes; | [Link](./docs/source/guides/examples/introduction.ipynb)  |
| automuse.modes   | Patterns of interval. Examples are `MAJOR`, `HARMONIC_MINOR` and `IONIAN`. | –                                                  |
| automuse.scale   | Functions that construct scales.                             | –                                                  |
| automuse.chord   | Functions that construct chords                              | –                                                  |
| automuse.guitar  | Functions that map notes to a visual fret board.             | [Link](./docs/source/guides/examples/guessguitarer.ipynb) |
| automuse.transforms    | Mathematical transforms | [Link](./docs/source/guides/examples/transforms.ipynb)          |
| automuse.midi    | Functions that play notes. Compatible with `.scale` and `.chord`. Can also accept manually specified notes. | [Link](./docs/source/guides/examples/midi.ipynb)          |
| automuse.guesser | Function to guess a scale or a chord based on a set off notes. | [Link](./docs/source/guides/examples/guesser.ipynb)       |

## Installation

Install from PyPI:

```bash
pip install automuse
```

Install from source:

```bash
# move to the root directory
pip install .
```

