rclone's Introduction

Rclone for Python

🚀 Python wrapper for rclone.

Requirements

🐍 Python>=3.6

⬇️ Installation

pip install rclone

⌨️ Usage

from rclone.rclone import Rclone

rc = Rclone()

📕 Examples

pathname = 'gdrive:/remote/path'  # you can also use a local path


rc.copy('foo.txt', 'remote:/path/to/dst')
# 100%|███████████████████████████████████████| 0.16/0.16 [00:00<00:00,  1.13MB/s]

rc.move('bar.bin', 'remote:/path/to/dst')
# 100%|███████████████████████████████████████| 0.16/0.16 [00:00<00:00,  1.34MB/s]

rc.unit = 'B'
rc.copy('foo.txt', 'remote:/path/to/dst')
# 100%|███████████████████████████| 159414.0/159414.0 [00:00<00:00, 1003822.00B/s]

rclone.ls('remote:/path/to/dir')
# ['foo.bin', 'bar.txt', 'foo/']

rclone.lsjson('remote:/path/to/dir')
# [
#     {
#         'Path': 'bar.txt',
#         'Name': 'bar.txt',
#         'Size': 0,
#         'MimeType': 'text/plain; charset=utf-8',
#         'ModTime': '2022-03-22T13:07:53.557168464-04:00',
#         'IsDir': False
#     }
# ]

rclone.ls('remote:/path/to/dir', '-R')  # you can supply additional flags to any command as positional argments
# ['foo.bin', 'bar.txt', 'foo/', 'foo/foo1.txt', 'foo/foo2', 'foo/bar/foobar.txt']

rclone.size('remote:/path/to/dir')
# {'total_objects': 5, 'total_size': 170397}

You can also use whatever subcommands/flags with execute():

# 
rclone.execute('ls "remote:/path/to/dir" --exclude *.txt')
#       27 foo.bin
#   159414 foo.csv.zip
#     4808 rclone.py

rclone's People

Contributors

Stargazers

Watchers

rclone's Issues

the scripts fails when there are rclone warnings

$ rclone lsjson googledrive:dir1
[
2023/06/19 11:30:56 NOTICE: Dangling shortcut "GoogleDoc1" detected
2023/06/19 11:30:56 NOTICE: Dangling shortcut "GoogleDoc2" detected
{"Path":"GoogleDoc3.docx","Name":"GoogleDoc3.docx","Size":-1,"MimeType":"application/vnd.openxmlformats-officedocument.wordprocessingml.document","ModTime":"2010-11-10T14:09:30.727Z","IsDir":false,"ID":"1lfoJixyFffiNT9YDz9QDiJ7vsOq9sE9YedQGlJLSsEz"},
...

When I use the python rclone library, it takes the full output, including these NOTICE warnings, and then it fails to parse the json content.

the path needs to be shell quoted

the path needs to be shell quoted.
my current workaround is like this:

path="owncloud:example dir with space/file.txt"
from rclone.rclone import Rclone
import shlex
rc = Rclone()
rc.lsjson(shlex.quote(path))

i don't know what is best, to add the shlex.quote from inside your script, or from outside just as I am doing here (the rclone functions allow to pass other parameters, and path might not be the first one). If the second choice is best, then this could be documented in your README.md file.

Recommend Projects