Metadata-Version: 2.1
Name: pychord
Version: 0.5.1
Summary: A library to handle musical chords in python.
Home-page: https://github.com/yuma-m/pychord
Author: Yuma Mihira
Author-email: info@yurax2.com
License: MIT
Description: ![PyChord](./pychord.png)
        
        # PyChord [![Build Status](https://travis-ci.org/yuma-m/pychord.svg?branch=master)](https://travis-ci.org/yuma-m/pychord) [![Documentation Status](https://readthedocs.org/projects/pychord/badge/?version=latest)](http://pychord.readthedocs.io/en/latest/?badge=latest)
        
        ## Overview
        
        Pychord is a python library to handle musical chords.
        
        ## Installation
        
        ```sh
        $ pip install pychord
        ```
        
        ## Basic Usage
        
        ### Create a Chord
        
        ```python
        >>> from pychord import Chord
        >>> c = Chord("Am7")
        >>> c
        <Chord: Am7>
        >>> c.info()
        """
        Am7
        root=A
        quality=m7
        appended=[]
        on=None
        """
        ```
        
        ### Transpose a Chord
        
        ```python
        >>> c = Chord("Am7/G")
        >>> c.transpose(3)
        >>> c
        <Chord: Cm7/Bb>
        ```
        
        ### Get component notes
        
        ```python
        >>> c = Chord("Am7")
        >>> c.components()
        ['A', 'C', 'E', 'G']
        >>> c.components_with_pitch(root_pitch=3)
        ['A3', 'C4', 'E4', 'G4']
        ```
        
        ### Compare Chords
        
        ```python
        >>> Chord("C") == Chord("D")
        False
        >>> Chord("C#") == Chord("Db")
        True
        >>> c = Chord("C")
        >>> c.transpose(2)
        >>> c == Chord("D")
        True
        ```
        
        ### Find Chords
        
        ```python
        >>> from pychord import note_to_chord
        >>> note_to_chord(["C", "E", "G"])
        [<Chord: C>]
        >>> note_to_chord(["F#", "A", "C", "D"])
        [<Chord: D7/F#>]
        >>> note_to_chord(["F", "G", "C"])
        [<Chord: Fsus2>, <Chord: Csus4/F>]
        ```
        
        ### Create and handle chord progressions
        
        ```python
        >>> from pychord import ChordProgression
        >>> cp = ChordProgression(["C", "G/B", "Am"])
        >>> cp
        <ChordProgression: C | G/B | Am>
        
        >>> cp.append("Em/G")
        >>> cp
        <ChordProgression: C | G/B | Am | Em/G>
        
        >>> cp.transpose(+3)
        >>> cp
        <ChordProgression: Eb | Bb/D | Cm | Gm/Bb>
        
        >>> cp[1]
        <Chord: Bb/D>
        ```
        
        ## Advanced Usage
        
        ### Create a Chord from note index in a scale
        
        ```python
        >>> Chord.from_note_index(note=1, quality="", scale="Cmaj")
        <Chord: C>  # I of C major
        >>> Chord.from_note_index(note=3, quality="m7", scale="Fmaj")
        <Chord: Am7>  # IIIm7 of F major
        >>> Chord.from_note_index(note=5, quality="7", scale="Amin")
        <Chord: E7>  # V7 of A minor
        ```
        
        ## Supported Python Versions
        
        - 2.7
        - 3.5 and above
        
        ## Links
        
        - PyPI: https://pypi.python.org/pypi/pychord
        - GitHub: https://github.com/yuma-m/pychord
        - Documentation: http://pychord.readthedocs.io/en/latest/
        
        ## Author
        
        - [Yuma Mihira](https://yuma.cloud/)
        
        ## License
        
        - MIT License
        
        Icon is made by [Freepik](https://www.flaticon.com/authors/freepik")
        
Keywords: music chord
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
