From 932412c2390c51d505dd159dad418d78f342e3b9 Mon Sep 17 00:00:00 2001 From: Maday <76758776+heartlog@users.noreply.github.com> Date: Sat, 16 Sep 2023 13:44:51 +0530 Subject: [PATCH 1/4] Update README.md Made changes to file to fit PYPI standards. --- README.md | 70 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 57d17e1..ae9825a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -Python Smart Download Manager -- pySmartDL -========================================== +# Python Smart Download Manager -- pySmartDL -``pySmartDL`` strives to be a full-fledged smart download manager for Python. Main features: +`pySmartDL` strives to be a full-fledged smart download manager for Python. Main features: -* Built-in download acceleration (with the `multipart downloading technique `_). +* Built-in download acceleration (with the `multipart downloading technique` ). * Mirrors support. * Pause/Unpause feature. * Speed limiting feature. @@ -12,48 +11,53 @@ Python Smart Download Manager -- pySmartDL * Full support for custom headers and methods. * Python 3 Support -Project Links -============= +## Project Links - * Downloads: http://pypi.python.org/pypi/pySmartDL/ - * Documentation: http://itaybb.github.io/pySmartDL/ - * Project page: https://github.com/iTaybb/pySmartDL/ - * Bugs and Issues: https://github.com/iTaybb/pySmartDL/issues - -Installation -============ +* Downloads: -**Using pip (recommended way)** +* Documentation: - Make sure python-pip is installed on you system. If you are using virtualenv, then pip is alredy installed into environments created by virtualenv. Run pip to install pySmartDL: +* Project page: - ``pip install pySmartDL`` +* Bugs and Issues: -**From Source** +## Installation - The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution `_ first. Unpack the source zip and run the following to install the package site-wide: +### Using pip (Recommended way) - ``python setup.py install`` - -Usage -===== +> Make sure python-pip is installed on you system. Ifyou are using virtualenv, then pip is alredy installedinto environments created by virtualenv. Run pip toinstall pySmartDL: + +```shell +pip install pySmartDL +``` + +### From Source + +> The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution` first. Unpack the source `zip`` and run the following to install the package site-wide: + +```shell +python setup.py install +``` + +## Usage Download is as simple as creating an instance and starting it: - from pySmartDL import SmartDL +```py +from pySmartDL import SmartDL - url = "https://github.com/iTaybb/pySmartDL/raw/master/test/7za920.zip" - dest = "C:\\Downloads\\" # or '~/Downloads/' on linux +url = "https://github.com/iTaybb/pySmartDL/raw/master/test/7za920.zip" +dest = "C:\\Downloads\\" # or '~/Downloads/' on linux - obj = SmartDL(url, dest) - obj.start() - # [*] 0.23 Mb / 0.37 Mb @ 88.00Kb/s [##########--------] [60%, 2s left] +obj = SmartDL(url, dest) +obj.start() +# [*] 0.23 Mb / 0.37 Mb @ 88.00Kb/s [##########--------] [60%, 2s left] - path = obj.get_dest() +path = obj.get_dest() +``` -Requirements -============== +## Requirements - * Python 3.4 or greater. +* Python 3.4 or greater. -Copyright (C) 2014-2020 Itay Brandes. \ No newline at end of file +Copyright (C) 2014-2020 Itay Brandes. From 6e3116032b54a629e7ddd72db45df6624b8b67fd Mon Sep 17 00:00:00 2001 From: Maday <76758776+heartlog@users.noreply.github.com> Date: Sat, 16 Sep 2023 13:46:18 +0530 Subject: [PATCH 2/4] Update README.md . --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae9825a..12d4735 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,9 @@ ### Using pip (Recommended way) -> Make sure python-pip is installed on you system. Ifyou are using virtualenv, then pip is alredy installedinto environments created by virtualenv. Run pip toinstall pySmartDL: +> Make sure `python-pip` is installed on you system. +> If you are using `virtualenv`, then `pip` is alredy installed into environments created by virtualenv. +> Run `pip toinstall pySmartDL`: ```shell pip install pySmartDL From 83b24e9c0a3b1afd488325c21f48cde15cdbf4f2 Mon Sep 17 00:00:00 2001 From: Maday <76758776+heartlog@users.noreply.github.com> Date: Sat, 16 Sep 2023 13:47:46 +0530 Subject: [PATCH 3/4] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 12d4735..1f98923 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,9 @@ ### Using pip (Recommended way) -> Make sure `python-pip` is installed on you system. -> If you are using `virtualenv`, then `pip` is alredy installed into environments created by virtualenv. -> Run `pip toinstall pySmartDL`: +Make sure `python-pip` is installed on you system. +If you are using `virtualenv`, then `pip` is alredy installed into environments created by virtualenv. +Run `pip toinstall pySmartDL`: ```shell pip install pySmartDL @@ -35,7 +35,7 @@ pip install pySmartDL ### From Source -> The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution` first. Unpack the source `zip`` and run the following to install the package site-wide: +The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution` first. Unpack the source `zip`` and run the following to install the package site-wide: ```shell python setup.py install From 2d119e021e45f87a5f6950a00a0f77cbd491df49 Mon Sep 17 00:00:00 2001 From: Maday <76758776+heartlog@users.noreply.github.com> Date: Sat, 16 Sep 2023 13:54:44 +0530 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f98923..6efa367 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ pip install pySmartDL ### From Source -The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution` first. Unpack the source `zip`` and run the following to install the package site-wide: +The pySmartDL package is installed from source using distutils in the usual way. Download the `source distribution` first. Unpack the source `zip` and run the following to install the package site-wide: ```shell python setup.py install