Metadata-Version: 2.1
Name: pyDownload
Version: 0.0.1.dev3
Summary: A simple package for multithreaded downloading
Home-page: https://github.com/party98/Python-Parallel-Downloader
Author: Parth Verma
Author-email: v.parth98@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/party98/Python-Parallel-Downloader/issues
Project-URL: Say Thanks!, https://saythanks.io/to/party98
Project-URL: Source, https://github.com/party98/Python-Parallel-Downloader
Keywords: downloading multithreaded parallel multithreading multithreaded-downloading download
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: requests (>=2.0.0)
Provides-Extra: dev
Requires-Dist: pre-commit (==1.8.2); extra == 'dev'
Provides-Extra: test

# PyDownload

This package aims to provide the functionality to download large files from the internet using chunked and multithreaded downloads.

# Index
 - [Installation](#installation)
 - [Usage](#usage)
 - [Developer Guide](#developer-guide)
 - [SayThanks](#saythanks)

# Installation

```bash
pip install pydownload
```

# Usage

```python
import time
from pyDownload import Downloader

url = 'https://github.com/party98/Python-Parallel-Downloader/archive/master.zip'
downloader = Downloader(url=url)
if downloader.is_running:
    time.sleep(1)
print('File downloaded to %s' % downloader.file_name)
```



# Developer Guide

## Setting Up The Environment
 - ### Setup VirtualEnv (Recommended But Optional)
   ```bash
   pip install virtualenv
   virtualenv env
   source ./env/bin/activate
   ```
 - ### Install Dependencies
   ```bash
   pip install -r requirements.txt
   ```
 -  ### Install pre-commit hooks
    The project uses various pre-commit hooks to enforce code quality and standards. Therefore, it is really necessary for all the contributors to install these and run before every commit else the contributions will be rejected.

    ##### Steps
    ```bash
    pre-commit install
    ```

## Running Tests
 - ### Install Dependencies
   ```
   pip install nose coverage
   ```
 - ### Run the Tests
   - #### With Coverage Report (Recommended)
     ```
     nosetests --cover-erase --cover-package=pyDownload --with-coverage --cover-branches
     ```
   - #### Without Coverage Report
     ```
     nosetests --cover-erase --cover-package=pyDownload  --cover-branches
     ```


# SayThanks

You can thank the team [here](https://saythanks.io/to/party98).


