Metadata-Version: 2.1
Name: dir-sync
Version: 0.1.5
Summary: Sync files in the local folder with files in the remote location, e.g. Google Drive.
Home-page: https://github.com/mingchaoliao/dir-sync
Author: Mingchao Liao
Author-email: mingchaoliao95@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.6
Requires-Dist: google-api-python-client
Requires-Dist: google-auth-httplib2
Requires-Dist: google-auth-oauthlib

dir-sync
========

Sync files in the local folder with files in the remote location,
e.g. Google Drive.

Install
-------

1. Run the following command in your command line:

.. code:: bash

   pip install dir-sync

2. Check the version you installed:

.. code:: bash

   $ dir-sync --version
   Version: X.X.X

Command Options
---------------

+-----------------+-----------------+-----------------+-----------------+
| Option          | Description     | Required        | Default         |
+=================+=================+=================+=================+
| –src-type       | Source type.    | Yes             |                 |
+-----------------+-----------------+-----------------+-----------------+
| –dst-type       | Destination     | Yes             |                 |
|                 | type.           |                 |                 |
+-----------------+-----------------+-----------------+-----------------+
| –src            | Source          | Yes             |                 |
|                 | directory path. |                 |                 |
|                 | The value       |                 |                 |
|                 | depends on the  |                 |                 |
|                 | source type.    |                 |                 |
+-----------------+-----------------+-----------------+-----------------+
| –dst            | Destination     | Yes             |                 |
|                 | directory path. |                 |                 |
|                 | The value       |                 |                 |
|                 | depends on the  |                 |                 |
|                 | source type.    |                 |                 |
+-----------------+-----------------+-----------------+-----------------+
| –auth-key-file  | Path to auth    | Yes             |                 |
|                 | key file.       |                 |                 |
+-----------------+-----------------+-----------------+-----------------+

Filesystem Adapter
------------------

Depends on the source type and destination type, the value of source
directory path and destination directory path can be vary.

Local Filesystem
~~~~~~~~~~~~~~~~

When ``--src-type`` or ``--dst-type`` is ``local``, the
``--src``/``--dst`` must be a valid directory path in your local
filesystem.

Google Drive
~~~~~~~~~~~~

When ``--src-type`` or ``--dst-type`` is ``google-drive``, the
``--src``/``--dst`` must be a valid Google Drive directory ID.
(reference: https://developers.google.com/drive/api/v3/reference/files)


