From b8e0600d7835f90f32fff306e3bee24a293eed13 Mon Sep 17 00:00:00 2001 From: Mort Yao Date: Sun, 21 Sep 2014 04:21:40 +0200 Subject: [PATCH] use .rst as the extension name of reStructuredText files; deprecate README.txt --- .gitignore | 1 + CHANGELOG.txt => CHANGELOG.rst | 0 MANIFEST.in | 1 + README.txt | 209 --------------------------------- setup.py | 4 +- 5 files changed, 4 insertions(+), 211 deletions(-) rename CHANGELOG.txt => CHANGELOG.rst (100%) delete mode 100644 README.txt diff --git a/.gitignore b/.gitignore index a1ca7384..39376d18 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,7 @@ _*/ *.mpg *.ts *.webm +README.rst *.DS_Store *.swp diff --git a/CHANGELOG.txt b/CHANGELOG.rst similarity index 100% rename from CHANGELOG.txt rename to CHANGELOG.rst diff --git a/MANIFEST.in b/MANIFEST.in index d25c879e..521b023b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,4 @@ +include *.rst include *.txt include Makefile include README.md diff --git a/README.txt b/README.txt deleted file mode 100644 index 64f78813..00000000 --- a/README.txt +++ /dev/null @@ -1,209 +0,0 @@ -You-Get -======= - -.. image:: https://api.travis-ci.org/soimort/you-get.png - -.. image:: https://badge.fury.io/py/you-get.png - -`You-Get `_ is a video downloader runs on Python 3. It aims at easing the download of videos on `YouTube `_, `Youku `_/`Tudou `_ (biggest online video providers in China), `Niconico `_, etc., in one script. - -See the project homepage http://www.soimort.org/you-get for further documentation. - -Fork me on GitHub: https://github.com/soimort/you-get - -Features --------- - -Supported Sites (As of Now) -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* YouTube http://www.youtube.com -* Vimeo http://vimeo.com -* Coursera https://www.coursera.org -* Blip http://blip.tv -* CBS http://www.cbs.com -* Dailymotion http://dailymotion.com -* eHow http://www.ehow.com -* Facebook http://facebook.com -* Google+ http://plus.google.com -* Google Drive http://docs.google.com -* Khan Academy http://www.khanacademy.org -* TED http://www.ted.com -* Tumblr http://www.tumblr.com -* Vine http://vine.co -* Instagram http://instagram.com -* Magisto http://www.magisto.com -* SoundCloud http://soundcloud.com -* Mixcloud http://www.mixcloud.com -* Freesound http://www.freesound.org -* JPopsuki http://jpopsuki.tv -* MTV 81 http://www.mtv81.com -* VID48 http://vid48.com -* Niconico (ニコニコ動画) http://www.nicovideo.jp -* Youku (优酷) http://www.youku.com -* Tudou (土豆) http://www.tudou.com -* YinYueTai (音悦台) http://www.yinyuetai.com -* AcFun http://www.acfun.tv -* bilibili http://www.bilibili.com -* CNTV (中国网络电视台) http://www.cntv.cn -* Douban (豆瓣) http://douban.com -* ifeng (凤凰视频) http://v.ifeng.com -* iQIYI (爱奇艺) http://www.iqiyi.com -* Joy.cn (激动网) http://www.joy.cn -* Ku6 (酷6网) http://www.ku6.com -* LeTV (乐视网) http://www.letv.com -* MioMio http://www.miomio.tv -* NetEase (网易视频) http://v.163.com -* NetEase Music (网易云音乐) http://music.163.com -* PPTV http://www.pptv.com -* QQ (腾讯视频) http://v.qq.com -* Sina (新浪视频) http://video.sina.com.cn -* Sohu (搜狐视频) http://tv.sohu.com -* 56 (56网) http://www.56.com -* Xiami (虾米) http://www.xiami.com -* Kugou (酷狗音乐) http://www.kugou.com -* Kuwo (酷我音乐) http://www.kuwo.cn -* Baidu Music (百度音乐) http://music.baidu.com -* Baidu Wangpan (百度网盘) http://pan.baidu.com -* SongTaste http://www.songtaste.com -* Alive.in.th http://alive.in.th -* VK http://vk.com -* Catfun (喵星球) http://www.catfun.tv -* VideoBam http://videobam.com - -Dependencies ------------- - -* `Python 3 `_ -* (Optional) `FFmpeg `_ / `Libav `_ - * For converting and joining video files. -* (Optional) `RTMPDump `_ - * For processing RTMP streams. - -Installation ------------- - -#) Install via Pip:: - - $ [sudo] pip3 install --pre you-get - - Check if the installation was successful:: - - $ you-get -V - -#) Install from Git:: - - $ git clone git://github.com/soimort/you-get.git - - Use the raw script without installation:: - - $ cd you-get/ - $ ./you-get -V - - To install the package into the system path, execute:: - - $ make install - - Check if the installation was successful:: - - $ you-get -V - -#) Direct download:: - - $ wget -O you-get.zip https://github.com/soimort/you-get/zipball/master - $ unzip you-get.zip - - Use the raw script without installation:: - - $ cd soimort-you-get-*/ - $ ./you-get -V - - To install the package into the system path, execute:: - - $ make install - - Check if the installation was successful:: - - $ you-get -V - -#) Install from your distro's repo: - -* `AUR (Arch) `_ - -* `Overlay (Gentoo) `_ - -Upgrading ---------- - -Using Pip:: - - $ [sudo] pip install --upgrade you-get - -Examples --------- - -Display the information of the video without downloading:: - - $ you-get -i http://www.youtube.com/watch?v=sGwy8DsUJ4M - -Download the video:: - - $ you-get http://www.youtube.com/watch?v=sGwy8DsUJ4M - -Download multiple videos:: - - $ you-get http://www.youtube.com/watch?v=sGwy8DsUJ4M http://www.youtube.com/watch?v=8bQlxQJEzLk - -By default, program will skip any video that already exists in the local directory when downloading. If a temporary file (ends with a ".download" filename extension) is found, program will resume the download from last session. - -To enforce re-downloading of videos, use '-f' option (this will overwrite any existing video or temporary file, rather than skipping or resuming them):: - - $ you-get -f http://www.youtube.com/watch?v=sGwy8DsUJ4M - -Set the output directory for downloaded files:: - - $ you-get -o ~/Downloads http://www.youtube.com/watch?v=sGwy8DsUJ4M - -Use a specific HTTP proxy for downloading:: - - $ you-get -x 127.0.0.1:8087 http://www.youtube.com/watch?v=sGwy8DsUJ4M - -By default, Python will apply the system proxy settings (i.e. environment variable $http_proxy). To cancel the use of proxy, use '--no-proxy' option:: - - $ you-get --no-proxy http://www.youtube.com/watch?v=sGwy8DsUJ4M - -Command-Line Options --------------------- - -For a complete list of all available options, see:: - - $ you-get --help - Usage: you-get [OPTION]... [URL]... - - Startup options: - -V | --version Display the version and exit. - -h | --help Print this help and exit. - - Download options (use with URLs): - -f | --force Force overwriting existed files. - -i | --info Display the information of videos without downloading. - -u | --url Display the real URLs of videos without downloading. - -n | --no-merge Don't merge video parts. - -F | --format Video format code. - -c | --cookies Load NetScape's cookies.txt file. - -o | --output-dir Set the output directory for downloaded videos. - -p | --player Directly play the video with PLAYER like vlc/smplayer. - -x | --http-proxy Use specific HTTP proxy for downloading. - -y | --extractor-proxy Use specific HTTP proxy for extracting stream data. - --no-proxy Don't use any proxy. (ignore $http_proxy) - --debug Show traceback on KeyboardInterrupt. - -License -------- - -You-Get is licensed under the `MIT license `_. - -Contributing ------------- - -Please see `CONTRIBUTING.md `_. diff --git a/setup.py b/setup.py index d4f1be39..91616eec 100755 --- a/setup.py +++ b/setup.py @@ -8,8 +8,8 @@ PROJ_METADATA = '%s.json' % PROJ_NAME import os, json, imp here = os.path.abspath(os.path.dirname(__file__)) proj_info = json.loads(open(os.path.join(here, PROJ_METADATA), encoding='utf-8').read()) -README = open(os.path.join(here, 'README.txt'), encoding='utf-8').read() -CHANGELOG = open(os.path.join(here, 'CHANGELOG.txt'), encoding='utf-8').read() +README = open(os.path.join(here, 'README.rst'), encoding='utf-8').read() +CHANGELOG = open(os.path.join(here, 'CHANGELOG.rst'), encoding='utf-8').read() VERSION = imp.load_source('version', os.path.join(here, 'src/%s/version.py' % PACKAGE_NAME)).__version__ from setuptools import setup, find_packages