rkale
Install
Install rkale in your project using poetry:
poetry add rkale
Use pip if you want a global installation:
pip install rkale
Configuration
Global
~/.config/rkale/rkale.conf:
[data]
root = "path to data folder where datasets are stored"
[aliases]
wasabi = "optional alias for remote in rclone.conf"
[rclone] # global flags for rclone
flags = ["--transfers 32", "--checkers 32"]
If aliases are empty the remote name from the project config is used in the rclone lookup.
Project
Configure project datasets in the pyproject.toml file:
<project path>/pyproject.toml:
[[tool.rkale.dataset]]
name = "dataset_1"
remote = "remote_1"
[[tool.rkale.dataset]]
name = "dataset_2"
remote = "remote_2"
The remote specified for the dataset must match a remote in the rclone.conf
or an alias in the global rkale configuration.
Usage
Python interface
from rkale.config import dataset_paths
def dataset_path():
return dataset_paths()["dataset_1"]
Syncing datasets
Syncs the local datasets to be identical to the remote
rkale psync
Syncs the remote datasets to be identical to the local
rkale psync --upstream
Same as rclone sync but checks differences first and asks for confirmation
rkale sync <source> <destination>
1 maintainer
Metadata
1 maintainer
Release files for rkale 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rkale-1.0.3.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rkale-1.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.3 kB
Release files / rkale-1.0.3.tar.gz
| Download URL | rkale-1.0.3.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f44124caf605d182c354db6eee94d036810d5878464905da0acbfd2893f4bd6
|
|
BLAKE2b-256 checksum How to use checksums |
ae45b44474c964b05797b62c2d89d5c98675d38ebd2d6dc5c1311e7a2234f00f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.8.18 Linux/6.5.0-1015-azure
|
Release files / rkale-1.0.3-py3-none-any.whl
| Download URL | rkale-1.0.3-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15148411e5ea676e00c5ceb6468e4086dda8d41399cdee0ce6623b712dbe9bd6
|
|
BLAKE2b-256 checksum How to use checksums |
38a878442a950ce06b496dd9a4f6722858059b92060ad7e3b8b59c5434fc21ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.8.18 Linux/6.5.0-1015-azure
|
