new config file based version

Author: arehbein-git

README.md

@@ -13,25 +13,39 @@ As the plex server is not compatible with xmp metadata inside photos, this pytho
 
 ## what you need to change
 
-### change values to fit your installation in plexUsers.py
+### change values to fit your installation in config.py
 
 ```python
-#if you do not have a token you have to supply your credentials
-PLEX_LOGIN = ''
-PLEX_PASS = ''
-# if you already have a token pass it here
-PLEX_TOKEN = ''
-# the plex server url
-PLEX_URL = 'http://192.168.0.200:32400' # including http(s) (local url is best)
-# provide the usernames for which the rating should be updated
-# when users have a pin we need this, otherwise set it to ''
-USERDATA = { 'user': '1234' }
-
-# for the access tokens we need the exact server name
-SERVERNAME = 'plex'
-
-# path of the photo library in plex
-PHOTOS_LIBRARY_PATH = '/share/Photos'
+    ####################### Change HERE #######################
+    #if you do not have a token you have to supply your credentials
+    PLEX_LOGIN = ''
+    PLEX_PASS = ''
+
+    # if you already have a token pass it here
+    PLEX_TOKEN = ''
+
+    # the plex server url
+    PLEX_URL = 'http://192.168.0.200:32400' # including http(s) (local url is best)
+
+    # provide the usernames for which the rating should be updated
+    # when users have a pin we need this, otherwise set it to ''
+    USERDATA = { 'user': '1234' }
+
+    # for the access tokens we need the exact server name
+    SERVERNAME = 'plexserver'
+
+    # path of the photo library in plex (absolute path)
+    PHOTOS_LIBRARY_PATH_PLEX = '/<some path>/'
+
+    # for the correct path creation we need the path to the
+    # photo library from the view of the script (absolute path)
+    # Linux/Mac: "/<some path>/"
+    # Windows: "C:\\some folder\\some folder\\" # (paths need escaping)
+    PHOTOS_LIBRARY_PATH = "/<some path>/"
+
+    # start an update at the start of the script
+    FORCE_RUN_AT_START = True
+    ###########################################################
 ```
 
 For getting a valid token you can enter you login credentials and run the script.
@@ -40,18 +54,7 @@ It will then output this:
 ```
 use this token
 xxxxxxxxxxxxxxxxxxxxxxx
-and put it into plexUsers.py file after PLEX_TOKEN: 
-```
-
-### change values to fit your installation in ppTag.py
-
-Adjust the paths for the photos (for ppTag)
-
-```python
-if system == "Linux":
-    photosPath = "/Photos/" # Running in Docker
-else:
-    photosPath = "P:\\" # Windows
+and put it into the file config.py after PLEX_TOKEN:
 ```
 
 ## how it works
@@ -67,5 +70,5 @@ Images are scanned for adobe lightroom tags and rating written to the XMP data i
 ## Docker Container
 
 You can use the provided docker file and docker-compose to run ppTag inside docker.
-The Container needs to Volumes. One for the photos and the second for the app.
+The Container needs two Volumes. One for the photos and the second for the app.
 This way it is easy to make changes to the files (config)

config.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+
+class ppTagConfig():
+    """A simple class holding the config for ppTag"""
+    ####################### Change HERE #######################
+    #if you do not have a token you have to supply your credentials
+    PLEX_LOGIN = ''
+    PLEX_PASS = ''
+
+    # if you already have a token pass it here
+    PLEX_TOKEN = ''
+
+    # the plex server url
+    PLEX_URL = 'http://192.168.0.200:32400' # including http(s) (local url is best)
+
+    # provide the usernames for which the rating should be updated
+    # when users have a pin we need this, otherwise set it to ''
+    USERDATA = { 'user': '1234' }
+
+    # for the access tokens we need the exact server name
+    SERVERNAME = 'plexserver'
+
+    # path of the photo library in plex (absolute path)
+    PHOTOS_LIBRARY_PATH_PLEX = '/<some path>/'
+
+    # for the correct path creation we need the path to the
+    # photo library from the view of the script (absolute path)
+    # Linux/Mac: "/<some path>/"
+    # Windows: "C:\\some folder\\some folder" # (paths need escaping)
+    PHOTOS_LIBRARY_PATH = "/<some path>/"
+
+    # start an update at the start of the script
+    FORCE_RUN_AT_START = True
+    ###########################################################

plexUsers.py

@@ -11,6 +11,7 @@
 from plexapi.myplex import MyPlexAccount
 from plexapi.myplex import MyPlexDevice
 from uuid import uuid3, NAMESPACE_URL
+from config import ppTagConfig
 
 class userData(object):
     """a simple class that holds some user data"""
@@ -30,36 +31,17 @@ def setToken(self, token):
         self.token = token
 
 class plexUsers():
+    """A class to get user data (token, library id) for plex"""
 
-    ####################### Change HERE #######################
-    #if you do not have a token you have to supply your credentials
-    PLEX_LOGIN = ''
-    PLEX_PASS = ''
-    # if you already have a token pass it here
-    PLEX_TOKEN = ''
-    # the plex server url
-    PLEX_URL = 'http://192.168.0.200:32400'
-    # provide the usernames for which the rating should be updated
-    # when users have a pin we need this, otherwise set it to ''
-    USERDATA = { 'user': '1234' }
-
-    # for the access tokens we need the exact server name
-    SERVERNAME = 'plexserver'
-
-    # path of the photo library in plex
-    PHOTOS_LIBRARY_PATH = '/share/Photos/'
-
-    ###########################################################
-
-    def fetchPlexApi(self, path='', method='GET', getFormPlextv=False, token=PLEX_TOKEN, params=None):
+    def fetchPlexApi(self, path='', method='GET', getFormPlextv=False, token=ppTagConfig.PLEX_TOKEN, params=None):
         """a helper function that fetches data from and put data to the plex server"""
         headers = {'X-Plex-Token': token,
                 'Accept': 'application/json'}
         if getFormPlextv:
             url = 'plex.tv'
             connection = http.client.HTTPSConnection(url)
         else:
-            url = self.PLEX_URL.rstrip('/').replace('http://','')
+            url = ppTagConfig.PLEX_URL.rstrip('/').replace('http://','')
             connection = http.client.HTTPConnection(url)
 
         try:
@@ -101,29 +83,29 @@ def fetchPlexApi(self, path='', method='GET', getFormPlextv=False, token=PLEX_TO
     def getAccessTokenForUser(self):
         for user in self.users:
             params = urllib.parse.urlencode({'pin': user.pin, 'X-Plex-Client-Identifier': self.clientId})
-            data = self.fetchPlexApi('/api/v2/home/users/{uuid}/switch'.format(uuid=user.uuid), 'POST', True, self.PLEX_TOKEN, params)
+            data = self.fetchPlexApi('/api/v2/home/users/{uuid}/switch'.format(uuid=user.uuid), 'POST', True, ppTagConfig.PLEX_TOKEN, params)
             if 'authToken' in data:
                 authToken = data['authToken']
                 data = self.fetchPlexApi('/api/resources?includeHttps=1&includeRelay=1&X-Plex-Client-Identifier={clientid}'.format(clientid=self.clientId), 'GET', True, authToken)
                 for device in data['MediaContainer']['Device']:
                     if isinstance(device, dict):
-                        if device.get('@provides') == 'server' and device.get('@name') == self.SERVERNAME:
+                        if device.get('@provides') == 'server' and device.get('@name') == ppTagConfig.SERVERNAME:
                             self.serverId = device.get('@clientIdentifier')
                             user.setToken(device.get('@accessToken'))
                             break
 
     def __init__(self):
         ## some initial tests
-        if len(self.PLEX_TOKEN) == 0:
+        if len(ppTagConfig.PLEX_TOKEN) == 0:
             # get a token
             try:
-                account = MyPlexAccount(self.PLEX_LOGIN, self.PLEX_PASS)
+                account = MyPlexAccount(ppTagConfig.PLEX_LOGIN, ppTagConfig.PLEX_PASS)
             except Exception as e:
                 raise("Error fetching from Plex API: {err}".format(err=e))
             # print the Token and message to enter it here
             print('use this token')
             print (account.authenticationToken)
-            print('and put it into this file PLEX_TOKEN: plexUsers.py')
+            print('and put it into the file config.py after PLEX_TOKEN: ')
             raise
 
         # some lists for data
@@ -134,7 +116,7 @@ def __init__(self):
         # creating the client id
         self.clientId = uuid3(NAMESPACE_URL, "pptag").hex
 
-        self.plex = PlexServer(self.PLEX_URL, self.PLEX_TOKEN)
+        self.plex = PlexServer(ppTagConfig.PLEX_URL, ppTagConfig.PLEX_TOKEN)
 
 
         apiUsers = self.fetchPlexApi("/api/home/users","GET",True)
@@ -149,8 +131,8 @@ def __init__(self):
 
         for user in users:
             if isinstance(user, dict):
-                if user['@title'] in self.USERDATA.keys():
-                    pin = self.USERDATA.get(user['@title'])
+                if user['@title'] in ppTagConfig.USERDATA.keys():
+                    pin = ppTagConfig.USERDATA.get(user['@title'])
                     u = userData(user['@id'],user['@uuid'],user['@title'], pin)
                     self.users.append(u)
 

pptag.py

@@ -8,7 +8,6 @@
 import logging
 import urllib
 import time
-import platform
 from threading import Timer
 from watchdog.observers import Observer
 from watchdog.events import PatternMatchingEventHandler
@@ -19,21 +18,12 @@
 from plexUsers import plexUsers
 from lightroomTags import parse_xmp_for_lightroom_tags
 
-logger = exif_log.get_logger()
-
-system = platform.system()
+from config import ppTagConfig
 
-####################### Change HERE #######################
-
-if system == "Linux":
-    photosPath = "/Photos/"
-else: # Windows
-    photosPath = "P:\\"
+logger = exif_log.get_logger()
 
-########################################################### 
-   
 doUpdate = []
-firstRun = True
+firstRun = ppTagConfig.FORCE_RUN_AT_START
 
 # plex
 p = None
@@ -122,7 +112,7 @@ def updateTagsAndRating(key, filename):
 
     #exif_log.setup_logger(debug, color)
 
-    filename = photosPath + filename
+    filename = ppTagConfig.PHOTOS_LIBRARY_PATH + filename
 
     try:
         img_file = open(str(filename), 'rb')
@@ -202,7 +192,7 @@ def loopThroughAllPhotos():
                 if mediaType != "photo":
                     continue
                 key = photo["ratingKey"]
-                src = photo["Media"][0]["Part"][0]["file"].replace(plexUsers.PHOTOS_LIBRARY_PATH,"", 1)
+                src = photo["Media"][0]["Part"][0]["file"].replace(ppTagConfig.PHOTOS_LIBRARY_PATH_PLEX,"", 1)
 
                 if src in doUpdateTemp or firstRun:
 
@@ -236,7 +226,7 @@ def process(self, event):
         if (event.event_type == 'modified' or event.event_type ==  'created' or event.event_type == 'moved'):
             if not event.is_directory:
                 # put file into forced update list
-                doUpdate.append(event.src_path.replace(photosPath,"", 1))
+                doUpdate.append(event.src_path.replace(ppTagConfig.PHOTOS_LIBRARY_PATH,"", 1))
                 triggerLoopThroughAllPhotos()
 
     def on_modified(self, event):
@@ -250,7 +240,7 @@ def on_created(self, event):
 
     # setup observer
     observer = Observer()
-    observer.schedule(PhotoHandler(), path=photosPath, recursive=True)
+    observer.schedule(PhotoHandler(), path=ppTagConfig.PHOTOS_LIBRARY_PATH, recursive=True)
 
     # setup timer
     # wait 120 sec after change was detected