Merge pull request #6 from hlgirard/dev/cliexec

Version 0.1.3

Author: hlgirard

README.md

@@ -38,15 +38,17 @@ pip install .
 
 ### Quick start
 
-Pass the labels and image directory on the command line to start labelling. Use the on-screen buttons to select a label for the current image and advance to the next one. Number keys correspond to labels and can be used instead.
+Simplabel can be started from the command line without any argument:
+```
+simplabel
+```
+You will be prompted to select a directory containing images to label. Add labels with the '+' button and start labeling. Number keys correspond to labels and can be used instead.
 
+The target directory and/or labels can also be passed directly from the command line:
 ```
 simplabel --labels dog cat bird --directory path/to/image/directory
 ```
 
-Note that simplabel can now be called without any arguments as follows: `simplabel`.
-The user will be prompted to select an image directory and labels can be added with the + button at the bottom of the screen.
-
 After the first use, labels are stored in `labels.pkl` and the `--labels` argument is ignored.
 
 ### Command line arguments
@@ -56,9 +58,9 @@ After the first use, labels are stored in `labels.pkl` and the `--labels` argume
 - `-u, --user <USERNAME>` sets the username. Defaults to the OS login name if none is passed.
 - `-r, --redundant` does not display other labelers selections for independent labelling. Reconciliation and Make Master are unavailable in this mode.
 - `-v, --verbose` increases the verbosity level.
-- `--remove-label` tries to safely remove a label from the list saved in `labels.pkl`.
+- `--remove-label <LABEL>` tries to safely remove a label from the list saved in `labels.pkl` (must also pass `-d`)
 - `--reset-lock` overrides the lock preventing the same username from being used multiple times simultaneously.
-- `--delete-all` removes all files created by simplabel in the directory
+- `--delete-all` removes all files created by simplabel in the directory (must also pass `-d`)
 
 ### Multiuser
 
@@ -82,7 +84,7 @@ with open("labeled_user1.pkl","rb") as f:
 Once you are done labelling, use the flow_to_directory tool to copy images to distinct directories by label
 
 ```
-flow_to_directory --rawDirectory data/raw --outDirectory data/labeled
+flow_to_directory --input-directory data/labeled --output-directory data/sorted
 ```
 
 ### Python object

bin/flow_to_directory

@@ -4,20 +4,22 @@
     long_description = f.read()
 
 setup(name='simplabel',
-      version='0.1.2',
+      version='0.1.3',
       description='Simple tool to manually label images in disctinct categories to build training datasets.',
       long_description=long_description,
       long_description_content_type="text/markdown",
       url='https://github.com/hlgirard/Simplabel',
       author='Henri-Louis Girard',
       author_email='[email protected]',
       license='GPLv3',
-      packages=find_packages(),
+      packages=find_packages(exclude=["tests.*", "tests"]),
       install_requires=[
           'pillow',
       ],
-      scripts=[
-          'bin/simplabel',
-          'bin/flow_to_directory'
-      ],
-      zip_safe=False)
+      entry_points={
+          'console_scripts': [
+              'simplabel = simplabel.simplabel:main',
+              'flow_to_directory = simplabel.flow_to_dict:main',
+          ],
+      },
+      zip_safe=False)

bin/simplabel

@@ -1,3 +1,3 @@
 from .simplabel import *
 
-__version__ = '0.1.0'
+__version__ = '0.1.3'

setup.py

@@ -1,9 +1,11 @@
+import argparse
 import os
 import pickle
 import shutil
 import sys
+import tkinter as tk
 
-def flow_to_dict(rawDirectory, labelledDirectory):
+def flow_to_dict(rawDirectory, labelledDirectory=None):
     '''
     Copies labelled images to discting directories by label
 
@@ -18,11 +20,15 @@ def flow_to_dict(rawDirectory, labelledDirectory):
     # Detected users
     users = [f.split('_')[1].split('.')[0] for f in os.listdir(rawDirectory) if (f.endswith('.pkl') and f.startswith('labeled_'))]
 
+    if not users:
+        print("No label files found in directory.")
+        sys.exit()
+
     # Open the labelled dictionary
     if 'master' in users:
         dictPath = rawDirectory + '/labeled_master.pkl'
     else:
-        username = input("Enter username to flow [{}]:".format(users))
+        username = input("Enter username to flow {}:".format(users))
         dictPath = rawDirectory + '/labeled_{}.pkl'.format(username)
 
     if os.path.exists(dictPath):
@@ -34,6 +40,9 @@ def flow_to_dict(rawDirectory, labelledDirectory):
 
     # Get all categories that exist in the dictionary
     categories = set(labelled_dict.values())
+    # If no output directory is passed, use the input directory
+    if not labelledDirectory:
+        labelledDirectory = rawDirectory
     # Check existence of output directory
     if not os.path.exists(labelledDirectory):
         os.mkdir(labelledDirectory)
@@ -49,9 +58,17 @@ def flow_to_dict(rawDirectory, labelledDirectory):
         shutil.copy2(rawDirectory + '/' + image, labelDirect)
 
 
+def main():
+    #Setup parser
+    ap = argparse.ArgumentParser()
+    ap.add_argument("-i", "--input-directory", default=os.getcwd(), help="Path of the directory containing the raw images and labeled.pkl file. Defaults to current directory")
+    ap.add_argument("-o", "--output-directory", help="Path of the output directory, will be created if it does not exist")
+
+    args = ap.parse_args()
 
-if __name__ == "__main__":
-    rawDirectory = 'data/raw'
-    labelledDirectory = 'data/labeled'
+    # Get the variables from parser
+    rawDirectory = args.input_directory
+    outDirectory = args.output_directory
 
-    flow_to_dict(rawDirectory, labelledDirectory)
+    flow_to_dict(rawDirectory, outDirectory)
+    

simplabel/__init__.py

@@ -1,3 +1,4 @@
+import argparse
 import tkinter as tk
 from tkinter.messagebox import askquestion, askokcancel, showwarning
 from tkinter import simpledialog, filedialog
@@ -872,8 +873,8 @@ def keypress_handler(self,e):
                 self.save()
             elif e.char == 'q':
                 self.exit()
-            elif e.char == 'd': # FIXME: debug option only
-                self.debug_prints()
+            #elif e.char == 'd': # For debug only
+            #    self.debug_prints()
             else:
                 pass
 
@@ -995,9 +996,97 @@ def is_locked(self):
         with open(self.filename, 'r') as f:
             return f.read() == 'locked'
 
-if __name__ == "__main__":
+def delete_all_files(directory):
+    '''Deletes all files created by simplabel in a directory, this resets the labels and all saved data'''
+
+    save_files = [f for f in os.listdir(directory) if (f.endswith('.pkl') and f.startswith('label'))]
+    save_files.extend([f for f in os.listdir(directory) if f.startswith('.') and f.endswith('_lock.txt')])
+    if len(save_files) > 0:
+        response = input("Are you sure you want to delete all saved files: {}? (y/n)".format(save_files))
+        if response == 'y':
+            for f in save_files:
+                os.remove(os.path.join(directory,f))
+            print("Successfully deleted all saved files")
+        else:
+            print("Cancelled deletion, your files are exactly where you left them ;)")
+    else:
+        print("No files found in {}".format(directory))
+    return
+
+def remove_label(directory, labelName):
+    '''Removes a label from the label file after verifying it isn't in use'''
+
+    labelToRemove = labelName.strip().lower().capitalize()
+
+    # Load the label file to check the presence of the label to remove
+    labelFile = directory + '/labels.pkl'
+    if os.path.isfile(labelFile):
+        with open(labelFile, 'rb') as f:
+            labels = pickle.load(f)
+        if labelToRemove not in labels:
+            print("No such label in labels.pkl")
+            return
+    else:
+        print("No label file found.")
+        return
+        
+    
+    # Get a list of users
+    users = [f.split('_')[1].split('.')[0] for f in os.listdir(directory) if (f.endswith('.pkl') and f.startswith('labeled_'))]
+
+    # Load each user's dictionary and check for the presense of the label to remove
+    for user in users:
+        dictPath = directory + "/labeled_" + user +".pkl"
+        with open(dictPath, "rb") as f:
+            userDict = pickle.load(f)
+        if labelToRemove in userDict.values():
+            print("Label {} is used by {}, cannot remove it from the list".format(labelToRemove, user))
+            return
+
+    # If the check have passed, remove the label from the list and resave the list
+    labels.remove(labelToRemove)
+    with open(labelFile, 'wb') as f:
+        pickle.dump(labels, f)
+    
+    print("Successfully removed label {} from the list".format(labelToRemove))
+    return
+
+def main():
+
+    #Setup parser
+    ap = argparse.ArgumentParser()
+    ap.add_argument("-d", "--directory", default=None, help="Path of the directory")
+    ap.add_argument("-l", "--labels", default=None, help="List of labels")
+    ap.add_argument("-v", "--verbose", action='count', default=0, help="Enable verbose mode")
+    ap.add_argument("-u", "--user", help="Set username for the current session")
+    ap.add_argument("-r", "--redundant", action='store_true', help="Redundant mode: do not show other labeler's selections")
+    ap.add_argument("--delete-all", action='store_true', help="Deletes all files created by simplabel in a directory, this resets the labels and all saved data")
+    ap.add_argument("--reset-lock", action='store_true', help="Overrides the lock in case of incorrect lockout")
+    ap.add_argument("--remove-label", help="Remove a label from the list")
+
+    args = ap.parse_args()
+
+    # Get the variables from parser
+    rawDirectory = args.directory
+    categories = args.labels
+    verbosity = args.verbose
+    username = args.user
+    bResetLock = args.reset_lock
+    bRedundant = args.redundant
+
+    # Reset all saved data if requested
+    if args.delete_all:
+        delete_all_files(rawDirectory)
+        sys.exit(0)
+
+    # Remove label
+    if args.remove_label:
+        if not rawDirectory:
+            print("No directory specified. You must pass the directory containing the label file with -d")
+        remove_label(rawDirectory, args.remove_label)
+        sys.exit(0)
+
+    # Launch the app
     root = tk.Tk() 
-    rawDirectory = "data/raw"
-    categories = ['Crystal', 'Clear']
-    MyApp = ImageClassifier(root, rawDirectory, categories, 2)
+    MyApp = ImageClassifier(root, directory = rawDirectory, categories = categories, verbose = verbosity, username = username, bResetLock = bResetLock, bRedundant = bRedundant)
     tk.mainloop()