v4.9.0 - Refactor (#41)
* fix imports
remove unused imports
use full import path
sort import (1. Standard Library, 2. Third-Party, 3. Local) in alphabetic.
* - remove: Method 3 from src.core.ytsage_downlader:cleanup_subtitle_file
- it could delete the subtitle file of other movies if it present in same directory as it scane recursively.
- refactor: migrate from os.path to pathlib.Path for path handling
- Replaced os.path methods with pathlib.Path to improve readability,
- avoid repeatation.
- cross-platform compatibility, and maintain cleaner code.
- improve: enhance code readability
- Standardized string literals to use double quotes for consistency
- Removed unnecessary spaces to maintain cleaner formatting
- Applied code formatting for better readability and maintainability
* - add: ytsage_constants.py file for one place to store all constants.
- imporve: return type hint for function.
- remove: src/gui/ytsage_gui_dialogs.py file to avoid repetation
- src/gui/dialogs is renamed to src/gui/ytsage_gui_dialogs for same naming convection. (future import will remains same)
- use of src/gui/ytsage_gui_dialogs/__init__.py to import the dilogs modules.
- change: variable self.parent to self._parent so it does not overwrite the parent()
- add type hint checking.
* - refactor: QMetaObject.invokeMethod to Signal
- I encounter error with incokeMethod. Could not solve it.
- So, Changed it to Signal to match app code language.
- implement: the ytsage_constants.py to code
- remove: unnecessary logic
- remove: repetitive code logic.
- update: yt-dlp logic for src\gui\ytsage_gui_dialogs\ytsage_dialogs_update:_update_binary
- yt-dlp update logic will use `yt-dlp -U`
* refactor: remove unused imports and streamline code formatting across multiple files
* - **refactor: drop `pygame` in favor of built-in `PySide6` sound**
- Removed `pygame` dependency (too heavy just for notifications).
- Replaced with `QSoundEffect`, which is lightweight and built into `PySide6`.
- Dropped `pygame.mixer` + threading → Qt handles async playback.
- Implemented sound playback with `QUrl.fromLocalFile()` and `.play()`.
- Added `setVolume(0.9)` as a configurable example.
- Converted notification sound from `.mp3` to `.wav` (only format supported).
* **refactor(utils): simplify logger module**
- Moved `logger` to `src.utils`
- Removed unnecessary import checks (logger is always available)
- Replaced `raise` statements with error logging to prevent crashes
- Use `logger.exception()` in `except` blocks to capture traceback (logged as error)
**style: remove redundant str() in f-strings**
- Dropped explicit `str()` calls inside f-strings
- f-strings already call `str()` under the hood
**chore: add type hints for GUI mixins**
- Added type hints for `FormatTableMixin` (`src.gui.ytsage_gui_format_table`)
- Added type hints for `VideoInfoMixin` (`src.gui.ytsage_gui_video_info`)
- Improves autocomplete and type safety in IDEs
* - **introduce the `ytsage_config_manager.py` module to manage app setting.**
- Loads settings from a JSON config file (`APP_CONFIG_FILE`).
- Creates the config file with default values if missing or corrupt.
- Retrieves, sets, and deletes settings using simple dot-separated keys.
- Provides safe error handling with logging instead of raising exceptions.
- Persists updates back to disk automatically.
- **Usage**
```python
from src.utils.ytsage_config_manager import ConfigManager
download_path = ConfigManager.get("download_path")
ConfigManager.set("download_path", "D:/Downloads")
last_check = ConfigManager.get("cached_versions.ytdlp.last_check")
ConfigManager.delete("cached_versions.ffmpeg.path")
```
* **Refactore: pkg_resources with importlib.metadata.version**
- UserWarning: pkg_resources is deprecated as an API.
- See https://setuptools.pypa.io/en/latest/pkg_resources.html.
- The pkg_resources package is slated for removal as early as 2025-11-30.
* **refactore: notification sound**
- `QSoundEffect` is chnaged back to `pyglet` as per mainter `@oop7` choise.
- simplify the logic.
* remove: import check, it should always work.
* **fix: runtime error**
- yt_dlp moved from `--excludes` to `--packages` in `build-windows.yml`
- In frozen build, logger will not log to consol. insted will log to file.
- In frozen build, `app_dir` is next to `.exe` file.
* chang back to checking import for ytdlp
* Bump version to 4.8.1
Update version references from 4.8.0b to 4.8.1 in __init__.py, main app, and About dialog to reflect the new release.
* Update asset paths in build workflows
Changed asset inclusion and screenshot removal paths from 'assets' to 'lib/assets' in Linux, macOS, and Windows build workflows to reflect new directory structure and ensure screenshots are excluded from packaged builds.
* Bump version to 4.8.2
Update version references from 4.8.1 to 4.8.2 in source files and documentation to prepare for a new patch release.
* Fix asset include path in Windows build workflow
Corrects the syntax for including asset files in the build-windows.yml workflow by changing 'assets,lib/assets' to 'assets=lib/assets'. This ensures assets are properly mapped during the build process.
* Update release tag examples in CI/CD README
Changed the example git tag commands from v4.8.0 and v4.8.2 to v4.8.1 for consistency in the CI/CD documentation.
* Fix include-files mapping in Windows build workflow
Changed the cx_Freeze --include-files argument from '=' to ':' for source:destination mapping in build-windows.yml. This resolves an issue where '=' was treated as a literal path, ensuring assets are correctly copied to the destination directory.
* Remove redundant comments in build-windows workflow
Deleted comments explaining the colon usage for source:destination mapping in the cx_Freeze CLI, as the mapping is already clear from the context.
* Refactor Windows build to use cx_Freeze setup script
Replaces direct cx_Freeze CLI calls with dynamically generated setup scripts for both standard and FFmpeg builds. This improves maintainability and flexibility of build configuration in the GitHub Actions workflow.
* Bump version to 4.8.3
Updated version references from 4.8.2 to 4.8.3 in __init__.py, main app, and About dialog to reflect the new release.
* revert(build): move yt_dlp from --packages to --excludes in build-windows.yml
---------
Co-authored-by: Your Name <mohamed.mohamed112@ai.mnu.edu.eg>
This commit is contained in:
Viren Hirpara
@@ -126,14 +126,14 @@ To add new platform packages:
|
||||
|
||||
```bash
|
||||
# For a new release
|
||||
git tag v4.8.0
|
||||
git push origin v4.8.0
|
||||
git tag v4.8.1
|
||||
git push origin v4.8.1
|
||||
|
||||
# For a patch release
|
||||
git tag v4.8.1
|
||||
git push origin v4.8.1
|
||||
|
||||
# To delete a tag (if needed)
|
||||
git tag -d v4.8.0
|
||||
git push origin :refs/tags/v4.8.0
|
||||
git tag -d v4.8.1
|
||||
git push origin :refs/tags/v4.8.1
|
||||
```
|
||||
|
||||
@@ -122,7 +122,7 @@ jobs:
|
||||
],
|
||||
include_files=[
|
||||
("src", "src"),
|
||||
("assets", "assets"),
|
||||
("assets", "lib/assets"),
|
||||
("ytsage.desktop", "share/applications/ytsage.desktop"),
|
||||
("assets/branding/icons/icon.png", "share/pixmaps/ytsage.png"),
|
||||
],
|
||||
@@ -185,8 +185,8 @@ jobs:
|
||||
|
||||
# Remove screenshots to reduce size before packaging
|
||||
build_dir=$(ls -d build/exe.* 2>/dev/null | head -n1 || true)
|
||||
if [ -n "$build_dir" ] && [ -d "$build_dir/assets/branding/screenshots" ]; then
|
||||
rm -rf "$build_dir/assets/branding/screenshots"
|
||||
if [ -n "$build_dir" ] && [ -d "$build_dir/lib/assets/branding/screenshots" ]; then
|
||||
rm -rf "$build_dir/lib/assets/branding/screenshots"
|
||||
echo "Removed screenshots folder from $build_dir"
|
||||
fi
|
||||
|
||||
|
||||
@@ -123,7 +123,7 @@ jobs:
|
||||
],
|
||||
include_files=[
|
||||
("src", "src"),
|
||||
("assets", "assets"),
|
||||
("assets", "lib/assets"),
|
||||
],
|
||||
)
|
||||
|
||||
@@ -171,8 +171,8 @@ jobs:
|
||||
if [ -z "$app_path" ]; then
|
||||
app_path=$(ls -d dist/*.app build/dist/*.app build/*.app 2>/dev/null | head -n1 || true)
|
||||
fi
|
||||
if [ -n "$app_path" ] && [ -d "$app_path/Contents/Resources/assets/branding/screenshots" ]; then
|
||||
rm -rf "$app_path/Contents/Resources/assets/branding/screenshots"
|
||||
if [ -n "$app_path" ] && [ -d "$app_path/Contents/Resources/lib/assets/branding/screenshots" ]; then
|
||||
rm -rf "$app_path/Contents/Resources/lib/assets/branding/screenshots"
|
||||
echo "Removed screenshots folder from .app bundle at $app_path"
|
||||
fi
|
||||
echo "Post-bdist_mac directory listing:"
|
||||
@@ -207,8 +207,8 @@ jobs:
|
||||
app_base="$(basename "$app_path")"
|
||||
app_parent="$(dirname "$app_path")"
|
||||
# Ensure screenshots folder is not shipped
|
||||
if [ -d "$app_path/Contents/Resources/assets/branding/screenshots" ]; then
|
||||
rm -rf "$app_path/Contents/Resources/assets/branding/screenshots"
|
||||
if [ -d "$app_path/Contents/Resources/lib/assets/branding/screenshots" ]; then
|
||||
rm -rf "$app_path/Contents/Resources/lib/assets/branding/screenshots"
|
||||
echo "Removed screenshots folder from .app bundle at $app_path"
|
||||
fi
|
||||
(cd "$app_parent" && zip -r "${GITHUB_WORKSPACE}/artifacts/YTSage-v${version}-${ARCH_SUFFIX}.app.zip" "$app_base")
|
||||
|
||||
@@ -62,6 +62,79 @@ jobs:
|
||||
echo "VERSION=$version" >> $env:GITHUB_ENV
|
||||
Write-Host "Prepared build variables for version: $version"
|
||||
|
||||
- name: Create cx_Freeze setup script
|
||||
shell: powershell
|
||||
run: |
|
||||
# Create setup script for cx_Freeze
|
||||
New-Item -Path "setup_cxfreeze.py" -ItemType File -Force
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "import os"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "from cx_Freeze import setup, Executable"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ""
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value 'version = os.environ.get("VERSION", "0.0.0")'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ""
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "build_exe_options = dict("
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " optimize=2,"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " packages=["
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtCore",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtGui",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtWidgets",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "requests",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PIL",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "packaging",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "markdown",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "pyglet",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "loguru",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "setuptools",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " ],"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " excludes=["
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtBluetooth",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtNetwork",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtOpenGL",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtPrintSupport",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtSvg",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtTest",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtXml",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtSql",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtHelp",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtMultimedia",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtQml",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtQuick",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PySide6.QtWebEngineCore",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PIL.ImageDraw",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "PIL.ImageFont",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "numpy",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "scipy",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "wx",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "pandas",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "tkinter",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "yt_dlp",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "unittest",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "test",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' "tests",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " ],"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " include_files=["
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' ("src", "src"),'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' ("assets", "lib/assets"),'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " ],"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ")"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ""
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "executables = ["
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " Executable("
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' script="main.py",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' target_name=f"YTSage-v{version}.exe",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' base="Win32GUI",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' icon="assets/branding/icons/YTSage.ico",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " )"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "]"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ""
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value "setup("
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' name="YTSage",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " version=version,"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' description="YTSage",'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ' options={"build_exe": build_exe_options},'
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value " executables=executables,"
|
||||
Add-Content -Path "setup_cxfreeze.py" -Value ")"
|
||||
|
||||
- name: Build Standard Version (ZIP)
|
||||
shell: powershell
|
||||
run: |
|
||||
@@ -74,21 +147,12 @@ jobs:
|
||||
if (Test-Path "build\bdist.*") { Remove-Item "build\bdist.*" -Recurse -Force }
|
||||
if (Test-Path "dist") { Remove-Item "dist" -Recurse -Force }
|
||||
|
||||
# Build executable using cx_Freeze CLI (use python -m to ensure proper base handling)
|
||||
python -m cx_Freeze main.py `
|
||||
--target-dir "dist\YTSage" `
|
||||
--base-name Win32GUI `
|
||||
--icon "assets\branding\icons\YTSage.ico" `
|
||||
--target-name "YTSage-v$version.exe" `
|
||||
--optimize 2 `
|
||||
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,pyglet,loguru,setuptools" `
|
||||
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
||||
--include-files "src" `
|
||||
--include-files "assets"
|
||||
# Build executable using setup script
|
||||
python setup_cxfreeze.py build_exe --build-exe "dist\YTSage"
|
||||
|
||||
# Remove screenshots folder to reduce build size
|
||||
if (Test-Path "dist\YTSage\assets\branding\screenshots") {
|
||||
Remove-Item "dist\YTSage\assets\branding\screenshots" -Recurse -Force
|
||||
if (Test-Path "dist\YTSage\lib\assets\branding\screenshots") {
|
||||
Remove-Item "dist\YTSage\lib\assets\branding\screenshots" -Recurse -Force
|
||||
Write-Host "Removed screenshots folder from standard build"
|
||||
}
|
||||
|
||||
@@ -153,21 +217,15 @@ jobs:
|
||||
if (Test-Path "build\exe.*") { Remove-Item "build\exe.*" -Recurse -Force }
|
||||
if (Test-Path "build\bdist.*") { Remove-Item "build\bdist.*" -Recurse -Force }
|
||||
|
||||
# Build executable with FFmpeg using cx_Freeze CLI (use python -m to ensure proper base handling)
|
||||
python -m cx_Freeze main.py `
|
||||
--target-dir "dist\YTSage-FFmpeg" `
|
||||
--base-name Win32GUI `
|
||||
--icon "assets\branding\icons\YTSage.ico" `
|
||||
--target-name "YTSage-v$version-ffmpeg.exe" `
|
||||
--optimize 2 `
|
||||
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,pyglet,loguru,setuptools" `
|
||||
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
||||
--include-files "src" `
|
||||
--include-files "assets"
|
||||
# Create modified setup script for FFmpeg version
|
||||
(Get-Content "setup_cxfreeze.py") -replace 'YTSage-v\{version\}\.exe', 'YTSage-v{version}-ffmpeg.exe' | Set-Content "setup_cxfreeze_ffmpeg.py"
|
||||
|
||||
# Build executable with FFmpeg using setup script
|
||||
python setup_cxfreeze_ffmpeg.py build_exe --build-exe "dist\YTSage-FFmpeg"
|
||||
|
||||
# Remove screenshots folder to reduce build size
|
||||
if (Test-Path "dist\YTSage-FFmpeg\assets\branding\screenshots") {
|
||||
Remove-Item "dist\YTSage-FFmpeg\assets\branding\screenshots" -Recurse -Force
|
||||
if (Test-Path "dist\YTSage-FFmpeg\lib\assets\branding\screenshots") {
|
||||
Remove-Item "dist\YTSage-FFmpeg\lib\assets\branding\screenshots" -Recurse -Force
|
||||
Write-Host "Removed screenshots folder from FFmpeg build"
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user