deemix-py/README.md

# WARNING
The webUI is not finished, some functions may not work.

# deemix
## What is deemix?
deemix is a deezer downloader built from the ashes of Deezloader Remix. The base library (or core) can be used as a stand alone CLI app or implemented in an UI using the API.

## How can I use this this?
Currently there are no available builds as it's still in development.<br>
But you can try to run it yourself!<br>

## Running instructions
NOTE: Python 3 is required for this app.<br>
<br>
After installing python install the dependencies using `pip install -r requirements.txt`<br>
Run `python -m deemix --help` to see how to use the app<br>
Run `python server.py` to start the server and then connect to 127.0.0.1:33333.<br>
Enjoy!<br>

## What's left to do?
Library:
- Add a log system
- Adding whatever is missing for the webUI
- Write the API Documentation

WebUI:
- Home tab
- Charts tab
- Favorites / Playlists tab
- Link Analyzer
- About Section
- Track preview (might not be possible with current search layout)
- Artist, Album and Playlist pages for track selection
- Stylize and separate the options in the Settings tab
- Reset settings to default
- Animations and style polishing
- ?

# License
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.