jobs:
build_unix:
runs-on: ubuntu-latest
-
outputs:
ytdlp_version: ${{ steps.bump_version.outputs.ytdlp_version }}
upload_url: ${{ steps.create_release.outputs.upload_url }}
- name: Get SHA2-512SUMS for yt-dlp.tar.gz
id: sha512_tar
run: echo "::set-output name=sha512_tar::$(sha512sum yt-dlp.tar.gz | awk '{print $1}')"
+
- name: Install dependencies for pypi
env:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
rm -rf dist/*
python setup.py sdist bdist_wheel
twine upload dist/*
+
- name: Install SSH private key
env:
BREW_TOKEN: ${{ secrets.BREW_TOKEN }}
git -C taps/ config user.email github-actions@example.com
git -C taps/ commit -am 'yt-dlp: ${{ steps.bump_version.outputs.ytdlp_version }}'
git -C taps/ push
+
- name: Create Release
id: create_release
uses: actions/create-release@v1
release_name: yt-dlp ${{ steps.bump_version.outputs.ytdlp_version }}
commitish: ${{ steps.push_update.outputs.head_sha }}
body: |
- Changelog:
+ See [this](https://github.com/yt-dlp/yt-dlp#release-files) for a description of the files
+
+ #### Changelog:
${{ env.changelog }}
draft: false
prerelease: false
build_macos:
runs-on: macos-11
needs: build_unix
-
outputs:
sha256_macos: ${{ steps.sha256_macos.outputs.sha256_macos }}
sha512_macos: ${{ steps.sha512_macos.outputs.sha512_macos }}
- name: Install Requirements
run: |
brew install coreutils
- /usr/bin/pip3 install --user Pyinstaller mutagen pycryptodomex websockets
+ /usr/bin/python3 -m pip install -U --user pip Pyinstaller mutagen pycryptodomex websockets
- name: Bump version
id: bump_version
- run: python devscripts/update-version.py
- - name: Print version
- run: echo "${{ steps.bump_version.outputs.ytdlp_version }}"
+ run: /usr/bin/python3 devscripts/update-version.py
- name: Build lazy extractors
id: lazy_extractors
run: /usr/bin/python3 devscripts/make_lazy_extractors.py yt_dlp/extractor/lazy_extractors.py
- name: Run PyInstaller Script
- run: /usr/bin/python3 ./pyinst.py --target-architecture universal2 --onefile
+ run: /usr/bin/python3 pyinst.py --target-architecture universal2 --onefile
- name: Upload yt-dlp MacOS binary
id: upload-release-macos
uses: actions/upload-release-asset@v1
run: echo "::set-output name=sha512_macos::$(sha512sum dist/yt-dlp_macos | awk '{print $1}')"
- name: Run PyInstaller Script with --onedir
- run: /usr/bin/python3 ./pyinst.py --target-architecture universal2 --onedir
+ run: /usr/bin/python3 pyinst.py --target-architecture universal2 --onedir
- uses: papeloto/action-zip@v1
with:
files: ./dist/yt-dlp_macos
build_windows:
runs-on: windows-latest
needs: build_unix
-
outputs:
sha256_win: ${{ steps.sha256_win.outputs.sha256_win }}
sha512_win: ${{ steps.sha512_win.outputs.sha512_win }}
- name: Bump version
id: bump_version
run: python devscripts/update-version.py
- - name: Print version
- run: echo "${{ steps.bump_version.outputs.ytdlp_version }}"
- name: Build lazy extractors
id: lazy_extractors
run: python devscripts/make_lazy_extractors.py yt_dlp/extractor/lazy_extractors.py
- name: Get SHA2-512SUMS for yt-dlp.exe
id: sha512_win
run: echo "::set-output name=sha512_win::$((Get-FileHash dist\yt-dlp.exe -Algorithm SHA512).Hash.ToLower())"
+
- name: Run PyInstaller Script with --onedir
run: python pyinst.py --onedir
- uses: papeloto/action-zip@v1
- name: Bump version
id: bump_version
run: python devscripts/update-version.py
- - name: Print version
- run: echo "${{ steps.bump_version.outputs.ytdlp_version }}"
- name: Build lazy extractors
id: lazy_extractors
run: python devscripts/make_lazy_extractors.py yt_dlp/extractor/lazy_extractors.py
steps:
- name: Make SHA2-256SUMS file
env:
+ SHA256_BIN: ${{ needs.build_unix.outputs.sha256_bin }}
+ SHA256_TAR: ${{ needs.build_unix.outputs.sha256_tar }}
SHA256_WIN: ${{ needs.build_windows.outputs.sha256_win }}
SHA256_PY2EXE: ${{ needs.build_windows.outputs.sha256_py2exe }}
SHA256_WIN_ZIP: ${{ needs.build_windows.outputs.sha256_win_zip }}
SHA256_WIN32: ${{ needs.build_windows32.outputs.sha256_win32 }}
SHA256_MACOS: ${{ needs.build_macos.outputs.sha256_macos }}
SHA256_MACOS_ZIP: ${{ needs.build_macos.outputs.sha256_macos_zip }}
- SHA256_BIN: ${{ needs.build_unix.outputs.sha256_bin }}
- SHA256_TAR: ${{ needs.build_unix.outputs.sha256_tar }}
run: |
+ echo "${{ env.SHA256_BIN }} yt-dlp" >> SHA2-256SUMS
+ echo "${{ env.SHA256_TAR }} yt-dlp.tar.gz" >> SHA2-256SUMS
echo "${{ env.SHA256_WIN }} yt-dlp.exe" >> SHA2-256SUMS
echo "${{ env.SHA256_PY2EXE }} yt-dlp_min.exe" >> SHA2-256SUMS
echo "${{ env.SHA256_WIN32 }} yt-dlp_x86.exe" >> SHA2-256SUMS
+ echo "${{ env.SHA256_WIN_ZIP }} yt-dlp_win.zip" >> SHA2-256SUMS
echo "${{ env.SHA256_MACOS }} yt-dlp_macos" >> SHA2-256SUMS
echo "${{ env.SHA256_MACOS_ZIP }} yt-dlp_macos.zip" >> SHA2-256SUMS
- echo "${{ env.SHA256_BIN }} yt-dlp" >> SHA2-256SUMS
- echo "${{ env.SHA256_TAR }} yt-dlp.tar.gz" >> SHA2-256SUMS
- echo "${{ env.SHA256_WIN_ZIP }} yt-dlp_win.zip" >> SHA2-256SUMS
- name: Upload 256SUMS file
id: upload-sums
uses: actions/upload-release-asset@v1
asset_content_type: text/plain
- name: Make SHA2-512SUMS file
env:
+ SHA512_BIN: ${{ needs.build_unix.outputs.sha512_bin }}
+ SHA512_TAR: ${{ needs.build_unix.outputs.sha512_tar }}
SHA512_WIN: ${{ needs.build_windows.outputs.sha512_win }}
SHA512_PY2EXE: ${{ needs.build_windows.outputs.sha512_py2exe }}
SHA512_WIN_ZIP: ${{ needs.build_windows.outputs.sha512_win_zip }}
SHA512_WIN32: ${{ needs.build_windows32.outputs.sha512_win32 }}
SHA512_MACOS: ${{ needs.build_macos.outputs.sha512_macos }}
SHA512_MACOS_ZIP: ${{ needs.build_macos.outputs.sha512_macos_zip }}
- SHA512_BIN: ${{ needs.build_unix.outputs.sha512_bin }}
- SHA512_TAR: ${{ needs.build_unix.outputs.sha512_tar }}
run: |
+ echo "${{ env.SHA512_BIN }} yt-dlp" >> SHA2-512SUMS
+ echo "${{ env.SHA512_TAR }} yt-dlp.tar.gz" >> SHA2-512SUMS
echo "${{ env.SHA512_WIN }} yt-dlp.exe" >> SHA2-512SUMS
+ echo "${{ env.SHA512_WIN_ZIP }} yt-dlp_win.zip" >> SHA2-512SUMS
echo "${{ env.SHA512_PY2EXE }} yt-dlp_min.exe" >> SHA2-512SUMS
echo "${{ env.SHA512_WIN32 }} yt-dlp_x86.exe" >> SHA2-512SUMS
echo "${{ env.SHA512_MACOS }} yt-dlp_macos" >> SHA2-512SUMS
echo "${{ env.SHA512_MACOS_ZIP }} yt-dlp_macos.zip" >> SHA2-512SUMS
- echo "${{ env.SHA512_BIN }} yt-dlp" >> SHA2-512SUMS
- echo "${{ env.SHA512_TAR }} yt-dlp.tar.gz" >> SHA2-512SUMS
- echo "${{ env.SHA512_WIN_ZIP }} yt-dlp_win.zip" >> SHA2-512SUMS
- name: Upload 512SUMS file
id: upload-512sums
uses: actions/upload-release-asset@v1
# set markdown input format to "markdown-smart" for pandoc version 2 and to "markdown" for pandoc prior to version 2
MARKDOWN = $(shell if [ `pandoc -v | head -n1 | cut -d" " -f2 | head -c1` = "2" ]; then echo markdown-smart; else echo markdown; fi)
-install: lazy_extractors yt-dlp yt-dlp.1 completions
- install -Dm755 yt-dlp $(DESTDIR)$(BINDIR)
- install -Dm644 yt-dlp.1 $(DESTDIR)$(MANDIR)/man1
+install: lazy-extractors yt-dlp yt-dlp.1 completions
+ install -Dm755 yt-dlp $(DESTDIR)$(BINDIR)/yt-dlp
+ install -Dm644 yt-dlp.1 $(DESTDIR)$(MANDIR)/man1/yt-dlp.1
install -Dm644 completions/bash/yt-dlp $(DESTDIR)$(SHAREDIR)/bash-completion/completions/yt-dlp
install -Dm644 completions/zsh/_yt-dlp $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_yt-dlp
install -Dm644 completions/fish/yt-dlp.fish $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d/yt-dlp.fish
yt-dlp is not platform specific. So it should work on your Unix box, on Windows or on macOS
You can install yt-dlp using one of the following methods:
-* Download the binary from the [latest release](https://github.com/yt-dlp/yt-dlp/releases/latest)
+* Download [the binary](#release-files) from the [latest release](https://github.com/yt-dlp/yt-dlp/releases/latest)
* With Homebrew, `brew install yt-dlp/taps/yt-dlp`
* Use [PyPI package](https://pypi.org/project/yt-dlp): `python3 -m pip install --upgrade yt-dlp`
-* Use pip+git: `python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp.git@release`
-* Install master branch: `python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp`
+* Install master branch: `python3 -m pip3 install -U https://github.com/yt-dlp/yt-dlp/archive/master.zip`
Note that on some systems, you may need to use `py` or `python` instead of `python3`
### RELEASE FILES
+#### Recommended
+
+File|Description
+:---|:---
+[yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform independant binary. Needs Python (Recommended for **UNIX-like systems**)
+[yt-dlp.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)|Windows standalone x64 binary (Recommended for **Windows**)
+
+#### Alternatives
+
File|Description
:---|:---
-[yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform independant binary. Needs Python (Recommended for UNIX like OSes)
-[yt-dlp.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)|Windows standalone x64 binary (Recommended for Windows)
-[yt-dlp_x86.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows standalone x86 (32bit) binary
-[yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged windows executable
[yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS standalone executable
-[yt-dlp_macos.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos.zip)|Unpackaged MacOS executable
-[yt-dlp_min.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows standalone x64 binary built with `py2exe`. Does not contain `pycryptodomex`, needs VC++14
+[yt-dlp_x86.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows standalone x86 (32bit) binary
+[yt-dlp_min.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows standalone x64 binary built with `py2exe`.<br/> Does not contain `pycryptodomex`, needs VC++14
+[yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged windows executable (No auto-update)
+[yt-dlp_macos.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos.zip)|Unpackaged MacOS executable (No auto-update)
+
+#### Misc
+
+File|Description
+:---|:---
[yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball. Also contains manpages, completions, etc
[SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
[SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
**For Windows**:
To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodomex, websockets)
- python3 -m pip install -U -r requirements.txt
-
-Once you have all the necessary dependencies installed, just run `py pyinst.py`. The executable will be built for the same architecture (32/64 bit) as the python used to build it.
-
-You can also build the executable without any version info or metadata by using:
+Once you have all the necessary dependencies installed, just run `pyinst.py`. The executable will be built for the same architecture (32/64 bit) as the python used to build it.
- pyinstaller.exe yt_dlp\__main__.py --onefile --name yt-dlp
+ py -m pip install -U pyinstaller -r requirements.txt
+ py pyinst.py
Note that pyinstaller [does not support](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms) Python installed from the Windows store without using a virtual environment
#!/usr/bin/env python3
# coding: utf-8
-
-from __future__ import unicode_literals
-import sys
+import os
import platform
-
+import sys
from PyInstaller.utils.hooks import collect_submodules
-if platform.system() == 'Windows':
+
+OS_NAME = platform.system()
+if OS_NAME == 'Windows':
from PyInstaller.utils.win32.versioninfo import (
VarStruct, VarFileInfo, StringStruct, StringTable,
StringFileInfo, FixedFileInfo, VSVersionInfo, SetVersion,
)
-import PyInstaller.__main__
+elif OS_NAME == 'Darwin':
+ pass
+else:
+ raise Exception('{OS_NAME} is not supported')
-suffix = ''
-arch = platform.architecture()[0][:2]
-assert arch in ('32', '64')
-_x86 = '_x86' if arch == '32' else ''
+ARCH = platform.architecture()[0][:2]
-if platform.system() == 'Windows':
- suffix = _x86
-if platform.system() == 'Darwin':
- suffix = '_macos'
-# Compatability with older arguments
-opts = sys.argv[1:]
-if opts[0:1] in (['32'], ['64']):
- if arch != opts[0]:
- raise Exception(f'{opts[0]}bit executable cannot be built on a {arch}bit system')
- opts = opts[1:]
-opts = opts or ['--onefile']
+def main():
+ opts = parse_options()
+ version = read_version()
-print(f'Building {arch}bit version with options {opts}')
+ suffix = '_x86' if ARCH == '32' else '_macos' if OS_NAME == 'Darwin' else ''
+ final_file = 'dist/%syt-dlp%s%s' % (
+ 'yt-dlp/' if '--onedir' in opts else '', suffix, '.exe' if OS_NAME == 'Windows' else '')
-FILE_DESCRIPTION = 'yt-dlp%s' % (' (32 Bit)' if _x86 else '')
+ print(f'Building yt-dlp v{version} {ARCH}bit for {OS_NAME} with options {opts}')
+ print('Remember to update the version using "devscripts/update-version.py"')
+ if not os.path.isfile('yt_dlp/extractor/lazy_extractors.py'):
+ print('WARNING: Building without lazy_extractors. Run '
+ '"devscripts/make_lazy_extractors.py" "yt_dlp/extractor/lazy_extractors.py" '
+ 'to build lazy extractors', file=sys.stderr)
+ print(f'Destination: {final_file}\n')
-exec(compile(open('yt_dlp/version.py').read(), 'yt_dlp/version.py', 'exec'))
-VERSION = locals()['__version__']
+ opts = [
+ f'--name=yt-dlp{suffix}',
+ '--icon=devscripts/logo.ico',
+ '--upx-exclude=vcruntime140.dll',
+ '--noconfirm',
+ *dependancy_options(),
+ *opts,
+ 'yt_dlp/__main__.py',
+ ]
+ print(f'Running PyInstaller with {opts}')
-VERSION_LIST = VERSION.split('.')
-VERSION_LIST = list(map(int, VERSION_LIST)) + [0] * (4 - len(VERSION_LIST))
+ import PyInstaller.__main__
-print('Version: %s%s' % (VERSION, _x86))
-print('Remember to update the version using devscipts\\update-version.py')
+ PyInstaller.__main__.run(opts)
+
+ set_version_info(final_file, version)
+
+
+def parse_options():
+ # Compatability with older arguments
+ opts = sys.argv[1:]
+ if opts[0:1] in (['32'], ['64']):
+ if ARCH != opts[0]:
+ raise Exception(f'{opts[0]}bit executable cannot be built on a {ARCH}bit system')
+ opts = opts[1:]
+ return opts or ['--onefile']
-if platform.system() == 'Windows':
- 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', 'yt-dlp%s Command Line Interface.' % _x86),
- StringStruct('CompanyName', 'https://github.com/yt-dlp'),
- StringStruct('FileDescription', FILE_DESCRIPTION),
- StringStruct('FileVersion', VERSION),
- StringStruct('InternalName', 'yt-dlp%s' % _x86),
- StringStruct(
- 'LegalCopyright',
- 'pukkandan.ytdlp@gmail.com | UNLICENSE',
- ),
- StringStruct('OriginalFilename', 'yt-dlp%s.exe' % _x86),
- StringStruct('ProductName', 'yt-dlp%s' % _x86),
- StringStruct(
- 'ProductVersion',
- '%s%s on Python %s' % (VERSION, _x86, platform.python_version())),
- ])]),
- VarFileInfo([VarStruct('Translation', [0, 1200])])
- ]
- )
+
+def read_version():
+ exec(compile(open('yt_dlp/version.py').read(), 'yt_dlp/version.py', 'exec'))
+ return locals()['__version__']
+
+
+def version_to_list(version):
+ version_list = version.split('.')
+ return list(map(int, version_list)) + [0] * (4 - len(version_list))
+
+
+def dependancy_options():
+ dependancies = [pycryptodome_module(), 'mutagen'] + collect_submodules('websockets')
+ excluded_modules = ['test', 'ytdlp_plugins', 'youtube-dl', 'youtube-dlc']
+
+ yield from (f'--hidden-import={module}' for module in dependancies)
+ yield from (f'--exclude-module={module}' for module in excluded_modules)
def pycryptodome_module():
return 'Cryptodome'
-dependancies = [pycryptodome_module(), 'mutagen'] + collect_submodules('websockets')
-excluded_modules = ['test', 'ytdlp_plugins', 'youtube-dl', 'youtube-dlc']
+def set_version_info(exe, version):
+ if OS_NAME == 'Windows':
+ windows_set_version(exe, version)
+
+
+def windows_set_version(exe, version):
+ version_list = version_to_list(version)
+ suffix = '_x86' if ARCH == '32' else ''
+ SetVersion(exe, 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', 'yt-dlp%s Command Line Interface.' % suffix),
+ StringStruct('CompanyName', 'https://github.com/yt-dlp'),
+ StringStruct('FileDescription', 'yt-dlp%s' % (' (32 Bit)' if ARCH == '32' else '')),
+ StringStruct('FileVersion', version),
+ StringStruct('InternalName', f'yt-dlp{suffix}'),
+ StringStruct('LegalCopyright', 'pukkandan.ytdlp@gmail.com | UNLICENSE'),
+ StringStruct('OriginalFilename', f'yt-dlp{suffix}.exe'),
+ StringStruct('ProductName', f'yt-dlp{suffix}'),
+ StringStruct(
+ 'ProductVersion', f'{version}{suffix} on Python {platform.python_version()}'),
+ ])]), VarFileInfo([VarStruct('Translation', [0, 1200])])
+ ]
+ ))
-PyInstaller.__main__.run([
- '--name=yt-dlp%s' % suffix,
- '--icon=devscripts/logo.ico',
- *[f'--exclude-module={module}' for module in excluded_modules],
- *[f'--hidden-import={module}' for module in dependancies],
- '--upx-exclude=vcruntime140.dll',
- '--noconfirm',
- *opts,
- 'yt_dlp/__main__.py',
-])
-if platform.system() == 'Windows':
- SetVersion('dist/%syt-dlp%s.exe' % ('yt-dlp/' if '--onedir' in opts else '', _x86), VERSION_FILE)
+if __name__ == '__main__':
+ main()
return report_network_error('download latest version')
try:
- with open(exe + '.new', 'wb') as outf:
+ with open(filename + '.new', 'wb') as outf:
outf.write(newcontent)
except (IOError, OSError):
- return report_permission_error(f'{exe}.new')
+ return report_permission_error(f'{filename}.new')
- expected_sum = get_sha256sum('exe', arch)
+ expected_sum = get_sha256sum(variant, arch)
if not expected_sum:
ydl.report_warning('no hash information found for the release')
- elif calc_sha256sum(exe + '.new') != expected_sum:
+ elif calc_sha256sum(filename + '.new') != expected_sum:
report_network_error('verify the new executable')
try:
- os.remove(exe + '.new')
+ os.remove(filename + '.new')
except OSError:
return report_unable('remove corrupt download')
try:
- os.rename(exe, exe + '.old')
+ os.rename(filename, filename + '.old')
except (IOError, OSError):
return report_unable('move current version')
try:
- os.rename(exe + '.new', exe)
+ os.rename(filename + '.new', filename)
except (IOError, OSError):
report_unable('overwrite current version')
- os.rename(exe + '.old', exe)
+ os.rename(filename + '.old', filename)
return
try:
# Continues to run in the background
Popen(
- 'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % exe,
+ 'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % filename,
shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
ydl.to_screen('Updated yt-dlp to version %s' % version_id)
return True # Exit app
projects / yt-dlp.git / commitdiff
