forked from pyload/pyload
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
69 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,35 @@ | ||
| <p align="center"><a href="https://pyload.net"><img src="/media/banner.png" alt="pyLoad" /></a></p> | ||
| <div align="center"> | ||
| <a href="https://pyload.net"> | ||
| <img src="media/banner.png?raw=true" alt="pyLoad" /> | ||
| </a> | ||
| <hr> | ||
| <a href="https://pypi.python.org/pypi/pyload.core"> | ||
| <img src="https://img.shields.io/pypi/status/pyload.core.svg" alt="PyPI Status" /> | ||
| </a> | ||
| <a href="https://pypi.python.org/pypi/pyload.core"> | ||
| <img src="https://img.shields.io/pypi/v/pyload.core.svg" alt="PyPI Version" /> | ||
| </a> | ||
| <a href="https://pypi.python.org/pypi/pyload.core"> | ||
| <img src="https://img.shields.io/pypi/pyversions/pyload.core.svg" alt="PyPI Python Versions" /> | ||
| </a> | ||
| <a href="https://pypi.python.org/pypi/pyload.core"> | ||
| <img src="https://img.shields.io/pypi/l/pyload.core.svg" alt="PyPI License" /> | ||
| </a> | ||
| </div> | ||
|
|
||
| **pyLoad** is the Free and Open Source download manager written in Pure Python | ||
| and designed to be extremely lightweight, fully customizable and remotely | ||
| manageable. | ||
|
|
||
| > **Notice:** | ||
| > **[Master Branch](https://github.com/pyload/pyload/tree/master) | ||
| > is under heavy development, very unstable, often broken.** | ||
|
|
||
| > **Notice:** | ||
| > **[Stable Branch](https://github.com/pyload/pyload/tree/stable) is production | ||
| > ready**. | ||
| **Status**: | ||
|
|
||
| [](https://travis-ci.org/pyload/pyload) | ||
| [](https://ci.appveyor.com/project/vuolter/pyload/branch/master) | ||
| [](https://requires.io/github/pyload/pyload/requirements/?branch=master) | ||
| [](https://www.codacy.com/app/pyLoad/pyload?utm_source=github.com&utm_medium=referral&utm_content=pyload/pyload&utm_campaign=Badge_Grade) | ||
| [](https://scrutinizer-ci.com/g/pyload/pyload/?branch=master) | ||
| [](https://pypi.python.org/pypi/pyload.core) | ||
| [](https://pypi.python.org/pypi/pyload.core) | ||
| [](https://pypi.python.org/pypi/pyload.core) | ||
|
|
||
| **Licensing**: | ||
|
|
||
| [](https://cla-assistant.io/pyload/pyload) | ||
| [](https://pypi.python.org/pypi/pyload.core) | ||
|
|
||
| **Contacts**: | ||
|
|
||
| [](https://pyload.net) | ||
| [](https://twitter.com/pyload) | ||
| [](https://www.facebook.com/pyload) | ||
| [](https://gitter.im/pyload/pyload?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](https://kiwiirc.com/client/irc.freenode.com/#pyload) | ||
| > - **[Master Branch](https://github.com/pyload/pyload/tree/master) | ||
| is under heavy development, very unstable, often broken.** | ||
| > - **[Stable Branch](https://github.com/pyload/pyload/tree/stable) | ||
| is production ready**. | ||
|
|
||
|
|
||
| Table of contents | ||
| ----------------- | ||
|
|
||
| - [Status](#status) | ||
| - [Description](#description) | ||
| - [Supported Platforms](#supported-platforms) | ||
| - [Supported Interpreters](#supported-interpreters) | ||
| - [Installation](#installation) | ||
|
|
@@ -60,18 +50,37 @@ Table of contents | |
| - [Open Source License](#open-source-license) | ||
| - [Alternative License](#alternative-license) | ||
| - [Contributor License Agreement](#contributor-license-agreement) | ||
| - [Contact Us](#contact-us) | ||
| - [Credits](#credits) | ||
| - [Release History](#release-history) | ||
|
|
||
|
|
||
| Status | ||
| ------ | ||
|
|
||
| [](https://travis-ci.org/pyload/pyload) | ||
| [](https://ci.appveyor.com/project/vuolter/pyload/branch/master) | ||
| [](https://requires.io/github/pyload/pyload/requirements/?branch=master) | ||
| [](https://www.codacy.com/app/pyLoad/pyload?utm_source=github.com&utm_medium=referral&utm_content=pyload/pyload&utm_campaign=Badge_Grade) | ||
| [](https://scrutinizer-ci.com/g/pyload/pyload/?branch=master) | ||
|
|
||
|
|
||
| Description | ||
| ----------- | ||
|
|
||
| `pyLoad` is the Free and Open Source download manager written in Pure Python | ||
| and designed to be extremely lightweight, fully customizable and remotely | ||
| manageable. | ||
|
|
||
|
|
||
| Supported Platforms | ||
| ------------------- | ||
|
|
||
| **pyLoad** works with **Windows**, **MacOS** and Unix based systems like | ||
| `pyLoad` works with **Windows**, **MacOS** and Unix based systems like | ||
| **Linux** and **FreeBSD**. | ||
|
|
||
| Embedded platforms, proprietary NAS and routers systems are NOT officially | ||
| supported, **pyLoad** may crash unexpectately or NOT work at all under them! | ||
| supported, `pyLoad` may crash unexpectately or NOT work at all under them! | ||
|
|
||
| > **Note:** | ||
| > Currently, **MacOS** and **BSD** platforms are NOT fully supported, | ||
|
|
@@ -81,20 +90,20 @@ supported, **pyLoad** may crash unexpectately or NOT work at all under them! | |
| Supported Interpreters | ||
| ---------------------- | ||
|
|
||
| To run **pyLoad** you must have installed on your system the | ||
| To run `pyLoad` you must have installed on your system the | ||
| [Python interpreter](https://www.python.org). | ||
|
|
||
| You need at least `Python2.6` or `Python3.3` to run **pyLoad**. | ||
| You need at least `Python2.6` or `Python3.3` to run `pyLoad`. | ||
| Python versions from `Python3.0` to `Python3.2` are NOT supported! | ||
|
|
||
| An **experimental support** for [PyPy](http://pypy.org) is available; | ||
| as expected you need at least `PyPy2.6` or `PyPy3.3` to run **pyLoad**. | ||
| as expected you need at least `PyPy2.6` or `PyPy3.3` to run `pyLoad`. | ||
|
|
||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| You can install **pyLoad** in several ways: | ||
| You can install `pyLoad` in several ways: | ||
| - [PIP install](#pip-install) _(recommended on Unix based systems)_ | ||
| - [Tarball Install](#tarball-install) | ||
|
|
||
|
|
@@ -118,7 +127,7 @@ to **install** the pyLoad package. | |
| > the [PIP install method](#pip-install). | ||
| > **Note:** | ||
| > To install **pyLoad** using the [PIP install method](#pip-install) you need | ||
| > To install `pyLoad` using the [PIP install method](#pip-install) you need | ||
| > the package [pip](https://pypi.python.org/pypi/pip), **version 7 or later**. | ||
| > To learn how to install it see <https://pip.pypa.io/en/stable/installing/>. | ||
|
|
@@ -163,7 +172,7 @@ Usage | |
|
|
||
| ### Quick Start | ||
|
|
||
| To run **pyLoad** with the default profile, just type in your command shell: | ||
| To run `pyLoad` with the default profile, just type in your command shell: | ||
|
|
||
| pyload | ||
|
|
||
|
|
@@ -195,13 +204,13 @@ listening to the configured ip address and port | |
|
|
||
| ### Advanced Options | ||
|
|
||
| **pyLoad**'s command line supports several options: | ||
| `pyLoad`'s command line supports several options: | ||
| `start`, `stop`, `restart`, `version`. | ||
|
|
||
| > **Note:** | ||
| > If you do not enter any option, `start` will be used. | ||
| To run **pyLoad** with a custom profile, type: | ||
| To run `pyLoad` with a custom profile, type: | ||
|
|
||
| pyload start --profile <profilename> | ||
|
|
||
|
|
@@ -219,7 +228,7 @@ Shorten: | |
| > **Note:** | ||
| > If you do not enter any `<profilename>`, the string `default` will be used. | ||
| To run **pyLoad** with a custom config folder: | ||
| To run `pyLoad` with a custom config folder: | ||
|
|
||
| pyload start --configdir <dirpath> | ||
|
|
||
|
|
@@ -249,7 +258,7 @@ To **restart** a pyLoad instance, type: | |
|
|
||
| ### Script Usage | ||
|
|
||
| To import **pyLoad** in your script, enter: | ||
| To import `pyLoad` in your script, enter: | ||
|
|
||
| import pyload.core | ||
|
|
||
|
|
@@ -332,14 +341,14 @@ Available methods: | |
| > **Note:** | ||
| > To terminate a single pyLoad instance you MUST pass its profile name to the | ||
| > function `pyload.core.quit`, otherwise all the running instances of **pyLoad** | ||
| > function `pyload.core.quit`, otherwise all the running instances of `pyLoad` | ||
| > will be terminated! | ||
| > **Note:** | ||
| > Calling function `pyload.core.restart` without a proper profile name will | ||
| > force to try to terminate the `default` profile one. | ||
| A quick example of how *start & stop* a couple instances of **pyLoad** launched | ||
| A quick example of how *start & stop* a couple instances of `pyLoad` launched | ||
| concurrently: | ||
|
|
||
| import pyload | ||
|
|
@@ -373,7 +382,7 @@ accurately the problem you encounter. | |
| first start** or we cannot help you. | ||
|
|
||
| > **Note:** | ||
| > To learn how to start **pyLoad** in *debug mode* see the | ||
| > To learn how to start `pyLoad` in *debug mode* see the | ||
| > [Usage Section](#usage). | ||
| ### Submit a Code Contribution | ||
|
|
@@ -429,6 +438,7 @@ Contact us at [email protected] for any question about our code licensing. | |
| ### Contributor License Agreement | ||
|
|
||
| Please refer to the included [CLA](/CLA.md) for the extended agreement. | ||
| [](https://cla-assistant.io/pyload/pyload) | ||
|
|
||
| However, to summarise, this is essentially what you will be agreeing to: | ||
|
|
||
|
|
@@ -445,6 +455,16 @@ Please contact us at [email protected] if you wish to contribute to the project, | |
| but feel you cannot sign the agreement. | ||
|
|
||
|
|
||
| Contact Us | ||
| ---------- | ||
|
|
||
| [](https://pyload.net) | ||
| [](https://twitter.com/pyload) | ||
| [](https://www.facebook.com/pyload) | ||
| [](https://gitter.im/pyload/pyload?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](https://kiwiirc.com/client/irc.freenode.com/#pyload) | ||
|
|
||
|
|
||
| Credits | ||
| ------- | ||
|
|
||
|
|
||
Empty file.