deemix-py/README.md

2.8 KiB

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?

Currently there are no available builds as it's still in development.
But you can try to run it yourself!

Running instructions

Standard way

NOTE: Python 3 is required for this app. Make sure you tick the option to add Python to PATH when installing.
NOTE: If python3 is "not a recognized command" try using python instead.

  1. After installing Python open a terminal/command prompt and install the dependencies using python3 -m pip install -r requirements.txt --user
  2. Run python3 -m deemix --help to see how to use the app in CLI mode.
  3. Run python3 server.py to start the server and then connect to 127.0.0.1:9666. The GUI should show up.
  4. Enjoy!

Easy Windows way

  1. Download install.bat file to your PC and place it in the folder where you want Deemix to live
  2. Start the install.bat as administrator
  3. Wait for it to finish, then run the start.bat

Easy Mac way

  1. Download install_mac.sh file to your Mac and place it in the folder where you want Deemix to live
  2. Open a terminal and type sh and a space, then drag install_mac.sh into your terminal window and press enter
  3. The web-gui will launch when the installer is finished, and launching it in the future can be done with the generated file startdeemix.command
  4. To update to the latest build, run the generated file updatedeemix.command

What's left to do?

Library:

  • Write the API Documentation

in the WebUI:

  • Install sass dependency
  • Make the UI look coherent
  • Search tab
    • Better style for placeholer before search
    • Better loading feadback fot the user (maybe with a loading circle)
  • Link Analyzer
    • Better style for placeholer before analyzing
  • Settings tab
    • Stylize and separate the options
    • Maybe tabbing the section for easy navigation
  • About tab
    • Write stuff about the app
  • ?

Application:

  • Add an auto updater
  • Add installer for windows
  • AppImage builds

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/.