]> jfr.im git - yt-dlp.git/blobdiff - Makefile
[misc] Cleanup (#9765)
[yt-dlp.git] / Makefile
index 368c835859246fdce5887709f314ae981d2880d9..e1de7f3e91a7bf041e8c340255fb576a3169ab6a 100644 (file)
--- a/Makefile
+++ b/Makefile
-all: youtube-dlc README.md CONTRIBUTING.md README.txt issuetemplates youtube-dlc.1 youtube-dlc.bash-completion youtube-dlc.zsh youtube-dlc.fish supportedsites
-doc: README.md CONTRIBUTING.md issuetemplates supportedsites
-
-clean:
-       rm -rf youtube-dlc.1.temp.md youtube-dlc.1 youtube-dlc.bash-completion README.txt MANIFEST build/ dist/ .coverage cover/ youtube-dlc.tar.gz youtube-dlc.zsh youtube-dlc.fish youtube_dlc/extractor/lazy_extractors.py *.dump *.part* *.ytdl *.info.json *.mp4 *.m4a *.flv *.mp3 *.avi *.mkv *.webm *.3gp *.wav *.ape *.swf *.jpg *.png CONTRIBUTING.md.tmp youtube-dlc youtube-dlc.exe
-       find . -name "*.pyc" -delete
-       find . -name "*.class" -delete
+all: lazy-extractors yt-dlp doc pypi-files
+clean: clean-test clean-dist
+clean-all: clean clean-cache
+completions: completion-bash completion-fish completion-zsh
+doc: README.md CONTRIBUTING.md CONTRIBUTORS issuetemplates supportedsites
+ot: offlinetest
+tar: yt-dlp.tar.gz
+
+# Keep this list in sync with pyproject.toml includes/artifacts
+# intended use: when building a source distribution,
+# make pypi-files && python3 -m build -sn .
+pypi-files: AUTHORS Changelog.md LICENSE README.md README.txt supportedsites \
+            completions yt-dlp.1 pyproject.toml setup.cfg devscripts/* test/*
+
+.PHONY: all clean clean-all clean-test clean-dist clean-cache \
+        completions completion-bash completion-fish completion-zsh \
+        doc issuetemplates supportedsites ot offlinetest codetest test \
+        tar pypi-files lazy-extractors install uninstall
+
+clean-test:
+       rm -rf test/testdata/sigs/player-*.js tmp/ *.annotations.xml *.aria2 *.description *.dump *.frag \
+       *.frag.aria2 *.frag.urls *.info.json *.live_chat.json *.meta *.part* *.tmp *.temp *.unknown_video *.ytdl \
+       *.3gp *.ape *.ass *.avi *.desktop *.f4v *.flac *.flv *.gif *.jpeg *.jpg *.lrc *.m4a *.m4v *.mhtml *.mkv *.mov *.mp3 *.mp4 \
+       *.mpg *.mpga *.oga *.ogg *.opus *.png *.sbv *.srt *.ssa *.swf *.swp *.tt *.ttml *.url *.vtt *.wav *.webloc *.webm *.webp
+clean-dist:
+       rm -rf yt-dlp.1.temp.md yt-dlp.1 README.txt MANIFEST build/ dist/ .coverage cover/ yt-dlp.tar.gz completions/ \
+       yt_dlp/extractor/lazy_extractors.py *.spec CONTRIBUTING.md.tmp yt-dlp yt-dlp.exe yt_dlp.egg-info/ AUTHORS
+clean-cache:
+       find . \( \
+               -type d -name ".*_cache" -o -type d -name __pycache__ -o -name "*.pyc" -o -name "*.class" \
+       \) -prune -exec rm -rf {} \;
+
+completion-bash: completions/bash/yt-dlp
+completion-fish: completions/fish/yt-dlp.fish
+completion-zsh: completions/zsh/_yt-dlp
+lazy-extractors: yt_dlp/extractor/lazy_extractors.py
 
 PREFIX ?= /usr/local
 BINDIR ?= $(PREFIX)/bin
 MANDIR ?= $(PREFIX)/man
 SHAREDIR ?= $(PREFIX)/share
-PYTHON ?= /usr/bin/env python
-
-# set SYSCONFDIR to /etc if PREFIX=/usr or PREFIX=/usr/local
-SYSCONFDIR = $(shell if [ $(PREFIX) = /usr -o $(PREFIX) = /usr/local ]; then echo /etc; else echo $(PREFIX)/etc; fi)
-
-# 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: youtube-dlc youtube-dlc.1 youtube-dlc.bash-completion youtube-dlc.zsh youtube-dlc.fish
-       install -d $(DESTDIR)$(BINDIR)
-       install -m 755 youtube-dlc $(DESTDIR)$(BINDIR)
-       install -d $(DESTDIR)$(MANDIR)/man1
-       install -m 644 youtube-dlc.1 $(DESTDIR)$(MANDIR)/man1
-       install -d $(DESTDIR)$(SYSCONFDIR)/bash_completion.d
-       install -m 644 youtube-dlc.bash-completion $(DESTDIR)$(SYSCONFDIR)/bash_completion.d/youtube-dlc
-       install -d $(DESTDIR)$(SHAREDIR)/zsh/site-functions
-       install -m 644 youtube-dlc.zsh $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_youtube-dlc
-       install -d $(DESTDIR)$(SYSCONFDIR)/fish/completions
-       install -m 644 youtube-dlc.fish $(DESTDIR)$(SYSCONFDIR)/fish/completions/youtube-dlc.fish
+PYTHON ?= /usr/bin/env python3
+GNUTAR ?= tar
+
+# set markdown input format to "markdown-smart" for pandoc version 2+ and to "markdown" for pandoc prior to version 2
+PANDOC_VERSION_CMD = pandoc -v 2>/dev/null | head -n1 | cut -d' ' -f2 | head -c1
+PANDOC_VERSION != $(PANDOC_VERSION_CMD)
+PANDOC_VERSION ?= $(shell $(PANDOC_VERSION_CMD))
+MARKDOWN_CMD = if [ "$(PANDOC_VERSION)" = "1" -o "$(PANDOC_VERSION)" = "0" ]; then echo markdown; else echo markdown-smart; fi
+MARKDOWN != $(MARKDOWN_CMD)
+MARKDOWN ?= $(shell $(MARKDOWN_CMD))
+
+install: lazy-extractors yt-dlp yt-dlp.1 completions
+       mkdir -p $(DESTDIR)$(BINDIR)
+       install -m755 yt-dlp $(DESTDIR)$(BINDIR)/yt-dlp
+       mkdir -p $(DESTDIR)$(MANDIR)/man1
+       install -m644 yt-dlp.1 $(DESTDIR)$(MANDIR)/man1/yt-dlp.1
+       mkdir -p $(DESTDIR)$(SHAREDIR)/bash-completion/completions
+       install -m644 completions/bash/yt-dlp $(DESTDIR)$(SHAREDIR)/bash-completion/completions/yt-dlp
+       mkdir -p $(DESTDIR)$(SHAREDIR)/zsh/site-functions
+       install -m644 completions/zsh/_yt-dlp $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_yt-dlp
+       mkdir -p $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d
+       install -m644 completions/fish/yt-dlp.fish $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d/yt-dlp.fish
+
+uninstall:
+       rm -f $(DESTDIR)$(BINDIR)/yt-dlp
+       rm -f $(DESTDIR)$(MANDIR)/man1/yt-dlp.1
+       rm -f $(DESTDIR)$(SHAREDIR)/bash-completion/completions/yt-dlp
+       rm -f $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_yt-dlp
+       rm -f $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d/yt-dlp.fish
 
 codetest:
-       flake8 .
+       ruff check .
+       autopep8 --diff .
 
 test:
-       #nosetests --with-coverage --cover-package=youtube_dlc --cover-html --verbose --processes 4 test
-       nosetests --verbose test
+       $(PYTHON) -m pytest -Werror
        $(MAKE) codetest
 
-ot: offlinetest
-
-# Keep this list in sync with devscripts/run_tests.sh
 offlinetest: codetest
-       $(PYTHON) -m nose --verbose test \
-               --exclude test_age_restriction.py \
-               --exclude test_download.py \
-               --exclude test_iqiyi_sdk_interpreter.py \
-               --exclude test_socks.py \
-               --exclude test_subtitles.py \
-               --exclude test_write_annotations.py \
-               --exclude test_youtube_lists.py \
-               --exclude test_youtube_signature.py \
-               --exclude test_post_hooks.py
-
-tar: youtube-dlc.tar.gz
-
-.PHONY: all clean install test tar bash-completion pypi-files zsh-completion fish-completion ot offlinetest codetest supportedsites
-
-pypi-files: youtube-dlc.bash-completion README.txt youtube-dlc.1 youtube-dlc.fish
-
-youtube-dlc: youtube_dlc/*.py youtube_dlc/*/*.py
+       $(PYTHON) -m pytest -Werror -m "not download"
+
+CODE_FOLDERS_CMD = find yt_dlp -type f -name '__init__.py' | sed 's,/__init__.py,,' | grep -v '/__' | sort
+CODE_FOLDERS != $(CODE_FOLDERS_CMD)
+CODE_FOLDERS ?= $(shell $(CODE_FOLDERS_CMD))
+CODE_FILES_CMD = for f in $(CODE_FOLDERS) ; do echo "$$f" | sed 's,$$,/*.py,' ; done
+CODE_FILES != $(CODE_FILES_CMD)
+CODE_FILES ?= $(shell $(CODE_FILES_CMD))
+yt-dlp: $(CODE_FILES)
        mkdir -p zip
-       for d in youtube_dlc youtube_dlc/downloader youtube_dlc/extractor youtube_dlc/postprocessor ; do \
+       for d in $(CODE_FOLDERS) ; do \
          mkdir -p zip/$$d ;\
          cp -pPR $$d/*.py zip/$$d/ ;\
        done
-       touch -t 200001010101 zip/youtube_dlc/*.py zip/youtube_dlc/*/*.py
-       mv zip/youtube_dlc/__main__.py zip/
-       cd zip ; zip -q ../youtube-dlc youtube_dlc/*.py youtube_dlc/*/*.py __main__.py
+       (cd zip && touch -t 200001010101 $(CODE_FILES))
+       mv zip/yt_dlp/__main__.py zip/
+       (cd zip && zip -q ../yt-dlp $(CODE_FILES) __main__.py)
        rm -rf zip
-       echo '#!$(PYTHON)' > youtube-dlc
-       cat youtube-dlc.zip >> youtube-dlc
-       rm youtube-dlc.zip
-       chmod a+x youtube-dlc
+       echo '#!$(PYTHON)' > yt-dlp
+       cat yt-dlp.zip >> yt-dlp
+       rm yt-dlp.zip
+       chmod a+x yt-dlp
 
-README.md: youtube_dlc/*.py youtube_dlc/*/*.py
-       COLUMNS=80 $(PYTHON) youtube_dlc/__main__.py --help | $(PYTHON) devscripts/make_readme.py
+README.md: $(CODE_FILES) devscripts/make_readme.py
+       COLUMNS=80 $(PYTHON) yt_dlp/__main__.py --ignore-config --help | $(PYTHON) devscripts/make_readme.py
 
-CONTRIBUTING.md: README.md
+CONTRIBUTING.md: README.md devscripts/make_contributing.py
        $(PYTHON) devscripts/make_contributing.py README.md CONTRIBUTING.md
 
-issuetemplates: devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/1_broken_site.md .github/ISSUE_TEMPLATE_tmpl/2_site_support_request.md .github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.md .github/ISSUE_TEMPLATE_tmpl/4_bug_report.md .github/ISSUE_TEMPLATE_tmpl/5_feature_request.md youtube_dlc/version.py
-       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/1_broken_site.md .github/ISSUE_TEMPLATE/1_broken_site.md
-       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/2_site_support_request.md .github/ISSUE_TEMPLATE/2_site_support_request.md
-       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.md .github/ISSUE_TEMPLATE/3_site_feature_request.md
-       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/4_bug_report.md .github/ISSUE_TEMPLATE/4_bug_report.md
-       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/5_feature_request.md .github/ISSUE_TEMPLATE/5_feature_request.md
+issuetemplates: devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml .github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml .github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml .github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml .github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml yt_dlp/version.py
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml .github/ISSUE_TEMPLATE/1_broken_site.yml
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml .github/ISSUE_TEMPLATE/2_site_support_request.yml
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml .github/ISSUE_TEMPLATE/3_site_feature_request.yml
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml .github/ISSUE_TEMPLATE/4_bug_report.yml
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml .github/ISSUE_TEMPLATE/5_feature_request.yml
+       $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/6_question.yml .github/ISSUE_TEMPLATE/6_question.yml
 
 supportedsites:
-       $(PYTHON) devscripts/make_supportedsites.py docs/supportedsites.md
+       $(PYTHON) devscripts/make_supportedsites.py supportedsites.md
 
 README.txt: README.md
        pandoc -f $(MARKDOWN) -t plain README.md -o README.txt
 
-youtube-dlc.1: README.md
-       $(PYTHON) devscripts/prepare_manpage.py youtube-dlc.1.temp.md
-       pandoc -s -f $(MARKDOWN) -t man youtube-dlc.1.temp.md -o youtube-dlc.1
-       rm -f youtube-dlc.1.temp.md
+yt-dlp.1: README.md devscripts/prepare_manpage.py
+       $(PYTHON) devscripts/prepare_manpage.py yt-dlp.1.temp.md
+       pandoc -s -f $(MARKDOWN) -t man yt-dlp.1.temp.md -o yt-dlp.1
+       rm -f yt-dlp.1.temp.md
 
-youtube-dlc.bash-completion: youtube_dlc/*.py youtube_dlc/*/*.py devscripts/bash-completion.in
+completions/bash/yt-dlp: $(CODE_FILES) devscripts/bash-completion.in
+       mkdir -p completions/bash
        $(PYTHON) devscripts/bash-completion.py
 
-bash-completion: youtube-dlc.bash-completion
-
-youtube-dlc.zsh: youtube_dlc/*.py youtube_dlc/*/*.py devscripts/zsh-completion.in
+completions/zsh/_yt-dlp: $(CODE_FILES) devscripts/zsh-completion.in
+       mkdir -p completions/zsh
        $(PYTHON) devscripts/zsh-completion.py
 
-zsh-completion: youtube-dlc.zsh
-
-youtube-dlc.fish: youtube_dlc/*.py youtube_dlc/*/*.py devscripts/fish-completion.in
+completions/fish/yt-dlp.fish: $(CODE_FILES) devscripts/fish-completion.in
+       mkdir -p completions/fish
        $(PYTHON) devscripts/fish-completion.py
 
-fish-completion: youtube-dlc.fish
-
-lazy-extractors: youtube_dlc/extractor/lazy_extractors.py
-
-_EXTRACTOR_FILES = $(shell find youtube_dlc/extractor -iname '*.py' -and -not -iname 'lazy_extractors.py')
-youtube_dlc/extractor/lazy_extractors.py: devscripts/make_lazy_extractors.py devscripts/lazy_load_template.py $(_EXTRACTOR_FILES)
+_EXTRACTOR_FILES_CMD = find yt_dlp/extractor -name '*.py' -and -not -name 'lazy_extractors.py'
+_EXTRACTOR_FILES != $(_EXTRACTOR_FILES_CMD)
+_EXTRACTOR_FILES ?= $(shell $(_EXTRACTOR_FILES_CMD))
+yt_dlp/extractor/lazy_extractors.py: devscripts/make_lazy_extractors.py devscripts/lazy_load_template.py $(_EXTRACTOR_FILES)
        $(PYTHON) devscripts/make_lazy_extractors.py $@
 
-youtube-dlc.tar.gz: youtube-dlc README.md README.txt youtube-dlc.1 youtube-dlc.bash-completion youtube-dlc.zsh youtube-dlc.fish ChangeLog AUTHORS
-       @tar -czf youtube-dlc.tar.gz --transform "s|^|youtube-dlc/|" --owner 0 --group 0 \
+yt-dlp.tar.gz: all
+       @$(GNUTAR) -czf yt-dlp.tar.gz --transform "s|^|yt-dlp/|" --owner 0 --group 0 \
                --exclude '*.DS_Store' \
                --exclude '*.kate-swp' \
                --exclude '*.pyc' \
                --exclude '*.pyo' \
                --exclude '*~' \
                --exclude '__pycache__' \
+               --exclude '.*_cache' \
                --exclude '.git' \
-               --exclude 'docs/_build' \
                -- \
-               bin devscripts test youtube_dlc docs \
-               ChangeLog AUTHORS LICENSE README.md README.txt \
-               Makefile MANIFEST.in youtube-dlc.1 youtube-dlc.bash-completion \
-               youtube-dlc.zsh youtube-dlc.fish setup.py setup.cfg \
-               youtube-dlc
+               README.md supportedsites.md Changelog.md LICENSE \
+               CONTRIBUTING.md Collaborators.md CONTRIBUTORS AUTHORS \
+               Makefile yt-dlp.1 README.txt completions .gitignore \
+               setup.cfg yt-dlp yt_dlp pyproject.toml devscripts test
+
+AUTHORS: Changelog.md
+       @if [ -d '.git' ] && command -v git > /dev/null ; then \
+         echo 'Generating $@ from git commit history' ; \
+         git shortlog -s -n HEAD | cut -f2 | sort > $@ ; \
+       fi
+
+CONTRIBUTORS: Changelog.md
+       @if [ -d '.git' ] && command -v git > /dev/null ; then \
+         echo 'Updating $@ from git commit history' ; \
+         $(PYTHON) devscripts/make_changelog.py -v -c > /dev/null ; \
+       fi