Refactor update-version, pyinst.py and related files

* Refactor update-version
* Moved pyinst, update-version and icon into devscripts
* pyinst doesn't bump version anymore
* Merge pyinst and pyinst32. Usage: `pyinst.py [32|64]`
* Add mutagen as requirement
* Remove make_win and related files

.github/workflows/build.yml

@@ -25,8 +25,8 @@ jobs:
       run: sudo apt-get -y install zip pandoc man
     - name: Bump version
       id: bump_version
-      run: python devscripts/update-version-workflow.py
+      run: python devscripts/update-version.py
-    - name: Check the version
+    - name: Print version
       run: echo "${{ steps.bump_version.outputs.ytdlc_version }}"
     - name: Run Make
       run: make
@@ -84,11 +84,14 @@ jobs:
       with:
           python-version: '3.8'
     - name: Install Requirements
-      run: pip install pyinstaller
+      run: pip install pyinstaller mutagen
     - name: Bump version
-      run: python devscripts/update-version-workflow.py
+      id: bump_version
+      run: python devscripts/update-version.py
+    - name: Print version
+      run: echo "${{ steps.bump_version.outputs.ytdlc_version }}"
     - name: Run PyInstaller Script
-      run: python pyinst.py
+      run: python devscripts/pyinst.py 64
     - name: Upload youtube-dlc.exe Windows binary
       id: upload-release-windows
       uses: actions/upload-release-asset@v1
@@ -119,11 +122,14 @@ jobs:
           python-version: '3.4.4'
           architecture: 'x86'
     - name: Install Requirements for 32 Bit
-      run: pip install pyinstaller==3.5
+      run: pip install pyinstaller==3.5 mutagen
     - name: Bump version
-      run: python devscripts/update-version-workflow.py
+      id: bump_version
+      run: python devscripts/update-version.py
+    - name: Print version
+      run: echo "${{ steps.bump_version.outputs.ytdlc_version }}"
     - name: Run PyInstaller Script for 32 Bit
-      run: python pyinst32.py
+      run: python devscripts/pyinst.py 32
     - name: Upload Executable youtube-dlc_x86.exe
       id: upload-release-windows32
       uses: actions/upload-release-asset@v1

README.md

@@ -99,17 +99,16 @@ You can install yt-dlp using one of the following methods:
 ### COMPILE
 
 **For Windows**:
-To build the Windows executable yourself (without version info!)
+To build the Windows executable, you must have pyinstaller (and optionally mutagen for embedding thumbnail in opus/ogg files)
+
+    python -m pip install --upgrade pyinstaller mutagen
+
+For the 64bit version, run `py devscripts\pyinst.py 64` using 64bit python3. Similarly, to install 32bit version, run `py devscripts\pyinst.py 32` using 32bit python (preferably 3)
+
+You can also build the executable without any version info or metadata by using:
 
-    python -m pip install --upgrade pyinstaller
     pyinstaller.exe youtube_dlc\__main__.py --onefile --name youtube-dlc
 
-Or simply execute the `make_win.bat` if pyinstaller is installed.
-There will be a `youtube-dlc.exe` in `/dist`  
-
-New way to build Windows is to use `python pyinst.py` (please use python3 64Bit)  
-For 32Bit Version use a 32Bit Version of python (3 preferred here as well) and run `python pyinst32.py`  
-
 **For Unix**:
 You will need the required build tools  
 python, make (GNU), pandoc, zip, nosetests  
@@ -117,6 +116,7 @@ Then simply type this
 
     make
 
+**Note**: In either platform, `devscripts\update-version.py` can be used to automatically update the version number
 
 # DESCRIPTION
 **youtube-dlc** is a command-line program to download videos from youtube.com many other [video platforms](docs/supportedsites.md). It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.

devscripts/pyinst.py

@@ -0,0 +1,69 @@
+from __future__ import unicode_literals
+import sys
+
+from PyInstaller.utils.win32.versioninfo import (
+    VarStruct, VarFileInfo, StringStruct, StringTable,
+    StringFileInfo, FixedFileInfo, VSVersionInfo, SetVersion,
+)
+import PyInstaller.__main__
+
+
+assert len(sys.argv) > 1 and sys.argv[1] in ("32", "64")
+_x86 = "_x86" if sys.argv[1] == "32" else ""
+
+FILE_DESCRIPTION = 'Media Downloader%s' % (" (32 Bit)" if _x86 else '')
+SHORT_URLS = {"32": "git.io/JUGsM", "64": "git.io/JLh7K"}
+
+
+exec(compile(open('youtube_dlc/version.py').read(), 'youtube_dlc/version.py', 'exec'))
+VERSION = locals()['__version__']
+
+VERSION_LIST = VERSION.replace('-', '.').split('.')
+VERSION_LIST = list(map(int, VERSION_LIST)) + [0] * (4 - len(VERSION_LIST))
+
+print('Version: %s%s' % (VERSION, _x86))
+print('Remember to update the version using devscipts\\update-version.py')
+
+VERSION_FILE = VSVersionInfo(
+    ffi=FixedFileInfo(
+        filevers=VERSION_LIST,
+        prodvers=VERSION_LIST,
+        mask=0x3F,
+        flags=0x0,
+        OS=0x4,
+        fileType=0x1,
+        subtype=0x0,
+        date=(0, 0),
+    ),
+    kids=[
+        StringFileInfo([
+            StringTable(
+                "040904B0", [
+                    StringStruct("Comments", "Youtube-dlc%s Command Line Interface." % _x86),
+                    StringStruct("CompanyName", "pukkandan@gmail.com"),
+                    StringStruct("FileDescription", FILE_DESCRIPTION),
+                    StringStruct("FileVersion", VERSION),
+                    StringStruct("InternalName", "youtube-dlc%s" % _x86),
+                    StringStruct(
+                        "LegalCopyright",
+                        "pukkandan@gmail.com | UNLICENSE",
+                    ),
+                    StringStruct("OriginalFilename", "youtube-dlc%s.exe" % _x86),
+                    StringStruct("ProductName", "Youtube-dlc%s" % _x86),
+                    StringStruct("ProductVersion", "%s%s | %s" % (VERSION, _x86, SHORT_URLS[sys.argv[1]])),
+                ])]),
+        VarFileInfo([VarStruct("Translation", [0, 1200])])
+    ]
+)
+
+PyInstaller.__main__.run([
+    '--name=youtube-dlc%s' % _x86,
+    '--onefile',
+    '--icon=devscripts/cloud.ico',
+    '--exclude-module=youtube_dl',
+    '--exclude-module=test',
+    '--exclude-module=ytdlp_plugins',
+    '--hidden-import=mutagen',
+    'youtube_dlc/__main__.py',
+])
+SetVersion('dist/youtube-dlc%s.exe' % _x86, VERSION_FILE)

devscripts/update-version.py

@@ -3,26 +3,27 @@ from datetime import datetime
 # import urllib.request
 
 # response = urllib.request.urlopen('https://blackjack4494.github.io/youtube-dlc/update/LATEST_VERSION')
-# _LATEST_VERSION = response.read().decode('utf-8')
+# old_version = response.read().decode('utf-8')
 
 exec(compile(open('youtube_dlc/version.py').read(), 'youtube_dlc/version.py', 'exec'))
-_LATEST_VERSION = locals()['__version__']
+old_version = locals()['__version__']
 
-_OLD_VERSION = _LATEST_VERSION.replace('-', '.').split(".", 4)
+old_version_list = old_version.replace('-', '.').split(".", 4)
 
-old_ver = '.'.join(_OLD_VERSION[:3])
+old_ver = '.'.join(old_version_list[:3])
-old_rev = _OLD_VERSION[3] if len(_OLD_VERSION) > 3 else ''
+old_rev = old_version_list[3] if len(old_version_list) > 3 else ''
 
 ver = datetime.now().strftime("%Y.%m.%d")
 rev = str(int(old_rev or 0) + 1) if old_ver == ver else ''
 
-version = '.'.join((ver, rev)) if rev else ver
+VERSION = '.'.join((ver, rev)) if rev else ver
+# VERSION_LIST = [(int(v) for v in ver.split(".") + [rev or 0])]
 
-print('::set-output name=ytdlc_version::' + version)
+print('::set-output name=ytdlc_version::' + VERSION)
 
 file_version_py = open('youtube_dlc/version.py', 'rt')
 data = file_version_py.read()
-data = data.replace(_LATEST_VERSION, version)
+data = data.replace(old_version, VERSION)
 file_version_py.close()
 
 file_version_py = open('youtube_dlc/version.py', 'wt')

make_win.bat

@@ -1 +0,0 @@
-py -m PyInstaller youtube_dlc\__main__.py --onefile --name youtube-dlc --version-file win\ver.txt --icon win\icon\cloud.ico --upx-exclude=vcruntime140.dll --exclude-module ytdlp_plugins

pyinst.py

@@ -1,92 +0,0 @@
-from __future__ import unicode_literals
-from PyInstaller.utils.win32.versioninfo import (
-    VarStruct, VarFileInfo, StringStruct, StringTable,
-    StringFileInfo, FixedFileInfo, VSVersionInfo, SetVersion,
-)
-import PyInstaller.__main__
-
-from datetime import datetime
-
-FILE_DESCRIPTION = 'Media Downloader'
-
-exec(compile(open('youtube_dlc/version.py').read(), 'youtube_dlc/version.py', 'exec'))
-
-_LATEST_VERSION = locals()['__version__']
-
-_OLD_VERSION = _LATEST_VERSION.rsplit("-", 1)
-
-if len(_OLD_VERSION) > 0:
-    old_ver = _OLD_VERSION[0]
-
-old_rev = ''
-if len(_OLD_VERSION) > 1:
-    old_rev = _OLD_VERSION[1]
-
-now = datetime.now()
-# ver = f'{datetime.today():%Y.%m.%d}'
-ver = now.strftime("%Y.%m.%d")
-rev = ''
-
-if old_ver == ver:
-    if old_rev:
-        rev = int(old_rev) + 1
-    else:
-        rev = 1
-
-_SEPARATOR = '-'
-
-version = _SEPARATOR.join(filter(None, [ver, str(rev)]))
-
-print(version)
-
-version_list = ver.split(".")
-_year, _month, _day = [int(value) for value in version_list]
-_rev = 0
-if rev:
-    _rev = rev
-_ver_tuple = _year, _month, _day, _rev
-
-version_file = VSVersionInfo(
-    ffi=FixedFileInfo(
-        filevers=_ver_tuple,
-        prodvers=_ver_tuple,
-        mask=0x3F,
-        flags=0x0,
-        OS=0x4,
-        fileType=0x1,
-        subtype=0x0,
-        date=(0, 0),
-    ),
-    kids=[
-        StringFileInfo(
-            [
-                StringTable(
-                    "040904B0",
-                    [
-                        StringStruct("Comments", "Youtube-dlc Command Line Interface."),
-                        StringStruct("CompanyName", "theidel@uni-bremen.de"),
-                        StringStruct("FileDescription", FILE_DESCRIPTION),
-                        StringStruct("FileVersion", version),
-                        StringStruct("InternalName", "youtube-dlc"),
-                        StringStruct(
-                            "LegalCopyright",
-                            "theidel@uni-bremen.de | UNLICENSE",
-                        ),
-                        StringStruct("OriginalFilename", "youtube-dlc.exe"),
-                        StringStruct("ProductName", "Youtube-dlc"),
-                        StringStruct("ProductVersion", version + " | git.io/JLh7K"),
-                    ],
-                )
-            ]
-        ),
-        VarFileInfo([VarStruct("Translation", [0, 1200])])
-    ]
-)
-
-PyInstaller.__main__.run([
-    '--name=youtube-dlc',
-    '--onefile',
-    '--icon=win/icon/cloud.ico',
-    'youtube_dlc/__main__.py',
-])
-SetVersion('dist/youtube-dlc.exe', version_file)

pyinst32.py

@@ -1,92 +0,0 @@
-from __future__ import unicode_literals
-from PyInstaller.utils.win32.versioninfo import (
-    VarStruct, VarFileInfo, StringStruct, StringTable,
-    StringFileInfo, FixedFileInfo, VSVersionInfo, SetVersion,
-)
-import PyInstaller.__main__
-
-from datetime import datetime
-
-FILE_DESCRIPTION = 'Media Downloader 32 Bit Version'
-
-exec(compile(open('youtube_dlc/version.py').read(), 'youtube_dlc/version.py', 'exec'))
-
-_LATEST_VERSION = locals()['__version__']
-
-_OLD_VERSION = _LATEST_VERSION.rsplit("-", 1)
-
-if len(_OLD_VERSION) > 0:
-    old_ver = _OLD_VERSION[0]
-
-old_rev = ''
-if len(_OLD_VERSION) > 1:
-    old_rev = _OLD_VERSION[1]
-
-now = datetime.now()
-# ver = f'{datetime.today():%Y.%m.%d}'
-ver = now.strftime("%Y.%m.%d")
-rev = ''
-
-if old_ver == ver:
-    if old_rev:
-        rev = int(old_rev) + 1
-    else:
-        rev = 1
-
-_SEPARATOR = '-'
-
-version = _SEPARATOR.join(filter(None, [ver, str(rev)]))
-
-print(version)
-
-version_list = ver.split(".")
-_year, _month, _day = [int(value) for value in version_list]
-_rev = 0
-if rev:
-    _rev = rev
-_ver_tuple = _year, _month, _day, _rev
-
-version_file = VSVersionInfo(
-    ffi=FixedFileInfo(
-        filevers=_ver_tuple,
-        prodvers=_ver_tuple,
-        mask=0x3F,
-        flags=0x0,
-        OS=0x4,
-        fileType=0x1,
-        subtype=0x0,
-        date=(0, 0),
-    ),
-    kids=[
-        StringFileInfo(
-            [
-                StringTable(
-                    "040904B0",
-                    [
-                        StringStruct("Comments", "Youtube-dlc_x86 Command Line Interface."),
-                        StringStruct("CompanyName", "theidel@uni-bremen.de"),
-                        StringStruct("FileDescription", FILE_DESCRIPTION),
-                        StringStruct("FileVersion", version),
-                        StringStruct("InternalName", "youtube-dlc_x86"),
-                        StringStruct(
-                            "LegalCopyright",
-                            "theidel@uni-bremen.de | UNLICENSE",
-                        ),
-                        StringStruct("OriginalFilename", "youtube-dlc_x86.exe"),
-                        StringStruct("ProductName", "Youtube-dlc_x86"),
-                        StringStruct("ProductVersion", version + "_x86 | git.io/JUGsM"),
-                    ],
-                )
-            ]
-        ),
-        VarFileInfo([VarStruct("Translation", [0, 1200])])
-    ]
-)
-
-PyInstaller.__main__.run([
-    '--name=youtube-dlc_x86',
-    '--onefile',
-    '--icon=win/icon/cloud.ico',
-    'youtube_dlc/__main__.py',
-])
-SetVersion('dist/youtube-dlc_x86.exe', version_file)

setup.py

@@ -7,10 +7,12 @@ import warnings
 import sys
 from distutils.spawn import spawn
 
+
 # Get the version from youtube_dlc/version.py without importing the package
 exec(compile(open('youtube_dlc/version.py').read(),
              'youtube_dlc/version.py', 'exec'))
 
+
 DESCRIPTION = 'Command-line program to download videos from YouTube.com and many other other video platforms.'
 
 LONG_DESCRIPTION = '\n\n'.join((
@@ -18,6 +20,9 @@ LONG_DESCRIPTION = '\n\n'.join((
     '**PS**: Many links in this document will not work since this is a copy of the README.md from Github',
     open("README.md", "r", encoding="utf-8").read()))
 
+REQUIREMENTS = ['mutagen']
+
+
 if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
     print("inv")
 else:
@@ -61,7 +66,7 @@ class build_lazy_extractors(Command):
         )
 
 
-packages = find_packages(exclude=("youtube_dl","test",))
+packages = find_packages(exclude=("youtube_dl", "test", "ytdlp_plugins"))
 
 setup(
     name="yt-dlp",
@@ -73,6 +78,7 @@ setup(
     long_description_content_type="text/markdown",
     url="https://github.com/pukkandan/yt-dlp",
     packages=packages,
+    install_requires=REQUIREMENTS,
     project_urls={
         'Documentation': 'https://github.com/pukkandan/yt-dlp#yt-dlp',
         'Source': 'https://github.com/pukkandan/yt-dlp',

test/test_unicode_literals.py

@@ -15,8 +15,6 @@ IGNORED_FILES = [
     'setup.py',  # http://bugs.python.org/issue13943
     'conf.py',
     'buildserver.py',
-    'pyinst.py',
-    'pyinst32.py',
 ]
 
 IGNORED_DIRS = [

win/ver.txt

@@ -1,45 +0,0 @@
-# UTF-8
-#
-# For more details about fixed file info 'ffi' see:
-# http://msdn.microsoft.com/en-us/library/ms646997.aspx
-VSVersionInfo(
-  ffi=FixedFileInfo(
-    # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
-    # Set not needed items to zero 0.
-    filevers=(16, 9, 2020, 0),
-    prodvers=(16, 9, 2020, 0),
-    # Contains a bitmask that specifies the valid bits 'flags'r
-    mask=0x3f,
-    # Contains a bitmask that specifies the Boolean attributes of the file.
-    flags=0x0,
-    # The operating system for which this file was designed.
-    # 0x4 - NT and there is no need to change it.
-    # OS=0x40004,
-	OS=0x4,
-    # The general type of file.
-    # 0x1 - the file is an application.
-    fileType=0x1,
-    # The function of the file.
-    # 0x0 - the function is not defined for this fileType
-    subtype=0x0,
-    # Creation date and time stamp.
-    date=(0, 0)
-    ),
-  kids=[
-    StringFileInfo(
-      [
-      StringTable(
-        u'040904B0',
-        [StringStruct(u'Comments', u'Youtube-dlc Command Line Interface.'),
-	StringStruct(u'CompanyName', u'theidel@uni-bremen.de'),
-        StringStruct(u'FileDescription', u'Media Downloader'),
-        StringStruct(u'FileVersion', u'16.9.2020.0'),
-        StringStruct(u'InternalName', u'youtube-dlc'),
-        StringStruct(u'LegalCopyright', u'theidel@uni-bremen.de | UNLICENSE'),
-        StringStruct(u'OriginalFilename', u'youtube-dlc.exe'),
-        StringStruct(u'ProductName', u'Youtube-dlc'),
-        StringStruct(u'ProductVersion', u'16.9.2020.0 | git.io/JUGsM')])
-      ]), 
-    VarFileInfo([VarStruct(u'Translation', [0, 1200])])
-  ]
-)

youtube_dlc/postprocessor/embedthumbnail.py

@@ -153,7 +153,7 @@ class EmbedThumbnailPP(FFmpegPostProcessor):
 
         elif info['ext'] in ['ogg', 'opus']:
             if not _has_mutagen:
-                raise EmbedThumbnailPPError('module mutagen was not found. Please install')
+                raise EmbedThumbnailPPError('module mutagen was not found. Please install using `python -m pip install mutagen`')
             size_regex = r',\s*(?P<w>\d+)x(?P<h>\d+)\s*[,\[]'
             size_result = self.run_ffmpeg(thumbnail_filename, thumbnail_filename, ['-hide_banner'])
             mobj = re.search(size_regex, size_result)