Merge pull request #11 from lakshmanaram/master

Updated Instructions and enhanced entry point efficiency

Author: swaathi

README.md

@@ -1,16 +1,52 @@
 # cvscan
 Your not so typical resume parser
-
-
 Instructions
 ========
 Follow these to have a sneak peek of what's going on  
 1. git clone https://github.com/skcript/cvscan.git  
-2. cd cvscan/cvscan  
-3. python cvscan.py  
-4. Type one of the following: lakshamanram (or) swaathi  
+2. cd cvscan  
+3. python setup.py install  
+4. Place the sample resume in the ~/cvscan folder  and enter the file name  
+or enter relative path  
+Eg: ~/cvpath/data/sample/a.pdf is parsed by
+```bash
+cvscan parse --name data/sample/a
+```
+
+Data Manipulations
+===============
+## Skills
+Note: Skills are case-sensitive unlike Jobs and Organizations
+### add
+```
+cvscan add -s "C,C++,R,Java"
+```
+### remove
+```
+cvscan remove --skill "C,C++"
+```
+## Jobs
+### add
+Adding  
+1. contributor Job-category: Programmer  
+2. Android Programmer Job-category: Developer
 
-To test on some other resume  
-1. Place the resume in the data/input folder.  
-2. Avoid spaces in the file name.  
-3. Run the instructions above and give the newly added filename as input instead.  
+```
+cvscan add -j "contributor:Programmer,android Programmer:Developer"
+```
+### remove
+Removing  
+1. contributor  
+2. Android Programmer  
+```
+cvscan remove --job "contributor,Android Programmer"
+```
+## Organizations
+### add
+```
+cvscan add --org "Skcript"
+```
+### remove
+```
+cvscan remove -o "Skcript"
+```

cvscan/cli/cli.py

@@ -1,12 +1,15 @@
 # -*- encoding: utf-8 -*-
 """
+
 Cvscan command line tool
+
 """
 
 import click
 import pprint
 
 from cvscan import Cvscan
+from cvscan import data_operations as do
 
 # Disable the warning that Click displays (as of Click version 5.0) when users
 # use unicode_literals in Python 2.
@@ -18,21 +21,88 @@ def main():
     """Cvscan command line tool."""
     pass
 
+
 @main.command()
-@click.option('--name', '-n', help='Redis key to be watched')
+@click.option('--name', '-n', help='Parse resume')
 def parse(name):
-  """Watching Redis for key."""
+  """
+
+  Parse resume\n
+  Params: name Type: string\n
+  Usage: cvscan parse --name <name>\n
+  to parse file: ~/cvscan/<name>.pdf
+  
+  """
   resume = Cvscan(name)
   resume.parse()
   pprint.pprint(resume.show(), width=1)
 
-# @main.command()
-# @click.option('--skill','-s', help="Enter skill to remove")
-# def remove_skill(skill):
-#   if skill:
-#     with open(dirpath.PKGPATH + '/data/skills/skills','rb') as fp:
-#       skills = pickle.load(fp)
-#     if skill not in skills:
-#       print "%s is not present in skills" % skill
-#     else:
-#       skills.remove(skill)
+
+@main.command()
+@click.option('--org','-o',help='Explicitly add organizations')
+@click.option('--skill','-s',help='Add skills')
+@click.option('--job','-j',help='For adding jobs: -j <job:category>')
+def add(org,skill,job):
+  """
+
+  Add data to be considered\n
+  Params: \n
+  org Type: comma separated string\n
+  skill Type: comma separated string\n
+  job Type: comma separated string (comma separated - job:category)\n
+  Usage:\n
+  For adding organization:\n
+  cvscan add --org <org_name,org_name,...>\n
+  For adding skill:\n
+  cvscan add --skill <skill,skill,...>\n
+  For adding job:\n
+  cvscan add --job <job:category,job:category,...>\n
+  The above can be combined together also. Eg:\n
+  cvscan add -o <org_name,org_name,..> -s <skill,skill,..> is also valid
+
+  """
+  if org:
+    do.add_organizations(org.split(','))
+  if skill:
+    do.add_skills(skill.split(','))
+  if job:
+    jobs = {}
+    for _job in job.split(','):
+      try:
+        _job = _job.split(':')
+        jobs[_job[0]] = _job[1]
+      except Exception:
+        print "Something wnet wrong: " + Exception
+    do.add_jobs(jobs)
+
+
+@main.command()
+@click.option('--org','-o',help='Explicitly remove organizations')
+@click.option('--skill','-s',help='Remove skills')
+@click.option('--job','-j',help='For removing jobs -j <job>')
+def remove(org,skill,job):
+  """
+
+  Remove data from consideration\n
+  Params:\n
+  org Type: comma separated string\n
+  skill Type: comma separated string\n  
+  job Type: comma separated string\n
+  Usage:\n   
+  For adding organization:\n
+  cvscan remove --org <org_name,org_name,..>\n
+  For adding skill:\n
+  cvscan remove --skill <skill,skill,..>\n
+  For adding job:\n
+  cvscan remove --job <job,job,..>\n
+  The above can be combined together also. Eg:\n
+  cvscan remove -o <org_name,org_name,..> -s <skill,skill,..> -j <job> 
+  is also valid
+
+  """
+  if org:
+    do.remove_organizations(org.split(','))
+  if skill:
+    do.remove_skills(skill.split(','))
+  if job:
+    do.remove_jobs(job.split(','))