opener-property-tagger 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 449add6937b48b2b9c17a8174cc5790a2d366088
-  data.tar.gz: b64fc05e7b01f9720969607637e94e891a57c614
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGQzMjM4MjQxZjMyNDkwOGFiNGQ4Njg3MDZiOWE1N2JmZmIxZTY1NQ==
+  data.tar.gz: !binary |-
+    ZTdmYmMwMGViYTc3MDcyOTRjOTQzM2M4MjMyZTU1NDJjMjUxNWNlNg==
 SHA512:
-  metadata.gz: 24d9e2caf35674b6e33e495ba84467198b6adbfcfe3dab50e586e6ec6467e61b24e73810164a426ef7d4c7fdbecbea90255d0bc0caeff09585015505ae13d16f
-  data.tar.gz: 7969b6cb5409ab4c6141e68ef708ac85fa9fa8169c476c696fe40bc5c6452dfc3cdd590cce40bf306370d1a7f7f1901f19206d53cef63015eaa79fedfea31080
+  metadata.gz: !binary |-
+    ODFmOWVlNzNmM2NiNzM4OWNjNmIyZTNhMGEyYWFmMzVhMTBlYzliMzZkNmU2
+    NGVmYmNjNTZhYjZjMDFjNWYzMDhjODE5MWRiMzI1MTg2MTIxODE5ZTBkMWE1
+    N2Y2OWExNWZlOTQzNjEyYmRiZTgzMjUyMjI4Y2U4NTAzODAzNDc=
+  data.tar.gz: !binary |-
+    Y2M2ZWQyMWYyZDhhYjJjOTYwMmQyYWI1ODljNTgxNzU2YTU1YjhkYzQyMmFi
+    MTEzYjg2MzM1Zjk1MzUwMDM5NGRiMmZiMTU3ZWM0MWUwNDNjNzQwYTk4Mjc2
+    MTg1NzhmY2UyMzI3Yjg5ZGVkNmFlZTg0YmRlZTgyODI2MTQyNjA=

data/README.md

@@ -1,46 +1,140 @@
-#property-tagger#
-
-#Introduction#
+Property Tagger
+---------------
 
 This module implements a tagger for hotel properties for Dutch, English, French, Italian, Spanish and German. It detects aspect words,
 for instance words related with "room", "cleanliness", "staff" or "breakfast" and links them with the correct aspect class.
 The input for this module has to be a valid KAF file with at lest the term layer, as the lemmas will be used for detecting the hotel properties. The output is also
 a KAF valid file extended with the property layer. This module works for all the languages within the OpeNER project (en,de,nl,fr,es,it) and the language is read from
-the input KAF file, from the lang attribute of the KAF element  (make suresure your preprocessors set properly this value or you might use the resources for a wrong language)
-````shell
-<KAF xml:lang="( en | nl | fr | it | de | es)">
-````
+the input KAF file, from the lang attribute of the KAF element  (make sure your preprocessors set properly this value or you might use the resources for a wrong language)
 
-#Requirements#
-* VUKafParserPy: parser in python for KAF files (https://github.com/opener-project/VU-kaf-parser)
-* lxml: library for processing xml in python
+### Confused by some terminology?
 
+This software is part of a larger collection of natural language processing
+tools known as "the OpeNER project". You can find more information about the
+project at (the OpeNER portal)[http://opener-project.github.io]. There you can
+also find references to terms like KAF (an XML standard to represent linguistic
+annotations in texts), component, cores, scenario's and pipelines.
 
+Quick Use Example
+-----------------
 
-#How to run the module with Python#
-You can run this module from the command line using Python. The main script is core/hotel_property_tagger_nl_en.py. This reads
-and writes the output to the standard output, generating some log information in the standard error output. To process the file
-"input.kaf" just type:
-````shell
-cat input.kaf | core/hotel_property_tagger_nl_en.py > output.kaf
-````
+Keep in mind that this component uses PYTHON so it's advised to make sure you
+have a virtualenv activated before installing.
 
-This will read the KAF file in "input.kaf" and will store the constituent trees in "input.tree".
+Installing the property-tagger can be done by executing:
 
-The options of the program can be obtained calling to the program with the parameter -h:
-````shell
-core/hotel_property_tagger_nl_en.py -h
-usage: hotel_property_tagger_nl_en.py [-h] [--no-time] [--lexicon LEXICON]
+    gem install opener-property-tagger
+
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
+
+
+### Command line interface
+
+You should now be able to call the property tagger as a regular shell
+command: by its name. Once installed the gem normally sits in your path so you can call it directly from anywhere.
+
+This application reads a text from standard input in order process it.
+
+    cat some_kind_of_kaf_file.kaf | property-tagger --resource-path /path/to/lexicons/
+
+The property tagger will search in the resource-path for files named
+```{language_code}.txt```, for example ```en.txt```.
+
+An excerpt of a potential output would than be:
+
+```
+  <features>
+    <properties>
+      <property pid="p1" lemma="cleanliness">
+        <references>
+          <!--dirty-->
+          <span>
+            <target id="t_12"/>
+          </span>
+        </references>
+      </property>
+      <property pid="p2" lemma="sleeping_comfort">
+        <references>
+          <!--bed-->
+          <span>
+            <target id="t_10"/>
+          </span>
+        </references>
+      </property>
+      <property pid="p3" lemma="staff">
+        <references>
+          <!--staff-->
+          <span>
+            <target id="t_16"/>
+          </span>
+          <!--friendly-->
+          <span>
+            <target id="t_20"/>
+          </span>
+        </references>
+      </property>
+    </properties>
+  </features>
+```
+
+### Webservices
+
+You can launch a webservice by executing:
+
+    property-tagger-server --resource-path /path/to/resources
+
+This will launch a mini webserver with the webservice. It defaults to port 9292,
+so you can access it at <http://localhost:9292>.
+
+To launch it on a different port provide the `-p [port-number]` option like
+this:
+
+    property-tagger-server -p 1234
+
+It then launches at <http://localhost:1234>
 
-Tags a text with polarities at lemma level
+Documentation on the Webservice is provided by surfing to the urls provided
+above. For more information on how to launch a webservice run the command with
+the ```-h``` option.
 
-optional arguments:
-  -h, --help         show this help message and exit
-  --no-time          For not including timestamp in header
-  --lexicon LEXICON  Force to use this lexicon
-````
 
-The most important option is the --lexicon, which allows you to use your own lexicon with the program. The lexicon must be stored in a file and follow this format:
+### Daemon
+
+Last but not least the property tagger comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
+
+    property-tagger-daemon -h
+
+
+Description of dependencies
+---------------------------
+
+This component runs best if you run it in an environment suited for OpeNER
+components. You can find an installation guide and helper tools in the (OpeNER
+installer)[https://github.com/opener-project/opener-installer] and (an
+installation guide on the Opener
+Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
+
+At least you need the following system setup:
+
+### Depenencies for normal use:
+
+* Ruby 1.9.3 or newer
+* Python 2.6
+* lxml installed
+
+### Dependencies if you want to modify the component:
+
+* Maven (for building the Gem)
+
+
+Domain Adaption and Language Extension
+--------------------------------------
+
+The lexicons in the resource path must be stored in a file and follow this format:
+
 ````shell
 surf	verb	facilities
 surfer	noun	facilities
@@ -48,15 +142,32 @@ surfing	verb	facilities
 ```
 
 So, one aspect per line, with 3 fields separated by a tabulator, the first one is the word or span of words (in this case use whitespaces), then the part
-of speech (which actually it is not use, you can  include a dummy label) and finally the aspect class associated with the word. If you have created your lexicon
-in one file you could call to the program in this fashion:
-````shell
-$ cat my_input.kaf | python core/hotel_property_tagger_nl_en.py --lexicon path/to/your/lexicon/my_lexicon.txt > my_output.kaf
-````
+of speech (which actually it is not use, you can  include a dummy label) and finally the aspect class associated with the word.
+
+The Core
+--------
+
+The component is a fat wrapper around the actual language technology core. You
+can find the core technolies (python) in the ```/core``` directory.
+
+Where to go from here
+---------------------
+
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/property-tagger]
+
+Report problem/Get help
+-----------------------
+
+If you encounter problems, please email support@opener-project.eu or leave an
+issue in the (issue tracker)[https://github.com/opener-project/property-tagger/issues].
+
 
-Contact
-------
-* Ruben Izquierdo
-* Vrije University of Amsterdam
-* ruben.izquierdobevia@vu.nl
+Contributing
+------------
 
+1. Fork it ( http://github.com/opener-project/property-tagger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/core/hotel_property_tagger_nl_en.py

@@ -17,7 +17,7 @@ from lxml import etree
 from collections import defaultdict
 
 __desc='VUA property tagger'
-__last_edited='4nov2013'
+__last_edited='20may2014'
 __version='1.0'
 
 ###
@@ -37,8 +37,11 @@ def loadAspects(my_lang,this_file=None):
   if this_file is not None:
     aspects_filename = this_file
   else:
-    aspects_filename = os.path.join(__module_dir,'data',my_lang,'aspects.txt')
-  
+    filename = "{0}.txt".format(my_lang)
+    print>>sys.stderr, "filename thingy",filename
+    print>>sys.stderr, "path thingy",arguments.path
+    aspects_filename = os.path.join(arguments.path,filename)
+
   if not os.path.exists(aspects_filename):
     print>>sys.stderr,'ERROR: file with aspects for the language',my_lang,'not found in',aspects_filename
   else:
@@ -56,8 +59,9 @@ def loadAspects(my_lang,this_file=None):
 ###### MAIN ########
 
 argument_parser = argparse.ArgumentParser(description='Tags a text with polarities at lemma level')
-argument_parser.add_argument("--no-time",action="store_false", default=True, dest="my_time_stamp",help="For not including timestamp in header") 
+argument_parser.add_argument("--no-time",action="store_false", default=True, dest="my_time_stamp",help="For not including timestamp in header")
 argument_parser.add_argument("--lexicon", action="store", default=None, dest="lexicon", help="Force to use this lexicon")
+argument_parser.add_argument("--path", action="store", default=None, dest="path", help="Set the path where the property aspects are found.")
 
 arguments = argument_parser.parse_args()
 
@@ -94,7 +98,7 @@ if arguments.lexicon is None:
   my_aspects_filename, my_aspects = loadAspects(my_lang)
 else:
   my_aspects_filename, my_aspects = loadAspects(my_lang,this_file=arguments.lexicon)
-  
+
 if verbose:
   print>>sys.stderr,'Loaded ',len(my_aspects),'aspects from',my_aspects_filename
 

data/core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/installed-files.txt

@@ -1,11 +1,11 @@
-../VUKafParserPy/KafParserMod.py
 ../VUKafParserPy/__init__.py
 ../VUKafParserPy/KafDataObjectsMod.py
-../VUKafParserPy/KafParserMod.pyc
+../VUKafParserPy/KafParserMod.py
 ../VUKafParserPy/__init__.pyc
 ../VUKafParserPy/KafDataObjectsMod.pyc
+../VUKafParserPy/KafParserMod.pyc
 ./
-top_level.txt
-SOURCES.txt
-PKG-INFO
 dependency_links.txt
+PKG-INFO
+SOURCES.txt
+top_level.txt

data/ext/hack/Rakefile

@@ -7,7 +7,7 @@ task :requirements do
 end
 
 task :default => :requirements do
-  # path = File.join(PYTHON_SITE_PACKAGES, 'pre_install')
-  # 
-  # pip_install(PRE_INSTALL_REQUIREMENTS, path)
+  path = File.join(PYTHON_SITE_PACKAGES, 'pre_install')
+
+  pip_install(PRE_INSTALL_REQUIREMENTS, path)
 end

data/lib/opener/property_tagger.rb

@@ -31,7 +31,19 @@ module Opener
     # @return [String]
     #
     def command
-      return "#{adjust_python_path} python -E -OO #{kernel} #{args.join(' ')}"
+      return "#{adjust_python_path} python -E -OO #{kernel} #{args.join(' ')} --path #{path}"
+    end
+
+
+    ##
+    # Get the resource path for the lexicon files, defaults to an ENV variable
+    #
+    def path
+      return options[:resource_path] if options[:resource_path]
+      return ENV.fetch('PROPERTY_TAGGER_LEXICONS_PATH') {
+        raise ArgumentError, "No lexicon path provided."
+      }
+
     end
 
     ##
@@ -55,7 +67,7 @@ module Opener
     end
 
     ##
-    # capture3 method doesn't work properly with Jruby, so 
+    # capture3 method doesn't work properly with Jruby, so
     # this is a workaround
     #
     def capture(input)
@@ -67,7 +79,7 @@ module Opener
         [out_reader.value, err_reader.value, t.value]
       }
     end
-    
+
     ##
     # @return [String]
     #

data/lib/opener/property_tagger/cli.rb

@@ -1,3 +1,5 @@
+require 'opener/core/resource_switcher'
+
 module Opener
   class PropertyTagger
     ##
@@ -9,45 +11,46 @@ module Opener
     #  @return [OptionParser]
     #
     class CLI
-      attr_reader :options, :option_parser
+      attr_reader :options, :option_parser, :resource_switcher
+
+      DEFAULT_OPTIONS = {
+        :logging => false,
+      }
 
       ##
       # @param [Hash] options
       #
       def initialize(options = {})
         @options = DEFAULT_OPTIONS.merge(options)
+        @resource_switcher = Opener::Core::ResourceSwitcher.new
 
         @option_parser = OptionParser.new do |opts|
           opts.program_name   = 'polarity-tagger'
           opts.summary_indent = '  '
 
+          resource_switcher.bind(opts, @options)
+
           opts.on('-h', '--help', 'Shows this help message') do
             show_help
           end
 
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
-
           opts.on('-l', '--log', 'Enable logging to STDERR') do
             @options[:logging] = true
           end
 
-          opts.separator <<-EOF
-
-Examples:
-
-  cat example.kaf | #{opts.program_name}    # Basic usage
-  cat example.kaf | #{opts.program_name}    # Logs information to STDERR
-          EOF
+          opts.on("--lexicon FILE", "Use a specific lexicon file") do |v|
+            @options[:lexicon] = v
+          end
         end
+
+        option_parser.parse!(options[:args])
+        resource_switcher.install(@options)
       end
 
       ##
       # @param [String] input
       #
       def run(input)
-        option_parser.parse!(options[:args])
 
         tagger = PropertyTagger.new(options)
 

data/lib/opener/property_tagger/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class PropertyTagger
-    VERSION = '2.0.1'
+    VERSION = '2.1.0'
   end # PropertyTagger
 end # Opener

data/opener-property-tagger.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
 
   gem.files = Dir.glob([
     'core/site-packages/pre_build/**/*',
-    #'core/data/**/*',
+    'core/data/**/*',
     'core/*',
     'ext/**/*',
     'lib/**/*',
@@ -31,6 +31,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httpclient'
   gem.add_dependency 'puma'
   gem.add_dependency 'opener-webservice'
+  gem.add_dependency 'opener-core'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cucumber'

data/pre_install_requirements.txt

@@ -0,0 +1 @@
+https://github.com/opener-project/VU-kaf-parser/archive/master.zip#egg=VUKafParserPy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opener-property-tagger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - development@olery.com
@@ -14,112 +14,126 @@ dependencies:
   name: opener-build-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opener-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Property tagger for hotels in Dutch and English.
@@ -131,31 +145,31 @@ extensions:
 - ext/hack/Rakefile
 extra_rdoc_files: []
 files:
-- README.md
-- bin/property-tagger
-- bin/property-tagger-server
-- config.ru
-- core/extract_aspects.py
-- core/hotel_property_tagger_nl_en.py
-- core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/PKG-INFO
-- core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/SOURCES.txt
+- core/site-packages/pre_build/VUKafParserPy/__init__.py
+- core/site-packages/pre_build/VUKafParserPy/KafDataObjectsMod.py
+- core/site-packages/pre_build/VUKafParserPy/KafParserMod.py
 - core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/dependency_links.txt
 - core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/installed-files.txt
+- core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/PKG-INFO
+- core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/SOURCES.txt
 - core/site-packages/pre_build/VUKafParserPy-1.0-py2.7.egg-info/top_level.txt
-- core/site-packages/pre_build/VUKafParserPy/KafDataObjectsMod.py
-- core/site-packages/pre_build/VUKafParserPy/KafParserMod.py
-- core/site-packages/pre_build/VUKafParserPy/__init__.py
+- core/extract_aspects.py
+- core/hotel_property_tagger_nl_en.py
 - ext/hack/Rakefile
 - ext/hack/support.rb
-- lib/opener/property_tagger.rb
 - lib/opener/property_tagger/cli.rb
 - lib/opener/property_tagger/public/markdown.css
 - lib/opener/property_tagger/server.rb
 - lib/opener/property_tagger/version.rb
 - lib/opener/property_tagger/views/index.erb
 - lib/opener/property_tagger/views/result.erb
+- lib/opener/property_tagger.rb
+- config.ru
 - opener-property-tagger.gemspec
-- pre_build_requirements.txt
+- pre_install_requirements.txt
+- README.md
+- bin/property-tagger
+- bin/property-tagger-server
 homepage: http://opener-project.github.com/
 licenses: []
 metadata: {}
@@ -165,19 +179,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Property tagger for hotels in Dutch and English.
 test_files: []
-has_rdoc: 

data/pre_build_requirements.txt

@@ -1 +0,0 @@
-git+ssh://git@github.com/opener-project/VU-kaf-parser.git#egg=VUKafParserPy