From 23dc40ac64f6a7a1d17b4726189b7f112740f8b6 Mon Sep 17 00:00:00 2001 From: Walter Purcaro Date: Sat, 28 Jun 2014 20:22:29 +0200 Subject: Improved readme and python system check --- README.md | 86 +++++++------ docs/conf.py | 2 +- docs/resources/banner.png | Bin 0 -> 18927 bytes docs/resources/icon.ico | Bin 0 -> 5430 bytes docs/resources/logo.png | Bin 0 -> 39315 bytes docs/resources/logo.svg | 317 ++++++++++++++++++++++++++++++++++++++++++++++ logo.png | Bin 18927 -> 0 bytes pyload.ico | Bin 9662 -> 0 bytes systemCheck.py | 2 +- 9 files changed, 367 insertions(+), 40 deletions(-) create mode 100644 docs/resources/banner.png create mode 100644 docs/resources/icon.ico create mode 100644 docs/resources/logo.png create mode 100644 docs/resources/logo.svg delete mode 100644 logo.png delete mode 100644 pyload.ico diff --git a/README.md b/README.md index 5912a6d12..d3289b434 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,96 @@ -![pyLoad](/logo.png "pyLoad") +![pyLoad](/docs/resources/banner.png "pyLoad") ============================= -**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 a Free and Open Source download manager written entirely in Python, available for all kind of operating systems and devices, +designed to be extremely lightweight and executable either on common computers or on headless servers. -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. +Its web interface allows full managing and easily remote access from anywhere. -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. +All common video-sites, one-click-hosters, container formats and well known web standards are supported to allow you to download files. +Additionaly, pyLoad has a great variety of plugins to automate common tasks and make unattended running possible. + +pyLoad has a fully featured and well documented API, is easily extendable and accessible by external tools. Dependencies ------------ -**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 pre-built pyload packages also install these dependencies or have them included, so manual install -is only needed when installing pyLoad from source. +**You need at least python 2.5 or at most python 2.7 to run pyLoad and its required libaries.** +**Python 3 is not yet supported!** ### Required ### - **beaker** - **jinja2** - - **pycurl** (a.k.a python-curl) - - **simplejson**: For python 2.5 + - **pycurl** (python-curl) + - **simplejson** for python 2.5 only - **thrift** -Some plugins require additional packages, install these only when needed. +Some plugins want additional packages, install them only when needed. ### Optional ### - **BeautifulSoup** + - **bjoern** () for best web interface performance - **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 + - **jsengine** (spidermonkey, ossp-js, pyv8, rhino) needed by several hosters (ex.: ClickNLoad) + - **pycrypto** for RSDF/CCF/DLC support + - **pyOpenSSL** for SSL connection support + - **tesseract**, **python-pil** (python-imaging) for automatic captcha recognition support + +You can install them using the Python Package Index: + + pip install +Indeed, pre-built pyLoad packages have all yet included, so manual install is required only when you get pyLoad source code. -First start + +Usage ----------- -***Note:*** -If you installed pyload via package-manager `python pyLoadCore.py` is probably equivalent to `pyLoadCore`. +### First start ### Run: python pyLoadCore.py -and follow the instructions of the setup assistant. +and follow the setup assistant instructions. -For a list of options use: +> ***Note:*** +If you installed pyLoad by package-manager, command `python pyLoadCore.py` is probably equivalent to `pyload` or `pyLoadCore`. - python pyLoadCore.py -h +Additionally, you can whenever restart the setup assistant typing: + python pyLoadCore.py -s -Configuration -------------- +Or you can even edit configuration files located in your pyLoad home directory (default to `~/.pyload`) +with your favorite editor. +For a short description of all the configuration options available visit . -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 . -To restart the configure assistant run: +### Web interface ### - python pyLoadCore.py -s +Run: -### Adding downloads ### + python pyLoadCore.py -To start the Command Line Interface and connect to a local server, run: +So, to retrieve it point your web browser to the socket address configured by setup (default to `http://localhost:8000`). + +You can get the list of accepted arguments typing: + + python pyLoadCore.py -h + + +### Command Line Interface ### + +Run: python pyLoadCli.py -l -for more options refer to: +You can get the list of accepted arguments typing: python pyLoadCli.py -h -The webinterface can be accessed when pointing your webbrowser to the IP and configured port, defaults to `http://localhost:8000`. - Notes ----- diff --git a/docs/conf.py b/docs/conf.py index 6f97f527e..24752ee5f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -133,7 +133,7 @@ html_logo = join(dir_name, "module", "web", "media", "default", "img", "pyload-l # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = join(dir_name, "pyload.ico") +html_favicon = join(dir_name, "docs", "resources", "icon.ico") # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/resources/banner.png b/docs/resources/banner.png new file mode 100644 index 000000000..4e2d718f7 Binary files /dev/null and b/docs/resources/banner.png differ diff --git a/docs/resources/icon.ico b/docs/resources/icon.ico new file mode 100644 index 000000000..b5fb55686 Binary files /dev/null and b/docs/resources/icon.ico differ diff --git a/docs/resources/logo.png b/docs/resources/logo.png new file mode 100644 index 000000000..d20084847 Binary files /dev/null and b/docs/resources/logo.png differ diff --git a/docs/resources/logo.svg b/docs/resources/logo.svg new file mode 100644 index 000000000..f67815678 --- /dev/null +++ b/docs/resources/logo.svg @@ -0,0 +1,317 @@ + + + +pyLoad Logoimage/svg+xmlpyLoad LogopyLoad Teampyload logoOfficial pyLoad logo with some optional filters + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/logo.png b/logo.png deleted file mode 100644 index 4e2d718f7..000000000 Binary files a/logo.png and /dev/null differ diff --git a/pyload.ico b/pyload.ico deleted file mode 100644 index c2b497986..000000000 Binary files a/pyload.ico and /dev/null differ diff --git a/systemCheck.py b/systemCheck.py index 05bcc9f79..2d25701c3 100644 --- a/systemCheck.py +++ b/systemCheck.py @@ -43,7 +43,7 @@ def main(): core_err = [] core_info = [] - if sys.version_info > (2, 8): + if sys.version_info > (2, 7): core_err.append("Your python version is to new, Please use Python 2.6/2.7") if sys.version_info < (2, 5): -- cgit v1.2.3