/song-helper

🎶Python script with artificial intelligence, that proposes you song, depending on your mood🎹

Primary LanguagePythonMIT LicenseMIT

Song Helper logo
GitHub last commit language language GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub Repo stars Latest Github release Theme

🌟Hello everyone! This is Our repository about project on Python "Song-Helper"🌟

Overview

This project isn't deployed, and some parts of code could don't work...but main idea is realised. Here you can see work server on Django, bot on Aiogram, AI on Keras and Tensorflow, mobile app on React Native.

Specification

Context


This project is developing by 4 members of Mezidia:

  • Zavalniuk Maxim and Dominskyi Valentyn - AI
  • Sichkar Tetiana - Website
  • Dmytrenko Roman - Telegram Bot

It is planned to deploy the project in the form of a server on the Django web framework

Tasks


This project will give You some music depending on Your mood, which will be represented by You as a words.

AI won't create any sort of music depending on Your mood

Functional requirements


The only functional requirement is to give a song. In additional anyone can add new songs in the database of AI model.

Scenarios


  • We get a description of the mood in different ways: through a bot (Telegram, Discord) in the form of a text message, through a form on the site (Django) , through a form on the mobile app (React Native). Next, the text is converted to a vector, compared with the mood vectors, getting a random song with this mood from databae and the result is returned as a song reference (in each cases).
  • The site will have one more page with a form for entering a song id from Spotify. This is for making database bigger. Also you can do it from bots in Telegram and Discord.

Use case diagram


Use case diagram

Build status 🔨

Bot CI Docker Docker Image CI song-helper CI Django CI Mobile App CI

Tech/framework used 🔧

Built with

Installation 💻

To install our project and use it, enter the following command: docker-compose up.

Tests 🔬

We use unittest as framework for testing. All results you can see here. For tests look in folders of each part of this project.

Contribute 🏃

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Also look at the CONTRIBUTING.md.

Credits 🐱🤝

Mezgoodle⭐️ Dmytrenko-Roman Fhrr-sht VsIG
Mezgoodle Dmytrenko-Roman Fhrr-Sht VsIG
github.com/mezgoodle github.com/Dmytrenko-Roman github.com/fhrr-sht github.com/VsIG-official

License 🔖

MIT © Mezidia