Metadata-Version: 2.1
Name: django-rclone-storage
Version: 0.1.1
Summary: A simple wrapper for Rclone as a Django storage
Home-page: https://github.com/ElnathMojo/django-rclone-storage
Author: ElnathMojo
Author-email: ElnathMojo@gmail.com
License: BSD-3-Clause
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: Django (>=2.2)

# Django Rclone Storage

A simple wrapper for Rclone as a Django storage.

## Usage

First, add these settings to your Django settings:

```python
# The remote name in your rclone.conf
RCLONE_REMOTE = 'onedrive'
# Remote path where all the files will be uploaded. Default: /
RCLONE_REMOTE_ROOT = '/'
# Local path where your rclone.conf locates. If it's not set, rclone should use the default .conf file.
RCLONE_CONFIG_PATH = '/path/to/config'
```

And, set the default storage:

```python
DEFAULT_FILE_STORAGE = 'rclonestorage.rclone_remote.RcloneRemoteStorage'
```

Or, you can just pass the settings to a RcloneRemoteStorage object and use it in the FileField:

```python
file = models.FileField(
    storage=RcloneRemoteStorage(remote='remote',
                                root_path='/',
                                config_path='/path/to/config')
)
```

## Reference
[django-storages](https://github.com/jschneier/django-storages)

[python-rclone](https://github.com/ddragosd/python-rclone)



