Renamed files and updated Readme

README.md

@@ -1,12 +1,22 @@
-# zotero-reMarkable-sync
+# zotero - reMarkable Synchronization
 
-# TODO: Update readme
+Synchronize all the .pdf files in your [Zotero](https://www.zotero.org) library with your [reMarkable](https://remarkable.com) device.
 
-This repository allows you to synchronize all the .pdf files from your [Zotero](https://www.zotero.org) library to your [reMarkable](https://remarkable.com) device.
+![picture alt](images/workflow.png "Title is optional")
 
-How does it work?
-1. Download all the .pdf files from the Zotero library to a local folder `<dir-name>`
-2. Synchronize the `<dir-name>` to your reMarkable `/<dir-name>` folder.
+##### How does it work?
+
+1. Fetch files from Zotero
+2. Fetch files from reMarkable
+3. Compare with the last sync files stored in `~/.zot_rm_sync/<dir-name>`
+4. Pull changes from Zotero (add new files and remove deleted files)
+5. Push changes to reMarkable (add new files and remove deleted files)
+6. Pull changes from reMarkable (remove deleted files)
+7. Push changes to Zotero (remove deleted files)
+
+Note:
+- New files are expected to be added to Zotero only. Files added manually to the reMarkable `/<dir-name>` directory will be ignored.
+- reMarkable annotations are not saved in Zotero
 
 
 ## Requirements
@@ -15,34 +25,35 @@ Tested on Python 3.6
 ``` bash
 pip install -r requirements.txt
 ```
+
 ## Authorization
 ### reMarkable
 
-Get a **Security Code** from https://my.remarkable.com/connect/remarkable and run ***authorize_rmapy.py***
+Get a [**Security Code**](https://my.remarkable.com/connect/remarkable) and run ***authorize_rmapy.py***
 
 ``` bash
 python authorize_rmapy.py --security-code <security-code>
 ```
 
-### zotero
+### Zotero
 
-Get your **Zotero Library ID** and **Zotero API Key** from https://www.zotero.org/settings/keys
+Get your [**Zotero Library ID** and **Zotero API Key**](https://www.zotero.org/settings/keys)
 
 
 ## Use
 
 ``` bash
-python sync.py --zot-library-id <zot-library-id> --zot-api-key <zot-api-key> --directory <dir-name> [--verbose]
+python sync.py --zot-library-id/-l <zot-library-id> --zot-api-key/-k <zot-api-key> --directory/-d <dir-name> [--verbose/-v]
 ```
 
 ## Features
-- [x] Download .pdf files from Zotero Library
+- [x] Download .pdf files from the Zotero Library
 - [x] Upload .pdf files to reMarkable
-- [x] Keep the directory structure
+- [x] Maintain directory structure
 - [x] Prevent duplicate uploads and downloads
+- [x] Delete files from reMarkable if they are deleted in the Zotero library
 - [ ] Support more file extensions like .epub
-- [ ] Delete files from reMarkable if they are deleted in the Zotero library
-- [ ] Update files in the Zotero Library with the reMarkable annotations
+- [ ] Update files in Zotero Library with reMarkable annotations
 
 
 ##### Thanks to @urschrei and @subutux for the fantastic APIs  

authorize_rmapy.py

@@ -1,10 +1,10 @@
 import sys
 import argparse
-from rM_utils import authorize
+from utils.remarkable import authorize
 
 def get_args():
     """Command line argument parsing"""
-    
+
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--security-code", "-s",

sync.py

@@ -2,9 +2,9 @@
 import sys
 import argparse
 from colorama import Fore, Style
-from common import list_local_files, compare
-from zotero_utils import Zotero
-from rM_utils import ReMarkable
+from utils.common import list_local_files, compare
+from utils.zotero import Zotero
+from utils.remarkable import ReMarkable
 
 def get_args():
     """Command line argument parsing"""
@@ -136,7 +136,3 @@ def main():
 
 if __name__ == "__main__":
     main()
-
-
-
-#

rM_utils.py → utils/remarkable.py

@@ -5,7 +5,7 @@
 from rmapy.exceptions import AuthError
 from rmapy.folder import Folder
 from rmapy.document import ZipDocument
-from common import File
+from utils.common import File
 
 class ReMarkable():
 
@@ -239,7 +239,7 @@ def authorize(security_code):
     Returns: True is authorized, False otherwise
 
     """
-    
+
     rma = Client()
 
     try:

zotero_utils.py → utils/zotero.py

@@ -3,7 +3,7 @@
 from colorama import Fore, Style
 from pyzotero import zotero
 from pyzotero.zotero_errors import UserNotAuthorised
-from common import File
+from utils.common import File
 
 class Zotero():