]> jfr.im git - yt-dlp.git/blobdiff - setup.py
[build] Move bundle scripts into `bundle` submodule
[yt-dlp.git] / setup.py
index 7cc2bff4837742e49a548b0fc5aee64960e2ddb2..fc5b504683a805d3feb67bfb854b5b3612468d3f 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,47 +1,71 @@
-#!/usr/bin/env python
-# coding: utf-8
+#!/usr/bin/env python3
 
-from setuptools import setup, Command, find_packages
-import os.path
-import warnings
+# Allow execution from anywhere
+import os
 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'))
+sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
 
-DESCRIPTION = 'Command-line program to download videos from YouTube.com and many other other video platforms.'
+import subprocess
+
+try:
+    from setuptools import Command, find_packages, setup
+    setuptools_available = True
+except ImportError:
+    from distutils.core import Command, setup
+    setuptools_available = False
+
+from devscripts.utils import read_file, read_version
+
+VERSION = read_version(varname='_pkg_version')
+
+DESCRIPTION = 'A youtube-dl fork with additional features and patches'
 
 LONG_DESCRIPTION = '\n\n'.join((
-    'Official repository: <https://github.com/pukkandan/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()))
+    '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')))
 
-if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
-    print("inv")
-else:
+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 build_params():
     files_spec = [
-        ('etc/bash_completion.d', ['youtube-dlc.bash-completion']),
-        ('etc/fish/completions', ['youtube-dlc.fish']),
-        ('share/doc/youtube_dlc', ['README.txt']),
-        ('share/man/man1', ['youtube-dlc.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['entry_points'] = {'console_scripts': ['youtube-dlc = youtube_dlc:main']}
+    params = {'data_files': data_files}
+
+    if setuptools_available:
+        params['entry_points'] = {
+            'console_scripts': ['yt-dlp = yt_dlp:main'],
+            'pyinstaller40': ['hook-dirs = yt_dlp.__pyinstaller:get_hook_dirs'],
+        }
+    else:
+        params['scripts'] = ['yt-dlp']
+    return params
 
 
 class build_lazy_extractors(Command):
@@ -55,56 +79,51 @@ def finalize_options(self):
         pass
 
     def run(self):
-        spawn(
-            [sys.executable, 'devscripts/make_lazy_extractors.py', 'youtube_dlc/extractor/lazy_extractors.py'],
-            dry_run=self.dry_run,
-        )
-
-
-packages = find_packages(exclude=("youtube_dl","test",))
-
-setup(
-    name="yt-dlp",
-    version=__version__,
-    maintainer="pukkandan",
-    maintainer_email="pukkandan@gmail.com",
-    description=DESCRIPTION,
-    long_description=LONG_DESCRIPTION,
-    long_description_content_type="text/markdown",
-    url="https://github.com/pukkandan/yt-dlp",
-    packages=packages,
-    project_urls={
-        'Documentation': 'https://github.com/pukkandan/yt-dlp#yt-dlp',
-        'Source': 'https://github.com/pukkandan/yt-dlp',
-        'Tracker': 'https://github.com/pukkandan/yt-dlp/issues',
-        #'Funding': 'https://donate.pypi.org',
-    },
-    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 :: 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
-)
+        if self.dry_run:
+            print('Skipping build of lazy extractors in dry run mode')
+            return
+        subprocess.run([sys.executable, 'devscripts/make_lazy_extractors.py'])
+
+
+def main():
+    params = build_params()
+    setup(
+        name='yt-dlp',  # package name (do not change/remove comment)
+        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.8',
+        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',
+            'Programming Language :: Python',
+            'Programming Language :: Python :: 3.8',
+            'Programming Language :: Python :: 3.9',
+            'Programming Language :: Python :: 3.10',
+            'Programming Language :: Python :: 3.11',
+            'Programming Language :: Python :: 3.12',
+            '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
+    )
+
+
+main()