Skip to main content

Python interface for rclone

Project description


Rclone for your python environment and your virtual environment.Comes bundled with the Rclone binary so, no need to have Rclone pre-installed.


  • The installation automatically downloads the rclone binaries so there is no prerequisite to having rclone prior.
  • Run the following to install:
    pip install pyclone-module


  • If you already have the rclone pre-installed and want to use that specific binary you can set the paths using the the pyclone.set_path() method:
    import pyclone



  • Pyclone is a wrapper or rclone, so you can use the same commands you regularly use in rclone. Visit for further information.

    user:~$ pyclone config

Import Pyclone into your projects

  • Importing pyclone into your projects to have programatic control of rclone is as simple as import pyclone. Further usage will require some knowlegde on some of the classes.

    import pyclone
    pyc = pyclone.Pyclone()

Pyclone classes

There are three major classes in Pyclone:

  • pyclone.Pyclone()
  • pyclone.RemoteManager()
  • pyclone.Remote()

1. pyclone.Pyclone()

  • This is the main pyclone object that is ressponsible for communicating with the Rclone shell. You will be dealing with this class mostly. Instanitate it like this

    import pyclone
    pyc = pyclone.Pyclone()

1.1 pyclone.Pyclone().execute(command)

  • Pyclone utilizes the subprocess module to communicate with the shell and the execute method allows you to send commands directly to rclone. Commands have to are expected to be in list format. This returns a Response object which contains the text, stdout, stderr, responsecode and args instance variables.

    >>> import pyclone
    >>> command = ['help']
    >>> pyc = pyclone.Pyclone()
    >>> response = pyc.execute(command)
    >>> print(reponse.responsecode)
    >>> print(repsponse.text)

1.2 Create a Remote pyc.config_create()

  • import pyclone
    pyc = pyclone.Pyclone()
    pyc.config_create('remote_type', 'remote_name', '', 'remote_pass')

1.3 Delete a remote pyc.config_delete()

  • pyc.config_delete('remote_name')

1.4 Move/Copy pyc.copy()/pyc.move()

  • Note that the the remote has to be appended by a colon at the end which will end up looking like: pyc.copy(, 'remote:')

    pyc.copy('src:path', 'dest:path')
    pyc.move('src:path', 'dest:path')

1.5 List directory (ls) pyc.copy()/pyc.move()


Using the Remote Manager and Remote object

2 pyclone.RemoteManager()

  • The Remote Mangager brings everything together by mangaing your remotes, and extending the functionality of the Pyclone and Remote objects.

    >>> import pyclone
    >>> remotes = pyclone.RemoteManager()
    ['remote_A', 'remote_B']

1.2 Create/Deleting a Remote remotes.create()/remotes.delete()

  • remotes.create('remote_type', 'remote_name', '', 'remote_pass')

Remote Objects

2.1 Get a Remote remotes.get_remote()

  • This returns a Remote object that inherits most of its functionality from the Pyclone object.

    remote_A = remotes.get_remote('remote_A')

2.2 Remote methods

  • remote.copy('file', dl=False)
    • If dl=True this will download the file from the remote.
  • remote.move('file:path', dl=False)
    • If dl=True this will download the file from the remote.
  • remote.delete('file:path')
  • remote.size()


  • Non-blocking subprocesses
  • pyclone.Remote.check()

Developing pyclone

To install pyclone, along with all the tools you need to develop and run tests, run the following in your virtualenv:

user:~$ pip install -e .[dev]

Drop some feedback, bugs, and feature requests if you can.

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

pyclone-module-1.53.5.tar.gz (9.0 kB view hashes)

Uploaded source

Supported by

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