summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--README.md86
-rw-r--r--docs/conf.py2
-rw-r--r--docs/resources/banner.png (renamed from logo.png)bin18927 -> 18927 bytes
-rw-r--r--docs/resources/icon.icobin0 -> 5430 bytes
-rw-r--r--docs/resources/logo.pngbin0 -> 39315 bytes
-rw-r--r--docs/resources/logo.svg317
-rw-r--r--pyload.icobin9662 -> 0 bytes
-rw-r--r--systemCheck.py2
8 files changed, 367 insertions, 40 deletions
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** (<https://github.com/jonashaag/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 <package-name>
+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 <http://pyload.org/configuration>.
-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>.
-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/logo.png b/docs/resources/banner.png
index 4e2d718f7..4e2d718f7 100644
--- a/logo.png
+++ b/docs/resources/banner.png
Binary files differ
diff --git a/docs/resources/icon.ico b/docs/resources/icon.ico
new file mode 100644
index 000000000..b5fb55686
--- /dev/null
+++ b/docs/resources/icon.ico
Binary files differ
diff --git a/docs/resources/logo.png b/docs/resources/logo.png
new file mode 100644
index 000000000..d20084847
--- /dev/null
+++ b/docs/resources/logo.png
Binary files 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 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ version="1.1"
+ id="svg2"
+ inkscape:output_extension="org.inkscape.output.svg.inkscape"
+ inkscape:version="0.48.2 r9819"
+ sodipodi:version="0.32"
+ sodipodi:docname="pyload_logo.svg"
+ x="0px"
+ y="0px"
+ width="1000"
+ height="1000"
+ viewBox="0 0 1000 1000"
+ enable-background="new 0 0 1000 1000"
+ xml:space="preserve"
+ inkscape:export-filename="/Users/christian/Development/pyload/docs/resources/pyload_logo.png"
+ inkscape:export-xdpi="9.2647057"
+ inkscape:export-ydpi="9.2647057"><title
+ id="title3794">pyLoad Logo</title><metadata
+ id="metadata33"><rdf:RDF><cc:Work
+ rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title>pyLoad Logo</dc:title><dc:creator><cc:Agent><dc:title>pyLoad Team</dc:title></cc:Agent></dc:creator><cc:license
+ rdf:resource="http://creativecommons.org/licenses/by-nc-sa/3.0/" /><dc:subject><rdf:Bag><rdf:li>pyload logo</rdf:li></rdf:Bag></dc:subject><dc:description>Official pyLoad logo with some optional filters</dc:description></cc:Work><cc:License
+ rdf:about="http://creativecommons.org/licenses/by-nc-sa/3.0/"><cc:permits
+ rdf:resource="http://creativecommons.org/ns#Reproduction" /><cc:permits
+ rdf:resource="http://creativecommons.org/ns#Distribution" /><cc:requires
+ rdf:resource="http://creativecommons.org/ns#Notice" /><cc:requires
+ rdf:resource="http://creativecommons.org/ns#Attribution" /><cc:prohibits
+ rdf:resource="http://creativecommons.org/ns#CommercialUse" /><cc:permits
+ rdf:resource="http://creativecommons.org/ns#DerivativeWorks" /><cc:requires
+ rdf:resource="http://creativecommons.org/ns#ShareAlike" /></cc:License></rdf:RDF></metadata><defs
+ id="defs31"><color-profile
+ name="Generic-RGB-Profile"
+ xlink:href="/System/Library/ColorSync/Profiles/Generic RGB Profile.icc"
+ id="color-profile3792" /><linearGradient
+ gradientTransform="matrix(0.5625,0,0,-0.568,125.7979,708.7776)"
+ y2="752.55798"
+ x2="783.30792"
+ y1="134.5405"
+ x1="1220.123"
+ gradientUnits="userSpaceOnUse"
+ id="linearGradient3778">
+ <stop
+ id="stop3780"
+ style="stop-color:#ffd856;stop-opacity:1;"
+ offset="0" />
+ <stop
+ id="stop3782"
+ style="stop-color:#ffc836;stop-opacity:1;"
+ offset="1" />
+ </linearGradient><linearGradient
+ inkscape:collect="always"
+ xlink:href="#linearGradient3778"
+ id="linearGradient3005"
+ gradientUnits="userSpaceOnUse"
+ gradientTransform="matrix(1.0266298,0,0,1,-7.2192914,0)"
+ spreadMethod="pad"
+ x1="271.09799"
+ y1="499.06601"
+ x2="1001.7615"
+ y2="499.06601" /><linearGradient
+ inkscape:collect="always"
+ xlink:href="#path1948_3_"
+ id="linearGradient3783"
+ x1="25.991835"
+ y1="239.76074"
+ x2="763.24133"
+ y2="239.76074"
+ gradientUnits="userSpaceOnUse" /><filter
+ id="filter3020"
+ inkscape:label="Drop shadow"
+ width="1.5"
+ height="1.5"
+ x="-.25"
+ y="-.25"><feGaussianBlur
+ id="feGaussianBlur3022"
+ in="SourceAlpha"
+ stdDeviation="25"
+ result="blur" /><feColorMatrix
+ id="feColorMatrix3024"
+ result="bluralpha"
+ type="matrix"
+ values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0.5 0 " /><feOffset
+ id="feOffset3026"
+ in="bluralpha"
+ dx="15"
+ dy="30"
+ result="offsetBlur" /><feMerge
+ id="feMerge3028"><feMergeNode
+ id="feMergeNode3030"
+ in="offsetBlur" /><feMergeNode
+ id="feMergeNode3032"
+ in="SourceGraphic" /></feMerge></filter><filter
+ id="filter3023"
+ inkscape:label="Outline"
+ inkscape:menu="Morphology"
+ inkscape:menu-tooltip="Draws a colored outline around"
+ width="1.5"
+ height="1.5"
+ x="-0.25"
+ y="-0.25"
+ color-interpolation-filters="sRGB"><feGaussianBlur
+ id="feGaussianBlur3025"
+ in="SourceAlpha"
+ stdDeviation="10"
+ result="blur" /><feColorMatrix
+ id="feColorMatrix3027"
+ values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 100 -1 "
+ result="result4" /><feFlood
+ id="feFlood3029"
+ result="result1"
+ flood-color="rgb(0,0,0)"
+ in="blur"
+ flood-opacity="1" /><feComposite
+ id="feComposite3031"
+ in2="result4"
+ result="result2"
+ in="result1"
+ operator="atop" /><feComposite
+ id="feComposite3033"
+ in2="result2"
+ in="SourceGraphic"
+ result="result3"
+ operator="atop" /></filter><filter
+ id="filter3140"
+ inkscape:label="3D Effect"
+ inkscape:menu="Bevels"
+ inkscape:menu-tooltip="Basic specular bevel to use for building textures"
+ color-interpolation-filters="sRGB"><feGaussianBlur
+ id="feGaussianBlur3142"
+ stdDeviation="6"
+ in="SourceGraphic"
+ result="result0" /><feDiffuseLighting
+ id="feDiffuseLighting3144"
+ lighting-color="rgb(255,255,255)"
+ diffuseConstant="1"
+ surfaceScale="4"
+ result="result5"><feDistantLight
+ id="feDistantLight3146"
+ elevation="45"
+ azimuth="235" /></feDiffuseLighting><feComposite
+ id="feComposite3148"
+ in2="SourceGraphic"
+ k1="1.4"
+ in="result5"
+ result="fbSourceGraphic"
+ operator="arithmetic" /><feGaussianBlur
+ id="feGaussianBlur3150"
+ result="result0"
+ in="fbSourceGraphic"
+ stdDeviation="6" /><feSpecularLighting
+ id="feSpecularLighting3152"
+ specularExponent="25"
+ specularConstant="1"
+ surfaceScale="4"
+ lighting-color="rgb(255,255,255)"
+ result="result1"
+ in="result0"><feDistantLight
+ id="feDistantLight3154"
+ azimuth="235"
+ elevation="45" /></feSpecularLighting><feComposite
+ id="feComposite3156"
+ in2="result91"
+ k3="1"
+ k2="1"
+ operator="arithmetic"
+ result="result4"
+ in="fbSourceGraphic" /><feComposite
+ id="feComposite3158"
+ in2="SourceGraphic"
+ operator="in"
+ result="result2"
+ in="result4" /></filter></defs><sodipodi:namedview
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1"
+ objecttolerance="10"
+ gridtolerance="10"
+ guidetolerance="10"
+ inkscape:pageopacity="0"
+ inkscape:pageshadow="2"
+ inkscape:window-width="1352"
+ inkscape:window-height="766"
+ id="namedview29"
+ showgrid="false"
+ inkscape:zoom="0.5"
+ inkscape:cx="556.17192"
+ inkscape:cy="487.74566"
+ inkscape:window-x="0"
+ inkscape:window-y="0"
+ inkscape:window-maximized="0"
+ inkscape:current-layer="g2303_1_"
+ fit-margin-top="0"
+ fit-margin-left="0"
+ fit-margin-right="0"
+ fit-margin-bottom="0"
+ showborder="true"
+ borderlayer="false"
+ showguides="true"
+ inkscape:guide-bbox="true" />
+<g
+ id="g2303"
+ display="none"
+ style="display:none"
+ transform="translate(-21.799529,1.0000288)">
+
+ <linearGradient
+ id="path1948_2_"
+ gradientUnits="userSpaceOnUse"
+ x1="-338.45169"
+ y1="1559.3135"
+ x2="627.55139"
+ y2="728.19678"
+ gradientTransform="matrix(0.5625,0,0,-0.568,125.7979,708.7776)">
+ <stop
+ offset="0"
+ style="stop-color:#5A9FD4"
+ id="stop5" />
+ <stop
+ offset="1"
+ style="stop-color:#306998"
+ id="stop7" />
+ </linearGradient>
+ <path
+ id="path1948"
+ display="inline"
+ d="M 493.674,-0.868 H 256.098 166.937 c -69.042,0 -129.5,41.498 -148.412,120.447 -21.813,90.495 -22.783,146.964 0,241.457 16.887,70.339 57.219,120.447 126.26,120.447 h 81.686 V 372.939 c 0,-78.413 67.856,-147.585 148.416,-147.585 h 237.298 c 66.057,0 118.787,-54.385 118.787,-120.727 L 730.846,-0.89"
+ inkscape:connector-curvature="0"
+ style="fill:url(#path1948_2_);display:inline" />
+
+ <linearGradient
+ id="path1950_2_"
+ gradientUnits="userSpaceOnUse"
+ x1="1186.2559"
+ y1="133.9731"
+ x2="749.44067"
+ y2="751.99072"
+ gradientTransform="matrix(0.5625,0,0,-0.568,125.7979,708.7776)">
+ <stop
+ offset="0"
+ style="stop-color:#FFD43B"
+ id="stop11" />
+ <stop
+ offset="1"
+ style="stop-color:#FFE873"
+ id="stop13" />
+ </linearGradient>
+ <path
+ id="path1950"
+ display="inline"
+ d="m 755.602,0.132 v 105.496 c 0,81.799 -69.346,150.631 -148.418,150.631 H 369.886 c -65.002,0 -118.788,55.632 -118.788,120.727 v 226.221 c 0,64.39 55.985,102.262 118.788,120.727 C 412.959,736.601 500,1000 500,1000 c 0,0 68.736,-264.907 107.184,-276.066 59.809,-17.313 118.787,-52.168 118.787,-120.727 V 512.666 H 488.673 V 482.483 H 725.97 844.761 c 69.049,0 94.783,-48.163 118.787,-120.447 24.809,-74.417 23.752,-145.985 0,-241.457 C 946.486,51.85 913.898,0.132 844.762,0.132 h -89.16 z M 622.137,573.026 c 24.627,0 44.578,20.179 44.578,45.137 0,25.041 -19.951,45.409 -44.578,45.409 -24.541,0 -44.58,-20.368 -44.58,-45.409 0,-24.958 20.039,-45.137 44.58,-45.137 z"
+ inkscape:connector-curvature="0"
+ style="fill:url(#path1950_2_);display:inline" />
+</g>
+<g
+ id="g2303_1_"
+ transform="translate(-21.799529,1.0000288)">
+
+ <linearGradient
+ id="path1948_3_"
+ gradientUnits="userSpaceOnUse"
+ x1="-303.33109"
+ y1="1560.5684"
+ x2="662.672"
+ y2="729.45172"
+ gradientTransform="matrix(0.57252813,0,0,-0.568,127.65196,708.7776)">
+ <stop
+ offset="0"
+ style="stop-color:#3778b0;stop-opacity:1;"
+ id="stop18" />
+ <stop
+ offset="1"
+ style="stop-color:#356b97;stop-opacity:1;"
+ id="stop20" />
+ </linearGradient>
+ <path
+ style="fill:url(#linearGradient3783);fill-opacity:1;"
+ d="M 187.6338,-0.828786 C 142.54691,-0.4970408 97.509189,20.00164 69.766894,55.506872 50.404869,79.267481 40.287236,108.86774 34.426911,138.63795 22.416163,189.64033 17.78885,242.92961 25.780677,294.93728 c 5.106096,32.23417 11.057028,64.60794 22.392916,95.27781 13.479342,35.90012 38.974607,69.46226 76.144837,82.91501 27.93718,10.93473 54.60541,6.72414 83.9641,7.53695 13.63487,0 24.96913,0 38.604,0 0.2713,-39.75457 -0.23921,-79.53817 0.7,-119.27522 4.44911,-60.56565 57.97765,-113.83582 116.49553,-129.10577 28.59598,-7.98504 58.75298,-3.97369 88.12613,-4.95196 65.78932,-0.1699 131.59413,0.33658 197.37399,-0.24727 46.56452,-2.36951 89.41253,-33.74388 105.96031,-76.7788 8.4927,-20.25194 9.04154,-42.50123 8.36849,-64.136866 -0.0327,-28.519022 -0.0719,-58.538168 -0.10062,-87.0571928 -160.2708,-0.8222611 -320.54247,-0.1692627 -480.8154,0.027 -31.78694,0.021047 -63.57472,-0.0424765 -95.36116,0.0302428 z"
+ id="path1948_1_"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccccccccccc" />
+
+ <linearGradient
+ id="path1950_3_"
+ gradientUnits="userSpaceOnUse"
+ x1="1220.123"
+ y1="134.5405"
+ x2="783.30792"
+ y2="752.55798"
+ gradientTransform="matrix(0.5625,0,0,-0.568,125.7979,708.7776)"
+ xlink:href="#linearGradient3778">
+ <stop
+ offset="0"
+ style="stop-color:#fae13f;stop-opacity:1;"
+ id="stop24" />
+ <stop
+ offset="1"
+ style="stop-color:#facc2b;stop-opacity:1;"
+ id="stop26" />
+ </linearGradient>
+ <path
+ id="path1950_1_"
+ d="m 789.03685,-0.868 v 105.496 c 0,81.799 -71.19267,150.631 -152.37034,150.631 H 393.0493 c -66.73298,0 -121.9513,55.632 -121.9513,120.727 v 226.221 c 0,64.39 255.53022,396.793 255.53022,396.793 0,0 231.98858,-328.234 231.98858,-396.793 V 511.666 H 515.00061 V 481.483 H 758.6168 880.57116 c 70.88777,0 97.30706,-48.163 121.95034,-120.447 25.4697,-74.417 24.3844,-145.985 0,-241.457 C 985.00406,50.85 951.54825,-0.868 880.57116,-0.868 H 789.03685 z M 652.0177,572.026 c 25.28282,0 45.76511,20.179 45.76511,45.137 0,25.041 -20.48229,45.409 -45.76511,45.409 -25.19452,0 -45.76716,-20.368 -45.76716,-45.409 0,-24.958 20.57264,-45.137 45.76716,-45.137 z"
+ style="fill:url(#linearGradient3005);fill-opacity:1;"
+ inkscape:connector-curvature="0" />
+</g>
+</svg> \ No newline at end of file
diff --git a/pyload.ico b/pyload.ico
deleted file mode 100644
index c2b497986..000000000
--- a/pyload.ico
+++ /dev/null
Binary files 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):
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-29 07:12:30 +0100