aboutsummaryrefslogtreecommitdiffstats
path: root/devscripts
diff options
context:
space:
mode:
Diffstat (limited to 'devscripts')
-rwxr-xr-xdevscripts/make_readme.py22
-rw-r--r--devscripts/update-version.py46
2 files changed, 47 insertions, 21 deletions
diff --git a/devscripts/make_readme.py b/devscripts/make_readme.py
index fad993a19..2270b31d3 100755
--- a/devscripts/make_readme.py
+++ b/devscripts/make_readme.py
@@ -45,33 +45,43 @@ switch_col_width = len(re.search(r'(?m)^\s{5,}', options).group())
delim = f'\n{" " * switch_col_width}'
PATCHES = (
- ( # Standardize update message
+ ( # Standardize `--update` message
r'(?m)^( -U, --update\s+).+(\n \s.+)*$',
r'\1Update this program to the latest version',
),
- ( # Headings
+ ( # Headings
r'(?m)^ (\w.+\n)( (?=\w))?',
r'## \1'
),
- ( # Do not split URLs
+ ( # Fixup `--date` formatting
+ rf'(?m)( --date DATE.+({delim}[^\[]+)*)\[.+({delim}.+)*$',
+ (rf'\1[now|today|yesterday][-N[day|week|month|year]].{delim}'
+ f'E.g. "--date today-2weeks" downloads only{delim}'
+ 'videos uploaded on the same day two weeks ago'),
+ ),
+ ( # Do not split URLs
rf'({delim[:-1]})? (?P<label>\[\S+\] )?(?P<url>https?({delim})?:({delim})?/({delim})?/(({delim})?\S+)+)\s',
lambda mobj: ''.join((delim, mobj.group('label') or '', re.sub(r'\s+', '', mobj.group('url')), '\n'))
),
- ( # Do not split "words"
+ ( # Do not split "words"
rf'(?m)({delim}\S+)+$',
lambda mobj: ''.join((delim, mobj.group(0).replace(delim, '')))
),
- ( # Allow overshooting last line
+ ( # Allow overshooting last line
rf'(?m)^(?P<prev>.+)${delim}(?P<current>.+)$(?!{delim})',
lambda mobj: (mobj.group().replace(delim, ' ')
if len(mobj.group()) - len(delim) + 1 <= max_width + ALLOWED_OVERSHOOT
else mobj.group())
),
- ( # Avoid newline when a space is available b/w switch and description
+ ( # Avoid newline when a space is available b/w switch and description
DISABLE_PATCH, # This creates issues with prepare_manpage
r'(?m)^(\s{4}-.{%d})(%s)' % (switch_col_width - 6, delim),
r'\1 '
),
+ ( # Replace brackets with a Markdown link
+ r'SponsorBlock API \((http.+)\)',
+ r'[SponsorBlock API](\1)'
+ ),
)
readme = read_file(README_FILE)
diff --git a/devscripts/update-version.py b/devscripts/update-version.py
index 9cf8b42e6..00c2d54cf 100644
--- a/devscripts/update-version.py
+++ b/devscripts/update-version.py
@@ -7,6 +7,7 @@ import sys
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+import argparse
import contextlib
import subprocess
import sys
@@ -15,8 +16,9 @@ from datetime import datetime
from devscripts.utils import read_version, write_file
-def get_new_version(revision):
- version = datetime.utcnow().strftime('%Y.%m.%d')
+def get_new_version(version, revision):
+ if not version:
+ version = datetime.utcnow().strftime('%Y.%m.%d')
if revision:
assert revision.isdigit(), 'Revision must be a number'
@@ -30,27 +32,41 @@ def get_new_version(revision):
def get_git_head():
with contextlib.suppress(Exception):
- sp = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'], stdout=subprocess.PIPE)
- return sp.communicate()[0].decode().strip() or None
+ return subprocess.check_output(['git', 'rev-parse', 'HEAD'], text=True).strip() or None
-VERSION = get_new_version((sys.argv + [''])[1])
-GIT_HEAD = get_git_head()
-
-VERSION_FILE = f'''\
+VERSION_TEMPLATE = '''\
# Autogenerated by devscripts/update-version.py
-__version__ = {VERSION!r}
+__version__ = {version!r}
-RELEASE_GIT_HEAD = {GIT_HEAD!r}
+RELEASE_GIT_HEAD = {git_head!r}
VARIANT = None
UPDATE_HINT = None
+
+CHANNEL = "{channel!r}"
'''
-write_file('yt_dlp/version.py', VERSION_FILE)
-github_output = os.getenv('GITHUB_OUTPUT')
-if github_output:
- write_file(github_output, f'ytdlp_version={VERSION}\n', 'a')
-print(f'\nVersion = {VERSION}, Git HEAD = {GIT_HEAD}')
+if __name__ == '__main__':
+ parser = argparse.ArgumentParser(description='Update the version.py file')
+ parser.add_argument(
+ '-c', '--channel', choices=['stable', 'nightly'], default='stable',
+ help='Select update channel (default: %(default)s)')
+ parser.add_argument(
+ '-o', '--output', default='yt_dlp/version.py',
+ help='The output file to write to (default: %(default)s)')
+ parser.add_argument(
+ 'version', nargs='?', default=None,
+ help='A version or revision to use instead of generating one')
+ args = parser.parse_args()
+
+ git_head = get_git_head()
+ version = (
+ args.version if args.version and '.' in args.version
+ else get_new_version(None, args.version))
+ write_file(args.output, VERSION_TEMPLATE.format(
+ version=version, git_head=git_head, channel=args.channel))
+
+ print(f'version={version} ({args.channel}), head={git_head}')