Giter Club home page Giter Club logo

askminstrel's Introduction

AskMinstrel

A simple web client application to retrieve music related information. A plain HTML implementation, called Vanilla is provided. A vue.js application is considered but not fully developed. A local web server provides end points and data marshalling for clients.

SWENG861 Project, AskMinstrel
André Wagner
July, 2020

Attributions

The project directly makes use of the following packages:

  • CherryPy A Python HTTP framework and server.
  • Tekore A Python client for the Spotify API.
  • Requests A library for HTTP/1.1 requests.
  • Slugify Generate URI compatible strings.

Content provided by Spotify

Class Diagram

Class Diagram

Setup

Since a setup.py is not provided, the following manual setup is required.

  1. install python 3.6
  2. unzip askminstrel.zip contents to a new directory
  3. pip install cherrypy
  4. pip install tekore
  5. pip install requests
  6. pip install python-slugify

Credentials

AskMinstrel requires a credentials.json file in the current working directory. See Spotify for information on how to obtain a client id and secret. The file contents should look like:

{
    "client_id": "...",
    "client_secret": "..."
}

Execution

AskMinstrel is a Python module that can be executed with

python -m askminstrel

For available command line parameters

python -m askminstrel -h

By default, the AskMinstrel server will use port 50861. So direct a web browser to http://localhost:50861/vanilla and ask minstrel!

askminstrel's People

Contributors

overboard avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.