]> jfr.im git - yt-dlp.git/blobdiff - setup.py
[extractor/anvato] Fix extractor and refactor (#5074)
[yt-dlp.git] / setup.py
index c1e923f71fc83717180ee0e356416d1ce4c7c64b..3641dfae952e16f791417eaab02c9b81cc8fed27 100644 (file)
--- a/setup.py
+++ b/setup.py
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import print_function
+#!/usr/bin/env python3
 
 import os.path
-import warnings
+import subprocess
 import sys
+import warnings
 
 try:
-    from setuptools import setup, Command
+    from setuptools import Command, find_packages, setup
     setuptools_available = True
 except ImportError:
-    from distutils.core import setup, Command
+    from distutils.core import Command, setup
     setuptools_available = False
-from distutils.spawn import spawn
 
-try:
-    # This will create an exe that needs Microsoft Visual C++ 2008
-    # Redistributable Package
-    import py2exe
-except ImportError:
-    if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
-        print("Cannot import py2exe", file=sys.stderr)
-        exit(1)
-
-py2exe_options = {
-    "bundle_files": 1,
-    "compressed": 1,
-    "optimize": 2,
-    "dist_dir": '.',
-    "dll_excludes": ['w9xpopen.exe', 'crypt32.dll'],
-}
-
-py2exe_console = [{
-    "script": "./youtube_dl/__main__.py",
-    "dest_base": "youtube-dl",
-}]
-
-py2exe_params = {
-    'console': py2exe_console,
-    'options': {"py2exe": py2exe_options},
-    'zipfile': None
-}
-
-if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
-    params = py2exe_params
-else:
+from devscripts.utils import read_file, read_version
+
+VERSION = read_version()
+
+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**: Some links in this document will not work since this is a copy of the README.md from Github',
+    read_file('README.md')))
+
+REQUIREMENTS = read_file('requirements.txt').splitlines()
+
+
+def packages():
+    if setuptools_available:
+        return find_packages(exclude=('youtube_dl', 'youtube_dlc', 'test', 'ytdlp_plugins', 'devscripts'))
+
+    return [
+        'yt_dlp', 'yt_dlp.extractor', 'yt_dlp.downloader', 'yt_dlp.postprocessor', 'yt_dlp.compat',
+    ]
+
+
+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 = [
-        ('etc/bash_completion.d', ['youtube-dl.bash-completion']),
-        ('etc/fish/completions', ['youtube-dl.fish']),
-        ('share/doc/youtube_dl', ['README.txt']),
-        ('share/man/man1', ['youtube-dl.1'])
+        ('share/bash-completion/completions', ['completions/bash/yt-dlp']),
+        ('share/zsh/site-functions', ['completions/zsh/_yt-dlp']),
+        ('share/fish/vendor_completions.d', ['completions/fish/yt-dlp.fish']),
+        ('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. Type  make  to build all automatically generated files.' % 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 = {'data_files': data_files}
+
     if setuptools_available:
-        params['entry_points'] = {'console_scripts': ['youtube-dl = youtube_dl:main']}
+        params['entry_points'] = {'console_scripts': ['yt-dlp = yt_dlp:main']}
     else:
-        params['scripts'] = ['bin/youtube-dl']
+        params['scripts'] = ['yt-dlp']
+    return params
+
 
 class build_lazy_extractors(Command):
-    description = "Build the extractor lazy loading module"
+    description = 'Build the extractor lazy loading module'
     user_options = []
 
     def initialize_options(self):
@@ -82,49 +107,47 @@ def finalize_options(self):
         pass
 
     def run(self):
-        spawn(
-            [sys.executable, 'devscripts/make_lazy_extractors.py', 'youtube_dl/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'])
 
-# Get the version from youtube_dl/version.py without importing the package
-exec(compile(open('youtube_dl/version.py').read(),
-             'youtube_dl/version.py', 'exec'))
 
+params = py2exe_params() if sys.argv[1:2] == ['py2exe'] else build_params()
 setup(
-    name='youtube_dl',
-    version=__version__,
-    description='YouTube video downloader',
-    long_description='Small command-line program to download videos from'
-    ' YouTube.com and other video sites.',
-    url='https://github.com/rg3/youtube-dl',
-    author='Ricardo Garcia',
-    author_email='ytdl@yt-dl.org',
-    maintainer='Philipp Hagemeister',
-    maintainer_email='phihag@phihag.de',
-    packages=[
-        'youtube_dl',
-        'youtube_dl.extractor', 'youtube_dl.downloader',
-        'youtube_dl.postprocessor'],
-
-    # Provokes warning on most systems (why?!)
-    # test_suite = 'nose.collector',
-    # test_requires = ['nosetest'],
-
+    name='yt-dlp',
+    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(),
+    install_requires=REQUIREMENTS,
+    python_requires='>=3.7',
+    project_urls={
+        '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://github.com/yt-dlp/yt-dlp/blob/master/Collaborators.md#collaborators',
+    },
     classifiers=[
-        "Topic :: Multimedia :: Video",
-        "Development Status :: 5 - Production/Stable",
-        "Environment :: Console",
-        "License :: Public Domain",
-        "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",
+        'Topic :: Multimedia :: Video',
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Programming Language :: Python',
+        '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 :: PyPy',
+        'License :: Public Domain',
+        'Operating System :: OS Independent',
     ],
-
     cmdclass={'build_lazy_extractors': build_lazy_extractors},
     **params
 )