Merge pull request #4 from maycuatroi/add-gui

Add GUI with PyQt6 for download

Author: maycuatroi

.github/workflows/main.yml

@@ -70,6 +70,8 @@ jobs:
         run: make install
       - name: Run tests
         run: make test
+      - name: Run tests GUI
+        run: make testgui
 
   tests_win:
     needs: linter
@@ -85,8 +87,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Pip
-        run: pip install --user --upgrade pip
+        run: python.exe -m pip install --upgrade pip
       - name: Install project
         run: pip install -e .[test]
       - name: run tests
         run: pytest -s -vvvv -l --tb=long tests
+      - name: Run tests GUI
+        run: make testgui

Makefile

@@ -22,7 +22,7 @@ show:             ## Show the current environment.
 install:          ## Install the project in dev mode.
 	@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
 	@echo "Don't forget to run 'make virtualenv' if you got errors."
-	$(ENV_PREFIX)pip install -e .[test]
+	$(ENV_PREFIX)pip install -e .[test,full]
 
 .PHONY: fmt
 fmt:              ## Format code using black & isort.
@@ -37,8 +37,14 @@ lint:             ## Run pep8, black, mypy linters.
 	$(ENV_PREFIX)mypy --ignore-missing-imports evo_downloader/
 
 .PHONY: test
-test: lint        ## Run tests and generate coverage report.
-	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=evo_downloader -l --tb=short --maxfail=1 tests/
+test:
+	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=evo_downloader -l --tb=short --maxfail=1 tests/test_libs/
+	$(ENV_PREFIX)coverage xml
+	$(ENV_PREFIX)coverage html
+
+.PHONY: testgui
+testgui:
+	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=evo_downloader -l --tb=short --maxfail=1 tests/test_gui/
 	$(ENV_PREFIX)coverage xml
 	$(ENV_PREFIX)coverage html
 

README.md

@@ -7,10 +7,18 @@ This module contains the main functionality for downloading files, including sup
 
 ## Install it from PyPI
 
+### Lean Version
+
 ```bash
 pip install evo-downloader
 ```
 
+### Full Version with PyQt6
+
+```bash
+pip install evo-downloader[full]
+```
+
 ## Usage
 
 ### As a Library
@@ -61,6 +69,28 @@ $ evo_downloader download https://github.com/maycuatroi/evo_downloader/archive/r
 
 This example demonstrates how to use the `Downloader` class to download files programmatically.
 
+### GUI Usage
+
+You can also use `edownload` to launch the GUI.
+
+```bash
+$ edownload gui
+```
+
+The GUI allows you to input multiple download links and select the output folder. It also displays the download progress.
+
+### Testing
+
+To run tests, you need to install the testing dependencies, including `pyqt6`.
 
+```bash
+pip install -r requirements-test.txt
+```
+
+Then, you can run the tests using `pytest`.
+
+```bash
+pytest
+```
 
 _Evo Downloader developed with ❤️ by maycuatroi_

evo_downloader/cli.py

@@ -1,5 +1,6 @@
 import click
 from evo_downloader.downloader import Downloader
+from evo_downloader.gui import DownloaderGUI
 
 
 @click.group()
@@ -35,7 +36,22 @@ def download(file_urls, folder, num_threads):
         click.echo(f"An error occurred during download: {e}")
 
 
+@click.command()
+def gui():
+    """
+    Launch the GUI for evo_downloader.
+    """
+    import sys
+    from PyQt6.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    gui = DownloaderGUI()
+    gui.show()
+    sys.exit(app.exec())
+
+
 cli.add_command(download)
+cli.add_command(gui)
 
 if __name__ == "__main__":
     cli()

evo_downloader/gui.py

@@ -0,0 +1,107 @@
+from PyQt5.QtWidgets import (
+    QApplication,
+    QWidget,
+    QVBoxLayout,
+    QHBoxLayout,
+    QLabel,
+    QLineEdit,
+    QPushButton,
+    QFileDialog,
+    QProgressBar,
+    QTextEdit,
+)
+from PyQt5.QtCore import QThread, pyqtSignal
+import sys
+import os
+from evo_downloader.downloader import Downloader
+
+
+class DownloadThread(QThread):
+    progress_signal = pyqtSignal(int)
+    finished_signal = pyqtSignal()
+
+    def __init__(self, urls, folder):
+        super().__init__()
+        self.urls = urls
+        self.folder = folder
+
+    def run(self):
+        downloader = Downloader()
+        total_files = len(self.urls)
+        for i, url in enumerate(self.urls):
+            downloader.download_files([url], self.folder)
+            self.progress_signal.emit(int((i + 1) / total_files * 100))
+        self.finished_signal.emit()
+
+
+class DownloaderGUI(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.init_ui()
+
+    def init_ui(self):
+        self.setWindowTitle("Evo Downloader")
+        self.setGeometry(100, 100, 600, 400)
+
+        layout = QVBoxLayout()
+
+        # URL input
+        url_layout = QHBoxLayout()
+        self.url_label = QLabel("URLs:")
+        self.url_input = QTextEdit()
+        url_layout.addWidget(self.url_label)
+        url_layout.addWidget(self.url_input)
+        layout.addLayout(url_layout)
+
+        # Output folder selection
+        folder_layout = QHBoxLayout()
+        self.folder_label = QLabel("Output Folder:")
+        self.folder_input = QLineEdit()
+        default_download_folder = os.path.expanduser("~/Downloads")
+        self.folder_input.setText(os.path.abspath(default_download_folder))
+        self.folder_button = QPushButton("Browse")
+        self.folder_button.clicked.connect(self.select_folder)
+        folder_layout.addWidget(self.folder_label)
+        folder_layout.addWidget(self.folder_input)
+        folder_layout.addWidget(self.folder_button)
+        layout.addLayout(folder_layout)
+
+        # Download button
+        self.download_button = QPushButton("Download")
+        self.download_button.clicked.connect(self.start_download)
+        layout.addWidget(self.download_button)
+
+        # Progress bar
+        self.progress_bar = QProgressBar()
+        layout.addWidget(self.progress_bar)
+
+        self.setLayout(layout)
+
+    def select_folder(self):
+        folder = QFileDialog.getExistingDirectory(self, "Select Output Folder", os.path.expanduser("~/Downloads"))
+        if folder:
+            self.folder_input.setText(folder)
+
+    def start_download(self):
+        urls = self.url_input.toPlainText().strip().split("\n")
+        folder = self.folder_input.text().strip()
+        if not urls or not folder:
+            return
+
+        self.download_thread = DownloadThread(urls, folder)
+        self.download_thread.progress_signal.connect(self.update_progress)
+        self.download_thread.finished_signal.connect(self.download_finished)
+        self.download_thread.start()
+
+    def update_progress(self, value):
+        self.progress_bar.setValue(value)
+
+    def download_finished(self):
+        self.progress_bar.setValue(100)
+
+
+if __name__ == "__main__":
+    app = QApplication(sys.argv)
+    gui = DownloaderGUI()
+    gui.show()
+    sys.exit(app.exec())

requirements-test.txt

@@ -9,3 +9,5 @@ codecov
 mypy
 gitchangelog
 mkdocs
+pyqt5
+pytest-qt

requirements.txt

@@ -2,4 +2,4 @@ requests
 rich
 click
 humanize
-types-requests
+types-requests

setup.py

@@ -37,5 +37,5 @@ def read_requirements(path):
     packages=find_packages(exclude=["tests", ".github"]),
     install_requires=read_requirements("requirements.txt"),
     entry_points={"console_scripts": ["edownload = evo_downloader.__main__:main"]},
-    extras_require={"test": read_requirements("requirements-test.txt")},
+    extras_require={"test": read_requirements("requirements-test.txt"), "full": ["pyqt5"]},
 )

tests/pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+qt_api=pyqt5

tests/test_gui/__init__.py

@@ -0,0 +1,20 @@
+import unittest
+
+from PyQt5.QtCore import Qt
+from evo_downloader.gui import DownloaderGUI
+
+
+def test_start_download(qtbot):
+    gui = DownloaderGUI()
+    qtbot.addWidget(gui)
+    gui.url_input.setPlainText(
+        "http://images.cocodataset.org/annotations/image_info_test2014.zip\nhttps://github.com/maycuatroi/evo_downloader/archive/refs/heads/main.zip"
+    )
+
+    gui.folder_input.setText("./test/download_folder")
+    qtbot.mouseClick(gui.download_button, Qt.MouseButton.LeftButton)
+    gui.download_thread.wait()
+
+
+if __name__ == "__main__":
+    unittest.main()