mirror of
https://github.com/soimort/you-get.git
synced 2025-01-23 13:35:16 +03:00
add a separate README.rst
This commit is contained in:
parent
083f97aa35
commit
8aea3367ab
3
.gitignore
vendored
3
.gitignore
vendored
@ -61,14 +61,13 @@ target/
|
|||||||
# Misc
|
# Misc
|
||||||
_*
|
_*
|
||||||
*_
|
*_
|
||||||
README.html
|
|
||||||
README.rst
|
|
||||||
*.3gp
|
*.3gp
|
||||||
*.asf
|
*.asf
|
||||||
*.download
|
*.download
|
||||||
*.f4v
|
*.f4v
|
||||||
*.flv
|
*.flv
|
||||||
*.gif
|
*.gif
|
||||||
|
*.html
|
||||||
*.jpg
|
*.jpg
|
||||||
*.lrc
|
*.lrc
|
||||||
*.mkv
|
*.mkv
|
||||||
|
7
Makefile
7
Makefile
@ -1,6 +1,6 @@
|
|||||||
SETUP = python3 setup.py
|
SETUP = python3 setup.py
|
||||||
|
|
||||||
.PHONY: default i test clean all html rst build sdist bdist bdist_egg bdist_wheel install rst release
|
.PHONY: default i test clean all html rst build sdist bdist bdist_egg bdist_wheel install release
|
||||||
|
|
||||||
default: i
|
default: i
|
||||||
|
|
||||||
@ -12,12 +12,11 @@ test:
|
|||||||
|
|
||||||
clean:
|
clean:
|
||||||
zenity --question
|
zenity --question
|
||||||
rm -f README.rst
|
|
||||||
rm -fr build/ dist/ src/*.egg-info/
|
rm -fr build/ dist/ src/*.egg-info/
|
||||||
find . | grep __pycache__ | xargs rm -fr
|
find . | grep __pycache__ | xargs rm -fr
|
||||||
find . | grep .pyc | xargs rm -f
|
find . | grep .pyc | xargs rm -f
|
||||||
|
|
||||||
all: rst build sdist bdist bdist_egg bdist_wheel
|
all: build sdist bdist bdist_egg bdist_wheel
|
||||||
|
|
||||||
html:
|
html:
|
||||||
pandoc README.md > README.html
|
pandoc README.md > README.html
|
||||||
@ -43,6 +42,6 @@ bdist_wheel:
|
|||||||
install:
|
install:
|
||||||
$(SETUP) install
|
$(SETUP) install
|
||||||
|
|
||||||
release: rst
|
release:
|
||||||
zenity --question
|
zenity --question
|
||||||
$(SETUP) sdist bdist_wheel upload --sign
|
$(SETUP) sdist bdist_wheel upload --sign
|
||||||
|
58
README.rst
Normal file
58
README.rst
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
You-Get
|
||||||
|
=======
|
||||||
|
|
||||||
|
|PyPI version| |Build Status| |Gitter|
|
||||||
|
|
||||||
|
`You-Get <https://you-get.org/>`__ is a tiny command-line utility to
|
||||||
|
download media contents (videos, audios, images) from the Web, in case
|
||||||
|
there is no other handy way to do it.
|
||||||
|
|
||||||
|
Here's how you use ``you-get`` to download a video from `this web
|
||||||
|
page <http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society>`__:
|
||||||
|
|
||||||
|
.. code:: console
|
||||||
|
|
||||||
|
$ you-get http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society
|
||||||
|
Site: fsf.org
|
||||||
|
Title: TEDxGE2014_Stallman05_LQ
|
||||||
|
Type: WebM video (video/webm)
|
||||||
|
Size: 27.12 MiB (28435804 Bytes)
|
||||||
|
|
||||||
|
Downloading TEDxGE2014_Stallman05_LQ.webm ...
|
||||||
|
100.0% ( 27.1/27.1 MB) ├████████████████████████████████████████┤[1/1] 12 MB/s
|
||||||
|
|
||||||
|
And here's why you might want to use it:
|
||||||
|
|
||||||
|
- You enjoyed something on the Internet, and just want to download them
|
||||||
|
for your own pleasure.
|
||||||
|
- You watch your favorite videos online from your computer, but you are
|
||||||
|
prohibited from saving them. You feel that you have no control over
|
||||||
|
your own computer. (And it's not how an open Web is supposed to
|
||||||
|
work.)
|
||||||
|
- You want to get rid of any closed-source technology or proprietary
|
||||||
|
JavaScript code, and disallow things like Flash running on your
|
||||||
|
computer.
|
||||||
|
- You are an adherent of hacker culture and free software.
|
||||||
|
|
||||||
|
What ``you-get`` can do for you:
|
||||||
|
|
||||||
|
- Download videos / audios from popular websites such as YouTube,
|
||||||
|
Youku, Niconico, and a bunch more. (See the `full list of supported
|
||||||
|
sites <#supported-sites>`__)
|
||||||
|
- Stream an online video in your media player. No web browser, no more
|
||||||
|
ads.
|
||||||
|
- Download images (of interest) by scraping a web page.
|
||||||
|
- Download arbitrary non-HTML contents, i.e., binary files.
|
||||||
|
|
||||||
|
Interested? `Install it <#installation>`__ now and `get started by
|
||||||
|
examples <#getting-started>`__.
|
||||||
|
|
||||||
|
Are you a Python programmer? Then check out `the
|
||||||
|
source <https://github.com/soimort/you-get>`__ and fork it!
|
||||||
|
|
||||||
|
.. |PyPI version| image:: https://badge.fury.io/py/you-get.png
|
||||||
|
:target: http://badge.fury.io/py/you-get
|
||||||
|
.. |Build Status| image:: https://api.travis-ci.org/soimort/you-get.png
|
||||||
|
:target: https://travis-ci.org/soimort/you-get
|
||||||
|
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
|
||||||
|
:target: https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
2
setup.py
2
setup.py
@ -28,7 +28,7 @@ setup(
|
|||||||
description = proj_info['description'],
|
description = proj_info['description'],
|
||||||
keywords = proj_info['keywords'],
|
keywords = proj_info['keywords'],
|
||||||
|
|
||||||
long_description = README + '\n\n' + CHANGELOG,
|
long_description = README,
|
||||||
|
|
||||||
packages = find_packages('src'),
|
packages = find_packages('src'),
|
||||||
package_dir = {'' : 'src'},
|
package_dir = {'' : 'src'},
|
||||||
|
Loading…
Reference in New Issue
Block a user