Makefile

   1 all: lazy-extractors yt-dlp doc pypi-files
   2 clean: clean-test clean-dist
   3 clean-all: clean clean-cache
   4 completions: completion-bash completion-fish completion-zsh
   5 doc: README.md CONTRIBUTING.md issuetemplates supportedsites
   6 ot: offlinetest
   7 tar: yt-dlp.tar.gz
   8
   9 # Keep this list in sync with MANIFEST.in
  10 # intended use: when building a source distribution,
  11 # make pypi-files && python setup.py sdist
  12 pypi-files: AUTHORS Changelog.md LICENSE README.md README.txt supportedsites completions yt-dlp.1 devscripts/* test/*
  13
  14 .PHONY: all clean install test tar pypi-files completions ot offlinetest codetest supportedsites
  15
  16 clean-test:
  17         rm -rf test/testdata/sigs/player-*.js tmp/ *.annotations.xml *.aria2 *.description *.dump *.frag \
  18         *.frag.aria2 *.frag.urls *.info.json *.live_chat.json *.meta *.part* *.tmp *.temp *.unknown_video *.ytdl \
  19         *.3gp *.ape *.ass *.avi *.desktop *.flac *.flv *.jpeg *.jpg *.m4a *.m4v *.mhtml *.mkv *.mov *.mp3 \
  20         *.mp4 *.ogg *.opus *.png *.sbv *.srt *.swf *.swp *.ttml *.url *.vtt *.wav *.webloc *.webm *.webp
  21 clean-dist:
  22         rm -rf yt-dlp.1.temp.md yt-dlp.1 README.txt MANIFEST build/ dist/ .coverage cover/ yt-dlp.tar.gz completions/ \
  23         yt_dlp/extractor/lazy_extractors.py *.spec CONTRIBUTING.md.tmp yt-dlp yt-dlp.exe yt_dlp.egg-info/ AUTHORS .mailmap
  24 clean-cache:
  25         find . \( \
  26                 -type d -name .pytest_cache -o -type d -name __pycache__ -o -name "*.pyc" -o -name "*.class" \
  27         \) -prune -exec rm -rf {} \;
  28
  29 completion-bash: completions/bash/yt-dlp
  30 completion-fish: completions/fish/yt-dlp.fish
  31 completion-zsh: completions/zsh/_yt-dlp
  32 lazy-extractors: yt_dlp/extractor/lazy_extractors.py
  33
  34 PREFIX ?= /usr/local
  35 DESTDIR ?= .
  36 BINDIR ?= $(PREFIX)/bin
  37 MANDIR ?= $(PREFIX)/man
  38 SHAREDIR ?= $(PREFIX)/share
  39 PYTHON ?= /usr/bin/env python3
  40
  41 # set SYSCONFDIR to /etc if PREFIX=/usr or PREFIX=/usr/local
  42 SYSCONFDIR = $(shell if [ $(PREFIX) = /usr -o $(PREFIX) = /usr/local ]; then echo /etc; else echo $(PREFIX)/etc; fi)
  43
  44 # set markdown input format to "markdown-smart" for pandoc version 2 and to "markdown" for pandoc prior to version 2
  45 MARKDOWN = $(shell if [ "$(pandoc -v | head -n1 | cut -d" " -f2 | head -c1)" = "2" ]; then echo markdown-smart; else echo markdown; fi)
  46
  47 install: lazy-extractors yt-dlp yt-dlp.1 completions
  48         mkdir -p $(DESTDIR)$(BINDIR)
  49         install -m755 yt-dlp $(DESTDIR)$(BINDIR)/yt-dlp
  50         mkdir -p $(DESTDIR)$(MANDIR)/man1
  51         install -m644 yt-dlp.1 $(DESTDIR)$(MANDIR)/man1/yt-dlp.1
  52         mkdir -p $(DESTDIR)$(SHAREDIR)/bash-completion/completions
  53         install -m644 completions/bash/yt-dlp $(DESTDIR)$(SHAREDIR)/bash-completion/completions/yt-dlp
  54         mkdir -p $(DESTDIR)$(SHAREDIR)/zsh/site-functions
  55         install -m644 completions/zsh/_yt-dlp $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_yt-dlp
  56         mkdir -p $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d
  57         install -m644 completions/fish/yt-dlp.fish $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d/yt-dlp.fish
  58
  59 uninstall:
  60         rm -f $(DESTDIR)$(BINDIR)/yt-dlp
  61         rm -f $(DESTDIR)$(MANDIR)/man1/yt-dlp.1
  62         rm -f $(DESTDIR)$(SHAREDIR)/bash-completion/completions/yt-dlp
  63         rm -f $(DESTDIR)$(SHAREDIR)/zsh/site-functions/_yt-dlp
  64         rm -f $(DESTDIR)$(SHAREDIR)/fish/vendor_completions.d/yt-dlp.fish
  65
  66 codetest:
  67         flake8 .
  68
  69 test:
  70         $(PYTHON) -m pytest
  71         $(MAKE) codetest
  72
  73 offlinetest: codetest
  74         $(PYTHON) -m pytest -k "not download"
  75
  76 # XXX: This is hard to maintain
  77 CODE_FOLDERS = yt_dlp yt_dlp/downloader yt_dlp/extractor yt_dlp/postprocessor yt_dlp/compat \
  78                yt_dlp/extractor/anvato_token_generator
  79 yt-dlp: yt_dlp/*.py yt_dlp/*/*.py
  80         mkdir -p zip
  81         for d in $(CODE_FOLDERS) ; do \
  82           mkdir -p zip/$$d ;\
  83           cp -pPR $$d/*.py zip/$$d/ ;\
  84         done
  85         touch -t 200001010101 zip/yt_dlp/*.py zip/yt_dlp/*/*.py zip/yt_dlp/*/*/*.py
  86         mv zip/yt_dlp/__main__.py zip/
  87         cd zip ; zip -q ../yt-dlp yt_dlp/*.py yt_dlp/*/*.py yt_dlp/*/*/*.py __main__.py
  88         rm -rf zip
  89         echo '#!$(PYTHON)' > yt-dlp
  90         cat yt-dlp.zip >> yt-dlp
  91         rm yt-dlp.zip
  92         chmod a+x yt-dlp
  93
  94 README.md: yt_dlp/*.py yt_dlp/*/*.py
  95         COLUMNS=80 $(PYTHON) yt_dlp/__main__.py --ignore-config --help | $(PYTHON) devscripts/make_readme.py
  96
  97 CONTRIBUTING.md: README.md
  98         $(PYTHON) devscripts/make_contributing.py README.md CONTRIBUTING.md
  99
 100 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
 101         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml .github/ISSUE_TEMPLATE/1_broken_site.yml
 102         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml .github/ISSUE_TEMPLATE/2_site_support_request.yml
 103         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml .github/ISSUE_TEMPLATE/3_site_feature_request.yml
 104         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml .github/ISSUE_TEMPLATE/4_bug_report.yml
 105         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml .github/ISSUE_TEMPLATE/5_feature_request.yml
 106         $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE_tmpl/6_question.yml .github/ISSUE_TEMPLATE/6_question.yml
 107
 108 supportedsites:
 109         $(PYTHON) devscripts/make_supportedsites.py supportedsites.md
 110
 111 README.txt: README.md
 112         pandoc -f $(MARKDOWN) -t plain README.md -o README.txt
 113
 114 yt-dlp.1: README.md
 115         $(PYTHON) devscripts/prepare_manpage.py yt-dlp.1.temp.md
 116         pandoc -s -f $(MARKDOWN) -t man yt-dlp.1.temp.md -o yt-dlp.1
 117         rm -f yt-dlp.1.temp.md
 118
 119 completions/bash/yt-dlp: yt_dlp/*.py yt_dlp/*/*.py devscripts/bash-completion.in
 120         mkdir -p completions/bash
 121         $(PYTHON) devscripts/bash-completion.py
 122
 123 completions/zsh/_yt-dlp: yt_dlp/*.py yt_dlp/*/*.py devscripts/zsh-completion.in
 124         mkdir -p completions/zsh
 125         $(PYTHON) devscripts/zsh-completion.py
 126
 127 completions/fish/yt-dlp.fish: yt_dlp/*.py yt_dlp/*/*.py devscripts/fish-completion.in
 128         mkdir -p completions/fish
 129         $(PYTHON) devscripts/fish-completion.py
 130
 131 _EXTRACTOR_FILES = $(shell find yt_dlp/extractor -iname '*.py' -and -not -iname 'lazy_extractors.py')
 132 yt_dlp/extractor/lazy_extractors.py: devscripts/make_lazy_extractors.py devscripts/lazy_load_template.py $(_EXTRACTOR_FILES)
 133         $(PYTHON) devscripts/make_lazy_extractors.py $@
 134
 135 yt-dlp.tar.gz: all
 136         @tar -czf $(DESTDIR)/yt-dlp.tar.gz --transform "s|^|yt-dlp/|" --owner 0 --group 0 \
 137                 --exclude '*.DS_Store' \
 138                 --exclude '*.kate-swp' \
 139                 --exclude '*.pyc' \
 140                 --exclude '*.pyo' \
 141                 --exclude '*~' \
 142                 --exclude '__pycache__' \
 143                 --exclude '.pytest_cache' \
 144                 --exclude '.git' \
 145                 -- \
 146                 README.md supportedsites.md Changelog.md LICENSE \
 147                 CONTRIBUTING.md Collaborators.md CONTRIBUTORS AUTHORS \
 148                 Makefile MANIFEST.in yt-dlp.1 README.txt completions \
 149                 setup.py setup.cfg yt-dlp yt_dlp requirements.txt \
 150                 devscripts test tox.ini pytest.ini
 151
 152 AUTHORS: .mailmap
 153         git shortlog -s -n | cut -f2 | sort > AUTHORS
 154
 155 .mailmap:
 156         git shortlog -s -e -n | awk '!(out[$$NF]++) { $$1="";sub(/^[ \t]+/,""); print}' > .mailmap