Metadata-Version: 2.1
Name: scales.py
Version: 0.1.2
Summary: A tool to generate stringed instrument visual aids
Home-page: https://github.com/zedchance/scales
Author: Zed Chance
Author-email: zedchance@gmail.com
License: MIT
Description: # scales
        
        A tool to generate stringed instrument visual aids
        
        * [Installation](#installation)
        * [Usage](#usage)
          * [Other helpful uses](#other-helpful-uses)
        * [Dependencies](#dependencies)
        
        ## Installation
        Install using:
        
        ```
        pip install scales.py
        ```
        
        Then import it like so:
        
        ```py
        from scales import Scales
        ```
        
        ## Usage
        Scales objects take at least the `scale` parameter, which should be a list of notes. They can be drawn using the `draw` function, where `start` and `stop` are the range of frets to show (defaults to showing 15 frets if not specified).
        
        For example:
        
        ```py
        a_mixo = ['A', 'B', 'C#', 'D', 'E', 'F#', 'G']
        six_string = Scales(title='A Mixolydian', scale=a_mixo)
        six_string.draw(start=11, stop=15)
        ```
        
        ![a_mix](screenshots/a_mixo.png)
        
        By default, it will assume a 6 string guitar in standard tuning, but you can specify other tunings like:
        
        ```py
        c_major = ['C', 'D', 'E', 'F', 'G', 'A', 'B']
        ukulele = Scales(title='C Major on Ukulele', strings=['G', 'C', 'E', 'A'], scale=c_major)
        ukulele.draw()
        ```
        
        ![c_maj_uke](screenshots/c_maj_uke.png)
        
        Scales can be drawn without making it an object:
        
        ```py
        g_chord = ['G', 'B', 'D']
        Scales(title='Open G', scale=g_chord).draw(stop=3)
        ```
        
        ![open_g](screenshots/open_g.png)
        
        ### Other helpful uses
        
        Scales can be used to generate blank visuals to print out. Heres a blank 6 string fretboard:
        
        ```py
        Scales([]).draw()
        ```
        
        Or a blank open chord chart:
        
        ```py
        Scales([]).draw(stop=3)
        ```
        
        ## Dependencies
        
        Library | Description
        --- | ---
        [matplotlib](https://matplotlib.org) | 2D plotting library
        [numpy](https://numpy.org) |  Fundamental package for scientific computing
Keywords: music guitar matplotlib
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Description-Content-Type: text/markdown
