☁ rclone-python ☁️
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
Installation
rclone_python can be installed using pip
pip install rclone-python
or by cloning this repository and running from within the root of the project
pip install .
How to use
All functionally of this wrapper is accessible in the rclone class of the rclone_python package.
The following example checks if rclone is installed.
from rclone_python import rclone
print(rclone.is_installed())
# True
Create new remote
Create a new rclone remote connection with rclone's default client-id and client-secret.
from rclone_python import rclone
from rclone_python.remote_types import RemoteTypes
rclone.create_remote('onedrive', RemoteTypes.onedrive)
Additionally, client-id and client-secret can be used with many cloud providers.
from rclone_python import rclone
from rclone_python.remote_types import RemoteTypes
rclone.create_remote('onedrive', RemoteTypes.onedrive, client_id='YOUR_CLIENT_ID', client_secret='YOUR_CLIENT_SECRET')
Copy
from rclone_python import rclone
# copy all file in the test_dir on OneDrive to the local data folder.
rclone.copy('onedrive:test_dir', 'data')
# Copying from onedrive:test_dir to data |████████████████████████████████████████| 100% in 18.0s (5.56%/s)
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 rclone_python import rclone
# delete a specific file on onedrive
rclone.delete('onedrive:data/video1.mp4')
Prune
from rclone_python 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')
1 maintainer
Metadata
1 maintainer
Release files for rclone-python 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rclone-python-0.0.4.tar.gz | 4.9 kB | Details |
Release files / rclone-python-0.0.4.tar.gz
| Download URL | rclone-python-0.0.4.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c57ad871feb0bdf2906852af8326b43727fcd509b823f46521f320ceddaf938a
|
|
BLAKE2b-256 checksum How to use checksums |
82b0a65a95eedb20789dbc2faddc10459166c6b589c057a48e22bc71179bd157
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.4
|
