https://github.com/joncardasis/ultimate-api

:guitar: Python API which scrapes ultimate-guitar.com for guitar chords
https://github.com/joncardasis/ultimate-api

api flask guitar guitar-chords music python

Last synced: about 15 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/joncardasis/ultimate-api
• Owner: joncardasis
• Created: 2017-08-03T18:27:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T07:53:44.000Z (almost 2 years ago)
• Last Synced: 2023-08-03T17:02:20.853Z (over 1 year ago)
• Topics: api, flask, guitar, guitar-chords, music, python
• Language: Python
• Size: 796 KB
• Stars: 68
• Watchers: 6
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ultimate-API

:guitar: *An API for ultimate-guitar.com*

![Python-Version](https://img.shields.io/badge/Python-3.6.1-blue.svg)

## Setup

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

1. Create a virtual environment of python3:

    ```Python

    # Install virtualenv:

    # pip install virtualenv

    virtualenv -p /usr/local/bin/python3 venv

    source venv/bin/activate

    ```

1. Install dependancies:

    ```Python

    pip install -r requirements.txt

    ```

1. Usage:

    ```Python

    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

python test.py

```