Skip to main content

A python wrapper for rclone.

Project description

MIT License

py-rclone

A python wrapper for rclone that makes rclone's functionality usable in python. rclone needs to be installed on the system for the wrapper to work.

Features

  • Copy and move files between remotes
  • Delete and prune files/directories
  • Create new remotes
  • Check available remotes

Demo

Create new remote

Create a new rclone remote connection with rclone's default client-id and client-secret.

from py_rclone import rclone
from py_rclone.remote_types import RemoteTypes

rclone.create_remote('onedrive', RemoteTypes.onedrive)

Additionally, client-id and client-secret can be used with many ckoud providers.

from py_rclone import rclone
from py_rclone.remote_types import RemoteTypes

rclone.create_remote('onedrive', RemoteTypes.onedrive, client_id='YOUR_CLIENT_ID', client_secret='YOUR_CLIENT_SECRET')

Copy

from py_rclone import rclone

# copy all file in the test_dir on OneDrive to the local data folder.
rclone.copy('onedrive:test_dir', 'data')

Delete

Delete a file or a directory. When deleting a directory, only the files in the directory (and all it's subdirectories) are deleted, but the folders remain.

from py_rclone import rclone

# delete a specific file on onedrive
rclone.delete('onedrive:data/video1.mp4')

Prune

from py_rclone import rclone

# remove the entire test_dir folder (and all files contained in it and it's subdirectories) on onedrive
rclone.purge('onedrive:test_dir')

Copying from onedrive:test_dir to data |████████████████████████████████████████| 100% in 18.0s (5.56%/s)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rclone-python-0.0.1.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file rclone-python-0.0.1.tar.gz.

File metadata

  • Download URL: rclone-python-0.0.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for rclone-python-0.0.1.tar.gz
Algorithm Hash digest
SHA256 edfcf99a0e2d3327a41acf39b6de141cca4d495f56cad738e254c0fd38e2aa10
MD5 de044a82393b993ad7ed47f968acadd3
BLAKE2b-256 fb7926e6fa2e06f8f7d0d27cd2761bfa2f256d4c835c1f55a9ab3f9ec7b2f987

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page