Update documentation and drop gettext support for argparse help strings

This commit is contained in:
Nguyễn Gia Phong 2017-07-04 23:51:05 +07:00
parent e824f80116
commit d70dcf5166
5 changed files with 21 additions and 20 deletions

View File

@ -2,10 +2,11 @@
comp - Curses Omni Media Player
===============================
**comp** is a mpv front-end using curses. It has basic media player functions
and can to extract playlists from multiple sources such as media sites
supported by youtube-dl, local and direct URL to video/audio and its own JSON
playlist format.
**comp** is a `mpv <https://github.com/mpv-player/mpv>`_ front-end using
curses. It has basic media player functions and can to extract playlists from
multiple sources such as media sites supported by `youtube-dl
<https://github.com/rg3/youtube-dl>`_, local and direct URL to video/audio and
its own JSON playlist format.
.. image:: https://github.com/McSinyx/comp/raw/master/doc/screenshot.png
@ -35,7 +36,7 @@ Command line options
::
usage: comp [-h] [-e {json,mpv,youtube-dl}] [-c CONFIG] [--vid VID]
usage: comp [-h] [-v] [-e {json,mpv,youtube-dl}] [-c CONFIG] [--vid VID]
[--vo DRIVER] [-f YTDL_FORMAT]
playlist

22
comp
View File

@ -326,24 +326,24 @@ class Comp(Omp):
Omp.__exit__(self, exc_type, exc_value, traceback)
parser = ArgumentParser(description=_("Curses Omni Media Player"))
parser = ArgumentParser(description='Curses Omni Media Player')
parser.add_argument('-v', '--version', action='version',
version='%(prog)s 0.3.10')
version='%(prog)s 0.3.11')
parser.add_argument('-e', '--extractor', default='youtube-dl',
choices=('json', 'mpv', 'youtube-dl'), required=False,
help=_("playlist extractor, default is youtube-dl"))
parser.add_argument('playlist', help=_("path or URL to the playlist"))
help='playlist extractor, default is youtube-dl')
parser.add_argument('playlist', help='path or URL to the playlist')
parser.add_argument('-c', '--config', default=USER_CONFIG, required=False,
help=_("path to the configuration file"))
help='path to the configuration file')
parser.add_argument('--vid', required=False,
help=_("initial video channel. auto selects the default,\
no disables video"))
help='initial video channel. auto selects the default, no\
disables video')
parser.add_argument('--vo', required=False, metavar='DRIVER',
help=_("specify the video output backend to be used. See\
VIDEO OUTPUT DRIVERS in mpv(1) for details and\
descriptions of available drivers"))
help='specify the video output backend to be used. See\
VIDEO OUTPUT DRIVERS in mpv(1) for details and\
descriptions of available drivers')
parser.add_argument('-f', '--format', required=False, metavar='YTDL_FORMAT',
help=_("video format/quality to be passed to youtube-dl"))
help='video format/quality to be passed to youtube-dl')
args = parser.parse_args()
entries = extract_info(args.playlist, args.extractor)
if entries is None:

View File

@ -5,9 +5,9 @@
.SH NAME
comp \- Curses Omni Media Player
.SH SYNOPSIS
\fBcomp\fR [\fB-h\fR] [\fB-e\fR {json,mpv,youtube-dl}] [\fB-c \fICONFIG\fR]
[\fB--vid \fIVID\fR] [\fB--vo \fIDRIVER\fR] [\fB-f \fIYTDL_FORMAT\fR]
\fIplaylist\fR
\fBcomp\fR [\fB-h\fR] [\fB-v\fR] [\fB-e\fR {json,mpv,youtube-dl}]
[\fB-c \fICONFIG\fR] [\fB--vid \fIVID\fR] [\fB--vo \fIDRIVER\fR]
[\fB-f \fIYTDL_FORMAT\fR] \fIplaylist\fR
.SH DESCRIPTION
\fBcomp\fR is a
.BR mpv (1)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 811 KiB

After

Width:  |  Height:  |  Size: 422 KiB

View File

@ -7,7 +7,7 @@ with open('README.rst') as f:
setup(
name='comp',
version='0.3.10',
version='0.3.11',
description=('Curses Omni Media Player'),
long_description=long_description,
url='https://github.com/McSinyx/comp',