Metadata-Version: 2.1
Name: pytransposer
Version: 1.0.0
Summary: A python package for transposing chords from one key to another and changing between DO-RE-MI and A-B-C notations.
Project-URL: Homepage, https://github.com/bfrangi/pytransposer
Project-URL: Bug Tracker, https://github.com/bfrangi/pytransposer/issues
Author-email: bfrangi <bernat.frangi@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

PyTransposer 
==========

[![Build Status](https://github.com/bfrangi/pytransposer/workflows/CI/badge.svg)](https://github.com/bfrangi/pytransposer/actions?query=workflow%3ACI)

Transposing chords from one key to another and changing between DO-RE-MI and A-B-C notations.


## Usage

To transpose single chords, use `pytransposer` like this:

    >>> import pytransposer.transposer as tr
    >>> tr.transpose_chord('C', 3, 'Bb')
    'Eb'
    >>> tr.transpose_chord('DO', 3, 'Bb')
    'Eb'
    >>> tr.transpose_chord('DO', 3, 'Bb', chord_style_out='doremi')
    'MIb'

To translate chords between notations, use `pytransposer` like this:

    >>> from pytransposer.common import chord_abc_to_doremi
    >>> chord_abc_to_doremi('Ab')
    'LAb'
    >>> from pytransposer.common import chord_doremi_to_abc
    >>> chord_doremi_to_abc('DO#')
    'C#'


## Testing

Run unit tests using Python's `doctest`, first clone the repo:

    git clone https://github.com/bfrangi/transposer.git

Then, open a terminal at the root directory of the repo and run:

    python3 -m src.pytransposer.transposer -v  

This will run the tests for the main `transposer` sub-module. For the rest of the submodules, use:

    python3 -m src.pytransposer.common -v  
    python3 -m src.pytransposer.abc -v  
    python3 -m src.pytransposer.doremi -v  

## More info

View on the Python Package Index (PyPI) [here](https://pypi.org/project/pytransposer/).

View on GitHub [here](https://github.com/bfrangi/pytransposer/).
