added ability to pass command line argument of regular expression pattern matching. renamed script to be FileUpdater

Author: lamdav

README.md

@@ -1,32 +1,41 @@
-# FileUpdaterPDF
+# FileUpdater
+
 A Python File System Listener
 
 ## Problem:
+
 I had two different directories. One was specific to all things published by my portfolio site and the other was specific to all things related to my resume. I wanted to keep these two directories distinct on my local drive; however, everytime I updated my resume, I also had to make sure I remembered to copy the latest one exported in PDF from a Word document to the public portfolio directory and properly rename it. This is a simply but unnecessarily tedious task. I figured all I needed to do is the have some event listener focus on a particular directory and copy the file over when a modification or file creation was detected.
 
 ## Requirements:
- * Python 3.5+
- * Watchdog
- * GitPython
-You can install `Watchdog` and `GitPython` by running the following command:
-```
+
+- Python 3.5+
+- Watchdog
+- GitPython You can install `Watchdog` and `GitPython` by running the following command:
+
+ ```
  $ pip install -r requirements.txt
-```
+ ```
 
 ## How To Use:
-This script was intended to be setup in the Windows Task Scheduler and executed at startup.
-To execute the script, navigate to the `src` directory and run the following command:
+
+This script was intended to be setup in the Windows Task Scheduler and executed at startup. To execute the script, navigate to the `src` directory and run the following command:
+
+```
+$ python FileUpdater.py -n <author_name> -e <author_email> -m <commit_message> -g <git_directory> -s <directory_to_watch> -d <destination_directories_01 destination_directories_02 ...> -p <pattern_matcher>
+```
+
+Example:
+
 ```
- $ python FileUpdaterPDF.py author_name author_email commit_message git_directory directory_to_watch destination_directories
+$ python FileUpdater.py -n "David Lam" -e "some_email@xyz.com" -m "updating cool file" -g \some\git\directory -s \some\directory\to\watch -d \directory\01 \directory\02 -p *.pdf *.xml *.json
 ```
 
 ### Arguments:
- * author_name: A String of the author and committer of the update.
- * author_email: A String of the author and committer's email.
- * commit_message: A String of the message associated with the Git commit.
- * git_directory: A String of the path to the git directory the files will be moved to.
- * directory_to_watch: A String of the path of the directory the script will listen to.
- * destination_directories: A list of Strings (must include at least 1) of the path to which to move the updated file(s) to. The path must be space separated. This can include a new name of the file if needed. For example: if a file was originally called `apple.pdf`, you could specify the path `/some_path/orange.pdf` to be the new name of the copied file.
-
-## Extending:
-Change the `patterns` variable if you wish to listen to changes to other files beyond a simple PDF.
+
+- author_name: A String of the author and committer of the update.
+- author_email: A String of the author and committer's email.
+- commit_message: A String of the message associated with the Git commit.
+- git_directory: A String of the path to the git directory the files will be moved to.
+- directory_to_watch: A String of the path of the directory the script will listen to.
+- destination_directories: A list of space separated Strings (must include at least 1) of the path to which to move the updated file(s) to. This can include a new name of the file if needed. For example: if a file was originally called `apple.pdf`, you could specify the path `/some_path/orange.pdf` to be the new name of the copied file.
+- pattern_matcher: A list of space separated regular expression Strings (must include at least 1).

src/FileUpdaterPDF.py src/FileUpdater.pysrc/FileUpdaterPDF.py renamed to src/FileUpdater.py

@@ -1,34 +1,31 @@
 import time
 import shutil
-import subprocess
-import sys
-import os.path
 import argparse
 from git import Repo, Actor
 from watchdog.observers import Observer
 from watchdog.events import PatternMatchingEventHandler
 
 """
- FileUpdaterPDF watches for creations and modifications of pdf files at the scheduled source and moves them to the destination.
+ FileUpdater watches for creations and modifications of pdf files at the scheduled source and moves them to the destination.
 
  Note: The destination should contain the new name if needed. Example: /path/some-new-name.pdf
 """
 
 
-class FileUpdaterPDF(PatternMatchingEventHandler):
- # Change this to include other specific extensions.
- patterns = ["*.pdf"]
+class FileUpdater(PatternMatchingEventHandler):
+ patterns = []
 
- def __init__(self, author_name, author_email, commit_message, git_directory, destinations):
+ def __init__(self, author_name, author_email, commit_message, git_directory, destinations, pattern_matcher):
  """
- Construct a FileUpdaterPDF.
+ Construct a FileUpdater.
  """
- super(FileUpdaterPDF, self).__init__()
+ super(FileUpdater, self).__init__()
  self.git_directory = git_directory
  self.destinations = destinations
  self.author_name = author_name
  self.author_email = author_email
  self.commit_message = commit_message
+ self.patterns += pattern_matcher
 
  def process(self, event):
  """
@@ -111,15 +108,17 @@ def main():
  parser.add_argument("-s", "--source_path",
  help="the directory to watch", required=True)
  parser.add_argument("-d", "--destinations",
- help="the destination(s) of the file", nargs="+")
+ help="the destination(s) of the file", nargs="+", required=True)
+ parser.add_argument("-p", "--pattern_matcher",
+ help="file pattern to match in source directory", nargs="+", required=True)
 
  # Parse arguments.
  arguments = parser.parse_args()
 
- # Run WatchDog with FileUpdaterPDF.
+ # Run WatchDog with FileUpdater.
  observer = Observer()
- observer.schedule(FileUpdaterPDF(
- arguments.author_name, arguments.author_email, arguments.commit_message, arguments.git_directory, arguments.destinations), arguments.source_path)
+ observer.schedule(FileUpdater(
+ arguments.author_name, arguments.author_email, arguments.commit_message, arguments.git_directory, arguments.destinations, arguments.pattern_matcher), arguments.source_path)
  observer.start()
 
  # Print some initial information.