pyamapping

A Python package containing audio related functions and mappings

Making Changes & Contributing

To setup your development environment, you need to have uv installed. First, clone the repository and then change into the root directory:

cd pyamapping

Afterwards, sync your environment:

uv sync

This will install all required dependencies (dev dependencies included). Also, please install the pre-commit hooks:

uv run pre-commit install

Experimentation in Scratchpad / Jupyter

uv automatically installs the pyamapping package to the .venv in editable mode. During development, any changes to the pyamapping source will be reflected automatically. To write playground / exploratory code, just make sure to run your REPL environment with uv run, e.g.:

uv run python

or

uv run jupyter notebook

Then, you should be able to:

import pyamapping as pam

And get the current state of the source code.

Running Tests

Tests can be run via:

uv run tox -e tests

Building Documentation

Documentation can be built via:

uv run tox -e docs