Metadata-Version: 2.1
Name: onedrivedownloader
Version: 1.1.3
Summary: Python utility to download files through OneDrive
Home-page: https://github.com/loribonna/onedrivedownloader
Author: Lorenzo Bonicelli
Author-email: loribonna@gmail.com
License: MIT
Download-URL: https://github.com/loribonna/onedrivedownloader/archive/refs/tags/v1.1.3.zip
Keywords: onedrive,downloader,download,python,utility
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests
Requires-Dist: tqdm

# OneDrive downloader: python utility to download files from OneDrive


## Install (PyPI)
`pip install onedrivedownloader`

First stable release: `1.0.0`

Current: `1.1.3`

*Do not require authentication.*

### Requires
- `tqdm`: for nice progress bar
- `requests`: fetch data from OneDrive

## Usage
```
from onedrivedownloader import download

...

download(url: str, filename: str, unzip=False, unzip_path: str = None, force_download=False, force_unzip=False, clean=False)
```

### Required parameters:
- `url`: The url to download from (should end with '?download=1').
- `filename`: The filename to save the file as.

### Optional parameters:
- `unzip`: want to unzip file or just download? If file is not `.zip`, do nothing.
- `unzip_path`: path to unzip files (default: current directory)
- `force_download`: force files download if exist? (default: False)
- `clean`: clean source file after unzip?

## Example
```
ln = "https://unimore365-my.sharepoint.com/:u:/g/personal/215580_unimore_it/EUmqgpzRz3tPlD2KiVNRqdABBJl7qQYcIeROtMc4g2UeIA?e=zZtkLr"

download(ln, filename="file.zip", unzip=True, unzip_path="./data")
```

