music-kraken/music-kraken-core
3
2
Fork 0
Code Issues 10 Pull Requests 1 Packages Projects 2 Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Hellow2 2023-02-27 14:29:09 +01:00
parent 6f830adb85
commit 8926704b58
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -78,9 +78,16 @@ I decided against creating a discord server, due to piracy communities get often
# Programming Interface / Use as Library # Programming Interface / Use as Library
This application is $100\%$ centered around Data. Thus the most important thing for working with musik kraken is, to understand how I structured the data. This application is $100\%$ centered around Data. Thus the most important thing for working with musik kraken is, to understand how I structured the data.
Without long expllanations I will just show you, how to import the data classes and create them.
## qick Overview
- explanation of the [Data Model](#data-model)
- how to use the [Data Objects](#data-objects)
```mermaid ```mermaid
---
title: Quick Overview
---
sequenceDiagram sequenceDiagram
participant pg as Page (eg. YouTube, MB, Musify, ...) participant pg as Page (eg. YouTube, MB, Musify, ...)
@ -95,7 +102,7 @@ obj -> pg: add more detailed data from according page.
obj -> pg: if available download audio to target. obj -> pg: if available download audio to target.
``` ```
## Data Structure ## Data Model
The Data Structure, that the whole programm is built on looks as follows: The Data Structure, that the whole programm is built on looks as follows:
@ -135,10 +142,6 @@ Source {
} }
Song ||--o{ Lyrics : contains Song ||--o{ Lyrics : contains
Song ||--o{ Target : points Song ||--o{ Target : points
@ -209,7 +212,9 @@ Looks way more managebal, doesn't it?
The reason every relation here is a `n:m` *(many to many)* relation is not, that it makes sense in the aspekt of modeling reality, but to be able to put data from many Sources in the same Data Model. The reason every relation here is a `n:m` *(many to many)* relation is not, that it makes sense in the aspekt of modeling reality, but to be able to put data from many Sources in the same Data Model.
Every Service models Data a bit different, and projecting a one to many relationship to a many to many relationship without data loss is easy. The other way around it is basically impossible Every Service models Data a bit different, and projecting a one to many relationship to a many to many relationship without data loss is easy. The other way around it is basically impossible
## DataClasses ## Data Objects
> Not 100% accurate yet and *might* change slightly
```python ```python
# importing the libraries I build on # importing the libraries I build on