Light

mezidia / song-helper Goto Github PK

View Code? Open in Web Editor NEW

7.0 1.0 0.0 5.33 MB

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

Home Page: https://song-helper.vercel.app

License: MIT License

Python 86.84% CSS 0.54% HTML 5.13% JavaScript 7.49%

songs python ai machine-learning mezidia song-helper mood django aiogram numpy

song-helper's Introduction

Song Helper

🌟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

Build status 🔨

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

`github.com/mezgoodle`	`github.com/Dmytrenko-Roman`	`github.com/fhrr-sht`	`github.com/VsIG-official`

License 🔖

MIT © Mezidia

song-helper's People

Contributors

Stargazers

Watchers

song-helper's Issues

Create start template on Django

Tasks

Create start page
Create database and tests for this
Create super-users
Fix lint problems
Show data in admin panel
Create form on start page
Find out how to take songs from YouTube Music, YouTube, Spotify and ext., maybe there are some API
Fix old Django version in all files

some tasks will add later

Literature

My wiki tutorial
Video on YouTube
Video on YouTube

Branch

Folder

Parser

Tasks

Create function
Create tests

some tasks will add later

Literature

Python library

Branch

Folder

Improve Django

Tasks

Write form sending logic
Show result after form sending
Create page about adding song to database
Show result as song video on index page
Improve design

some tasks will add later

Literature

From last issue

Branch

Folder

Understand how to work with AI on Python

Tasks

Understand how to start our work
Create some small script with data and results (@mezgoodle )
Add ML With SKlearn (@VsIG-official )
Create tests

some tasks will add later

Literature

Branch

Folder

Endpoints

@MaksGovor, please write, which endpoints you need from the server. We can make a call

Future tasks

Tasks

Fix libraries compability (taken @mezgoodle)
Host our datasets (taken @mezgoodle)
Create Audio Visualiser for dJango (as code or gif) (taken @fhrr-sht and @VsIG-official)
Connect songhelper folder (taken @VsIG-official)
Make Icon for Project (taken @fhrr-sht)
Make docker image for Discord Bot (taken @VsIG-official)
Make docker image for Mobile App (taken @Dmytrenko-Roman)
Deploy (non-taken)
Update workflows, such as exclude new packages (taken @mezgoodle)

some tasks will add later

Literature

Branch

Folder

Start develop the mobile app

Tasks

some tasks will add later

Literature

Article from RealPython
Kivy documentation
KivyMD repository and Article on Habr
Kivy tutorials playlists: in English, in Russian
Article about compiling into Android platform

Branch

Folder

Documentation

Tasks

Create better README.md (18.02)
Create CONTRIBUTING.md and CODE_OF_CONDUCT.md (21.02)

some tasks will add later

Literature

Branch

Folder

Improve Bot

Tasks

Create handler to add new song

some tasks will add later

Literature

From the last issue

Branch

Folder

Discord Bot

Tasks

Create some basic functionality for Discord Bot
Make bot alive FOREVER

Make Pause function
Make Resume function

Possible tasks to do:

Make Queue function
Delete downloaded music, after some time or when track has ended
Add "async with ctx.typing():" to all functions
Make Replay\Loop function
Make Skip function
Connect bot via [play] command

Bugs:

When Bot goes to the [play_next] function with one song in queue and You add new song, then this song won't play
Fix strange error "TypeError: object NoneType can't be used in 'await' expression", while invoking [resume] or [pause] functions

Add music searching, like pancake bot

some tasks will add later

Literature

Branch

Folder

Improve Django tests

Tasks

Add tests for form
Add tests for views

some tasks will add later

Literature

Real Python course

Branch

Folder

Clean up the repository

Tasks

Update content on README.md
Delete some folders, such as .vs or .vscode

some tasks will add later

Literature

Branch

Folder

CI

Tasks

Add linters
Add CI for tests
Add auto-formatter

some tasks will add later

Branch

Folder

.github/workflows

Create start structure of Telegram bot

Tasks

Create start commands
Create tests
Find out how to send audio files in Telegram and how to take them from Internet sites
Create connection with server by requests

some tasks will add later

Literature

My bots: keepTelegram and VTL-Schedule-Bot
Video on YouTube (pyTelegramBotApi)
Video on YouTube (aiogram)
Video on YouTube (pyTelegramBotApi)

Branch

Folder

Recommend Projects

React

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

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

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.