Metadata-Version: 2.0
Name: OnedriveCMD
Version: 0.1.0
Summary: A command line client for Onedrive.
Home-page: https://github.com/cnbeining/onedrivecmd
Author: Beining
Author-email: i@cnbeining.com
License: GPLv3
Keywords: onedrive backup
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: Utilities
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.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: onedrivesdk
Requires-Dist: progress
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

onedrivecmd
=======

A command line client for Onedrive(including Office 365 and Business).

Based on [onedrive-sdk-python](https://github.com/OneDrive/onedrive-sdk-python) , with lots of modifications.

This is very much a copycat of [megacmd](https://github.com/t3rm1n4l/megacmd) , but in different language.

### Why onedrivecmd?
Onedrive is a cloud-storage service provided by Microsoft. Education users can get 1TB of storage for free, which can be redeemed at https://products.office.com/en-us/student?tab=students .

Since the recent update of Onedrive's API, there aren't a lot of *nix softwares that would provide support to Onedrive, most of them are syncing softwares: But I prefer have more control of what I am doing. So here it is, a tiny client that can do the jobs for you.

### Features
  - Ability to access files and folders using a path URI
  - Configuration file (./onedrive.json)
  - Individual file put and get operations
  - List operation (shows filesize and timestamp)
  - Download and upload with native progress bar (with option of downloading with aria2!)
  - Remote download links to your drive(NEW! Not even available via Web console) (Only available at personal due to API limit)
  - Supports Office 365!
  - Python 2 and 3 compatible. Tested with lots of cases but please report if it is not working somehow.

### Usage
    Usage ./onedrivecmd.py:
        onedrivecmd.py -h 
        onedrivecmd.py [OPTIONS] init
        onedrivecmd.py [OPTIONS] init business
        onedrivecmd.py [OPTIONS] list od:/foo/bar/
        onedrivecmd.py [OPTIONS] get od:/foo/file.txt /tmp/
        onedrivecmd.py [OPTIONS] put /tmp/hello.txt od:/bar/
        onedrivecmd.py [OPTIONS] delete od:/foo/bar
        onedrivecmd.py [OPTIONS] mkdir od:/foo/bar/
        onedrivecmd.py [OPTIONS] remote http://thecatapi.com/api/images/get?format=src&type=gif
        onedrivecmd.py [OPTIONS] quota



      -conf="~/onedrive.json": Config file path, this file is as important as your password!
      -h: Help
      -hack: Use aria2 to download file, or the SDK's built-in uploader (without progress bar!)
      -recursive=false: Recursive listing
      -chunk=10485760: Chunk size when uploading
      -url=False: Only display the URL when downloading



### How to run onedrivecmd?

#### Install dependencies

There are 3 packages you should install:

    onedrivesdk
    progress
    requests

Do a ```pip install -r requirements.txt``` at the folder.

#### Login

Do a ```onedrivecmd.py init``` , or ```onedrivecmd.py init business``` if you are using Business or Office 365.

You shall be given a URL like

```
https://login.live.com/oauth20_authorize.srf?scope=wl.signin+wl.offline_access+onedrive.readwrite&redirect_uri=https%3A%2F%2Fod.cnbeining.com&response_type=code&client_id=aeba6391-92fd-437d-a9d9-33a258b96c4e
```

Authorize your login. 

Yes you shall be redirected to ```https://od.cnbeining.com/```, which apparently is owned by me. This page is hosted at [branch gh-pages](https://github.com/cnbeining/onedrivecmd/blob/gh-pages/index.html), with a Cloudflare at the front. I am doing this so you can just do a quick select-all and paste. If you have doubt, change the information in ```static.py```.

The login information is storaged at ```./onedrive.json```, or any location you demanded. This file should be treated as secret as your password.

After this very first time init, the ```access_token``` shall be refreshed every time you run the programme.


### Pitfalls
To list directory contents, use:

    $ onedrivecmd.py list od:/foo/bar/

Names ending with '/' is a directory. The size of directory is the size of the sum of its content.

To recursively list a directory use, -recursive option.

    $ onedrivecmd.py -recursive list od:/foo/bar/

The delete can only move the item to the trash bin, as there is no way of just delete the item. Make sure you clean your trash.

    $ onedrivecmd.py delete od:/foo/bar/file


### Examples

    $ python onedrivecmd.py  init

    https://login.live.com/oauth20_authorize.srf?scope=wl.signin+wl.offline_access+onedrive.readwrite&redirect_uri=https%3A%2F%2Fod.cnbeining.com&response_type=code&client_id=aeba6391-92fd-437d-a9d9-33a258b96c4e

    Paste this URL into your browser, approve the app's access.
    Copy all the code in the new window, and paste it below:
    Paste code here: Ma0d6f772-****-e5ea-8d5a-******    

    $ python onedrivecmd.py list od:/
    od:/133/	0	2016-09-24T04:17:58.957000Z
    od:/134/	0	2016-09-24T05:11:17.190000Z
    od:/New Folder/	351	2016-09-22T03:02:25.423000Z
    od:/1.png	342677	2016-09-24T04:28:51.617000Z
    od:/OneDrive 入门.pdf	1159342	2016-08-23T03:03:55.043000Z

    $ python onedrivecmd.py put /Users/Beining/Documents/1.png od:/
    Uploading |################################| 100.0% - 0s


    $ python onedrivecmd.py get od:/1.pdf
    Downloading |######                          | 21.4% - 74s

    $ python onedrivecmd.py -hack get od:/1.png
    [#e257f9 16KiB/334KiB(4%) CN:1 DL:230KiB ETA:1s]                                                                                                                            
    09/24 02:10:56 [NOTICE] Download complete: **onedrivecmd/1.png

    Download Results:
    gid   |stat|avg speed  |path/URI
    ======+====+===========+=======================================================
    e257f9|OK  |   343KiB/s|**onedrivecmd/1.png

    Status Legend:
    (OK):download completed.

    $ python onedrivecmd.py mkdir od:/145

    $ python onedrivecmd.py remote "http://wscont2.apps.microsoft.com/winstore/1x/.../Screenshot.225037.100000.jpg"
    https://api.onedrive.com/v1.0/monitor/...

    python onedrivecmd.py -conf="./onedrive.json" quota

    Total Size: 1.0TiB,
    Used: 1.6MiB,
    Remaining: 1024.0GiB,
    Deleted: 0.0B,

    Your state is: normal

### TODO

* Move
* Recursive list(could be my machine too slow)
* I will not write sync since we have [rclone](https://github.com/ncw/rclone) which already supports Onedrive. Feel free to send me pull requests though.
* I cannot think of anything. Open issues if you have amazing ideas.

### How to Contribute ?

Any PR or issue would be appreciated. 

### License

AGPL

### Author

Beining, https://www.cnbeining.com/ , ```i [at] cnbeining.com``` .

Driven by coffee, coffee and coffee.


### 中文说明

[点这里](https://github.com/cnbeining/onedrivecmd/wiki/%E4%B8%AD%E6%96%87%E8%AF%B4%E6%98%8E)

