/ultimate-api

:guitar: Python API which scrapes ultimate-guitar.com for guitar chords

Primary LanguagePython

Ultimate-API

🎸 An API for ultimate-guitar.com

Python-Version

Setup

  1. Install python3 from https://www.python.org/downloads/

  2. Create a virtual environment of python3:

    # Install virtualenv:
# pip install virtualenv
virtualenv -p /usr/local/bin/python3 venv
source venv/bin/activate

  3. Install dependancies:

    pip install -r requirements.txt

  4. Usage:

    export FLASK_DEBUG=1 // Export for debug
python run.py

Endpoints

Method Endpoint Parameters Result
GET /tab url: A full (including protocol) url for an ultimate-guitar.com tab. JSON response containing tab info as well as each tab line

Running Tests

To run the full test suite execute the following from the top level directory.

python test.py