README.md

COMPSCI 235 Assignment 2 Music Application

Installation

Installation via requirements.txt

To set up the virtual environment and install any dependencies, run the following commands:

py -3 -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

When using PyCharm, set the virtual environment using 'File'->'Settings' and select your project from the left menu. Select 'Project Interpreter', click on the gearwheel button and select 'Add'. Click the 'Existing environment' radio button to select the virtual environment

Execution

Running the application

From the project directory, and within the activated virtual environment (see venv\Scripts\activate above):

flask run

Testing

After you have configured pytest as the testing tool for PyCharm (File - Settings - Tools - Python Integrated Tools - Testing), you can then run tests from within PyCharm by right clicking the tests folder and selecting "Run pytest in tests".

Alternatively, from a terminal in the root folder of the project, you can also call 'python -m pytest tests' to run all the tests. PyCharm also provides a built-in terminal, which uses the configured virtual environment

Data sources

The data files are modified excerpts downloaded from: https://www.loc.gov/item/2018655052 or https://github.com/mdeff/fma

We would like to acknowledge the authors of these papers for introducing the Free Music Archive (FMA), an open and easily accessible dataset of music collections:

Defferrard, M., Benzi, K., Vandergheynst, P., & Bresson, X. (2017). FMA: A Dataset for Music Analysis. In 18th International Society for Music Information Retrieval Conference (ISMIR).

Defferrard, M., Mohanty, S., Carroll, S., & Salathe, M. (2018). Learning to Recognize Musical Genre from Audio. In The 2018 Web Conference Companion. ACM Press.