Metadata-Version: 2.1
Name: PyGuitar
Version: 0.3.7
Summary: PyGuitar generates an easy-to-practice chord book.
Home-page: UNKNOWN
Author: Shuto Iwasaki
Author-email: cabernet.rock@gmail.com
License: MIT
Project-URL: Source Code, https://github.com/iwasakishuto/PyGuitar
Description: # PyGuitar: Chord book generator
        
        ![PyGuitar](https://github.com/iwasakishuto/PyGuitar/blob/master/image/pyguitar.png?raw=true)
        
        [![PyPI version](https://badge.fury.io/py/PyGuitar.svg)](https://pypi.org/project/PyGuitar/)
        [![GitHub version](https://badge.fury.io/gh/iwasakishuto%2FPyGuitar.svg)](https://github.com/iwasakishuto/PyGuitar)
        [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/iwasakishuto/PyGuitar/blob/gh-pages/LICENSE)
        
        **PyGuitar** generates an **easy-to-practice** chord book.
        
        ## Installation
        
        There are two ways to install PyGuitar:
        
        - **Install PyGuitar from PyPI (recommended):**
            ```
            $ sudo pip install PyGuitar
            ```
        - **Alternatively: install PyGuitar from the GitHub source:**
            ```
            $ git clone https://github.com/iwasakishuto/PyGuitar.git
            $ cd PyGuitar
            $ sudo python setup.py install
            ```
        
        ## How to use
        
        - **Create Guitar Instance**
            ```python
            from guitar import Guitar
            guitar = Guitar(key="C", scale="major")
            ```
        - **plot guitar layout**
            ```python
            guitar.plot_chord_layout()
            ```
            <details>
                <summary>Output</summary>
                <img src="https://github.com/iwasakishuto/PyGuitar/blob/master/image/chord-layout.png?raw=true" alt="chord layout">
            </details>
        - **plot guitar strings**
            ```python
            guitar.plot_strings()
            ```
            <details>
                <summary>Output</summary>
                <img src="https://github.com/iwasakishuto/PyGuitar/blob/master/image/guitar-strings.png?raw=true" alt="guitar strings">
            </details>
        - **plot chord**
            ```python
            guitar.plot_chord(chode="G#", string=6, mode="minor")
            ```
            <details>
                <summary>Output</summary>
                <img src="https://github.com/iwasakishuto/PyGuitar/blob/master/image/chord-sample.png?raw=true" alt="chord-G#.png">
            </details>
        - **export chordbook**
            ```python
            guitar = Guitar(key="B", scale="major", dark_mode=False)
            guitar.set_chord(chode="D#", string=5, mode="minor")
            guitar.set_chord(chode="G#", string=6, mode="minor")
            guitar.set_chord(chode="E",  string=6, mode="major")
            guitar.set_chord(chode="B",  string=5, mode="major")
            guitar.set_chord(chode="F#", string=6, mode="minor")
            guitar.set_chord(chode="C#", string=5, mode="major")
            guitar.set_chord(chode="F#", string=6, mode="sus4")
            guitar.set_chord(chode="C#", string=5, mode="7th")
            guitar.set_chord(chode="D#", string=5, mode="7th")
            guitar.export_chord_book(fmt="pdf")
            ```
            <details>
                <summary>Output</summary>
                <img src="https://github.com/iwasakishuto/PyGuitar/blob/master/examples/Whole-notes.png?raw=true" alt="Whole-notes.png">
            </details>
        - **scraping -> chordbook**
            ```python
            title, key, data = get_ufret_chords_with_driver(url)
            guitar = Guitar()
            guitar.create_chord_book(data)
            ```
            <details>
                <summary>Output</summary>
                <img src="https://github.com/iwasakishuto/PyGuitar/blob/master/image/chordbook-sample.png?raw=true" alt="chordbook.png">
            </details>
        - **scraping -> chordbook (docker oneline)**
            ```sh
            pwd
            path/to/PyGuitar/docker
            make ufret URL="https://www.ufret.jp/song.php?data=5012"
            :
            Save data at /data/'欲望に満ちた青年団 | ONE OK ROCK'-key_B-major_scale.pdf
            ```
        
        ### Reference
        
        - [Learn Guitar with Python](https://medium.com/better-programming/how-to-learn-guitar-with-python-978a1896a47)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: tests
