]> jfr.im git - yt-dlp.git/blobdiff - setup.py
[extractor/youtube] More metadata for storyboards (#4334)
[yt-dlp.git] / setup.py
index cebe556c998c55bd0e87ebb05290042594584dff..ef9d3e91b8c7fdf2b899767f17f734f222893e43 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,31 +1,86 @@
-#!/usr/bin/env python
-# coding: utf-8
+#!/usr/bin/env python3
 
-from setuptools import setup, Command, find_packages
 import os.path
-import warnings
+import subprocess
 import sys
-from distutils.spawn import spawn
+import warnings
+
+try:
+    from setuptools import Command, find_packages, setup
+    setuptools_available = True
+except ImportError:
+    from distutils.core import Command, setup
+    setuptools_available = False
+
+
+def read(fname):
+    with open(fname, encoding='utf-8') as f:
+        return f.read()
 
 
 # Get the version from yt_dlp/version.py without importing the package
-exec(compile(open('yt_dlp/version.py').read(),
-             'yt_dlp/version.py', 'exec'))
+def read_version(fname):
+    exec(compile(read(fname), fname, 'exec'))
+    return locals()['__version__']
 
 
-DESCRIPTION = 'Command-line program to download videos from YouTube.com and many other other video platforms.'
+VERSION = read_version('yt_dlp/version.py')
+
+DESCRIPTION = 'A youtube-dl fork with additional features and patches'
 
 LONG_DESCRIPTION = '\n\n'.join((
     'Official repository: <https://github.com/yt-dlp/yt-dlp>',
-    '**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()))
+    '**PS**: Some links in this document will not work since this is a copy of the README.md from Github',
+    read('README.md')))
+
+REQUIREMENTS = read('requirements.txt').splitlines()
 
-REQUIREMENTS = ['mutagen', 'pycryptodome']
 
+def packages():
+    if setuptools_available:
+        return find_packages(exclude=('youtube_dl', 'youtube_dlc', 'test', 'ytdlp_plugins'))
+
+    return [
+        'yt_dlp', 'yt_dlp.extractor', 'yt_dlp.downloader', 'yt_dlp.postprocessor', 'yt_dlp.compat',
+        'yt_dlp.extractor.anvato_token_generator',
+    ]
 
-if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
-    print('inv')
-else:
+
+def py2exe_params():
+    import py2exe  # noqa: F401
+
+    warnings.warn(
+        'py2exe builds do not support pycryptodomex and needs VC++14 to run. '
+        'The recommended way is to use "pyinst.py" to build using pyinstaller')
+
+    return {
+        'console': [{
+            'script': './yt_dlp/__main__.py',
+            'dest_base': 'yt-dlp',
+            'version': VERSION,
+            'description': DESCRIPTION,
+            'comments': LONG_DESCRIPTION.split('\n')[0],
+            'product_name': 'yt-dlp',
+            'product_version': VERSION,
+            'icon_resources': [(1, 'devscripts/logo.ico')],
+        }],
+        'options': {
+            'py2exe': {
+                'bundle_files': 0,
+                'compressed': 1,
+                'optimize': 2,
+                'dist_dir': './dist',
+                'excludes': ['Crypto', 'Cryptodome'],  # py2exe cannot import Crypto
+                'dll_excludes': ['w9xpopen.exe', 'crypt32.dll'],
+                # Modules that are only imported dynamically must be added here
+                'includes': ['yt_dlp.compat._legacy'],
+            }
+        },
+        'zipfile': None
+    }
+
+
+def build_params():
     files_spec = [
         ('share/bash-completion/completions', ['completions/bash/yt-dlp']),
         ('share/zsh/site-functions', ['completions/zsh/_yt-dlp']),
         ('share/doc/yt_dlp', ['README.txt']),
         ('share/man/man1', ['yt-dlp.1'])
     ]
-    root = os.path.dirname(os.path.abspath(__file__))
     data_files = []
     for dirname, files in files_spec:
         resfiles = []
         for fn in files:
             if not os.path.exists(fn):
-                warnings.warn('Skipping file %s since it is not present. Try running `make pypi-files` first.' % fn)
+                warnings.warn(f'Skipping file {fn} since it is not present. Try running " make pypi-files " first')
             else:
                 resfiles.append(fn)
         data_files.append((dirname, resfiles))
 
-    params = {
-        'data_files': data_files,
-    }
-    params['entry_points'] = {'console_scripts': ['yt-dlp = yt_dlp:main']}
+    params = {'data_files': data_files}
+
+    if setuptools_available:
+        params['entry_points'] = {'console_scripts': ['yt-dlp = yt_dlp:main']}
+    else:
+        params['scripts'] = ['yt-dlp']
+    return params
 
 
 class build_lazy_extractors(Command):
@@ -61,57 +118,48 @@ def finalize_options(self):
         pass
 
     def run(self):
-        spawn(
-            [sys.executable, 'devscripts/make_lazy_extractors.py', 'yt_dlp/extractor/lazy_extractors.py'],
-            dry_run=self.dry_run,
-        )
+        if self.dry_run:
+            print('Skipping build of lazy extractors in dry run mode')
+            return
+        subprocess.run([sys.executable, 'devscripts/make_lazy_extractors.py', 'yt_dlp/extractor/lazy_extractors.py'])
 
 
-packages = find_packages(exclude=('youtube_dl', 'test', 'ytdlp_plugins'))
-
+params = py2exe_params() if sys.argv[1:2] == ['py2exe'] else build_params()
 setup(
     name='yt-dlp',
-    version=__version__,
+    version=VERSION,
     maintainer='pukkandan',
     maintainer_email='pukkandan.ytdlp@gmail.com',
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     long_description_content_type='text/markdown',
     url='https://github.com/yt-dlp/yt-dlp',
-    packages=packages,
+    packages=packages(),
     install_requires=REQUIREMENTS,
+    python_requires='>=3.6',
     project_urls={
-        'Documentation': 'https://yt-dlp.readthedocs.io',
+        'Documentation': 'https://github.com/yt-dlp/yt-dlp#readme',
         'Source': 'https://github.com/yt-dlp/yt-dlp',
         'Tracker': 'https://github.com/yt-dlp/yt-dlp/issues',
-        #'Funding': 'https://donate.pypi.org',
+        'Funding': 'https://github.com/yt-dlp/yt-dlp/blob/master/Collaborators.md#collaborators',
     },
     classifiers=[
         'Topic :: Multimedia :: Video',
         'Development Status :: 5 - Production/Stable',
         'Environment :: Console',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: Implementation',
         'Programming Language :: Python :: Implementation :: CPython',
-        'Programming Language :: Python :: Implementation :: IronPython',
-        'Programming Language :: Python :: Implementation :: Jython',
         'Programming Language :: Python :: Implementation :: PyPy',
         'License :: Public Domain',
         'Operating System :: OS Independent',
     ],
-    python_requires='>=2.6',
-
     cmdclass={'build_lazy_extractors': build_lazy_extractors},
     **params
 )