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