diff options
author | Walter Purcaro <vuolter@gmail.com> | 2014-03-25 12:29:32 +0100 |
---|---|---|
committer | Walter Purcaro <vuolter@gmail.com> | 2014-06-28 02:46:31 +0200 |
commit | 33010a25011f85b9ed8bef668c3ddab8438541fc (patch) | |
tree | 48d078cc6b5465db3408b0bee3f449a10574edac /README.md | |
parent | Fixed template loader (diff) | |
download | pyload-33010a25011f85b9ed8bef668c3ddab8438541fc.tar.xz |
Updated README
See #559
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 91 |
1 files changed, 52 insertions, 39 deletions
@@ -1,84 +1,97 @@ -# pyLoad +![pyLoad](/logo.png "pyLoad") +============================= -pyLoad is a free and open source downloader for 1-click-hosting sites -like rapidshare.com or uploaded.to. -It supports link decryption as well as all important container formats. +**pyLoad** is a free and open source download manager for all kind of operating systems and devices, +designed to be extremely lightweight and runnable on common computers or headless servers. -pyLoad is written entirely in Python and is currently under heavy development. +Its modern web interface allows to manage downloads across networks and easily access them from anywhere. +All common video-sites, one-click-hosters, container formats and well known web standards are supported to download files for you. +Additionaly it has a great variety of plugins to automate common tasks and make unattended running possible. -For news, downloads, wiki, forum and further information visit http://pyload.org/ +pyLoad has a full featured and well documented API, is easily extendable and accessible by external tools. +It is written entirely in Python and under heavy development. -To report bugs, suggest features, ask a question, get the developer version -or help us out, visit http://github.com/pyload/pyload - -Documentation about extending pyLoad can be found at http://docs.pyload.org or join us at #pyload on irc.freenode.net Dependencies ------------ -You need at least python 2.5 to run pyLoad and all of these required libaries. +**You need at least python 2.5 to run pyLoad and all of these required libaries.** They should be automatically installed when using pip install. -The prebuilt pyload packages also install these dependencies or have them included, so manuall install +The pre-built pyload packages also install these dependencies or have them included, so manual install is only needed when installing pyLoad from source. -### Required +### Required ### + + - **beaker** + - **jinja2** + - **pycurl** (a.k.a python-curl) + - **simplejson**: For python 2.5 + - **thrift** -- pycurl a.k.a python-curl -- jinja2 -- beaker -- thrift -- simplejson (for python 2.5) +Some plugins require additional packages, install these only when needed. -Some plugins require additional packages, only install these when needed. +### Optional ### -### Optional + - **BeautifulSoup** + - **feedparser** + - **jsengine** (spidermonkey, ossp-js, pyv8, rhino): Needed by several hosters (ex.: ClickNLoad) + - **pycrypto**: For RSDF/CCF/DLC support + - **pyOpenSSL**: For SSL connection + - **tesseract**, **python-pil** (a.k.a python-imaging): For automatic captcha recognition support -- pycrypto: RSDF/CCF/DLC support -- tesseract, python-pil a.k.a python-imaging: Automatic captcha recognition for a small amount of plugins -- jsengine (spidermonkey, ossp-js, pyv8, rhino): Used for several hoster, ClickNLoad -- feedparser -- BeautifulSoup -- pyOpenSSL: For SSL connection First start ----------- -Note: If you installed pyload via package-manager `python pyLoadCore.py` is probably equivalent to `pyLoadCore` +***Note:*** +If you installed pyload via package-manager `python pyLoadCore.py` is probably equivalent to `pyLoadCore`. -Run:: +Run: python pyLoadCore.py -and follow the instructions of the setup assistent. +and follow the instructions of the setup assistant. -For a list of options use:: +For a list of options use: python pyLoadCore.py -h + Configuration ------------- -After finishing the setup assistent pyLoad is ready to use and more configuration can be done via webinterface. -Additionally you could simply edit the config files located in your pyLoad home dir (defaults to: ~/.pyload) +After finishing the setup assistant pyLoad is ready to use and more configuration can be done via webinterface. +Additionally you could simply edit the configuration files located in your pyLoad home directory (default to `~/.pyload`) with your favorite editor and edit the appropriate options. For a short description of -the options take a look at http://pyload.org/configuration. +the options take a look at <http://pyload.org/configuration>. -To restart the configure assistent run:: +To restart the configure assistant run: python pyLoadCore.py -s -### Adding downloads +### Adding downloads ### -To start the CLI and connect to a local server, run:: +To start the Command Line Interface and connect to a local server, run: python pyLoadCli.py -l -for more options refer to:: +for more options refer to: python pyLoadCli.py -h -The webinterface can be accessed when pointing your webbrowser to the ip and configured port, defaults to http://localhost:8000 +The webinterface can be accessed when pointing your webbrowser to the IP and configured port, defaults to `http://localhost:8000`. + Notes ----- -For more information, see http://pyload.org/ + +For news, downloads, wiki, forum and further information visit <http://pyload.org/>. + +To report bugs, suggest features, ask a question, get the developer version +or help us out, visit <https://github.com/pyload/pyload>. + +Documentation about extending pyLoad can be found at <http://docs.pyload.org> or joining us at `#pyload` on `irc.freenode.net`. + + +------------------------------ +###### pyLoad Team 2008-2014 ###### |