opener-constituent-parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf9cb3d2b534265f6dc4d347f9ace8dcbd36f54e
-  data.tar.gz: 2c4ff4b9bea88aff427f4a570fa455f49501d344
+  metadata.gz: fa16e039150d93fc7ac549fd0c0b04e1bd1df8eb
+  data.tar.gz: 7145f50efe569752050f8474f8b0e461a97eb5b6
 SHA512:
-  metadata.gz: 83758c416f6aa1e05c899b0f6cc4be67a904d43328d357d2f5c8e649dbf4d3caa324669b3c473637ee2630d7089a4b4a6ee83eac10ebe70543c65b6243ac2ef6
-  data.tar.gz: db883a9e99c5e6200968b8bc23e3bbaee4dfad125f4484e2b2763a550833a7cc5f18a12da9da992900391f73464ccfd2cc90fbae5dcaead5f7d237c6caf1fd68
+  metadata.gz: 40325995229ad5669f5d2f2e0da6959d2575308f1f5dde6326fbdc79f127a39605eaa4c9ed212e876ff0299715ed29b084aa73e31c73603f4078b5239f9b647b
+  data.tar.gz: 6eac07f7d1fe8a492e2db6254d5586988d21f096bdb005f7f3468fb8fe42c448dc13d4844db4edbd1e6aa5461b4ba54b02067ef7f36d48675c9a9f0814bfabfa

data/README.md

@@ -1,30 +1,154 @@
-# Constituent Parser
+Constituent-Parser
+------------------
 
-This repository contains a constituent parser component that provides a CLI
-interface and a webservice for the various constituent parser kernels.
+The constituent parser wraps several other constituent parsers into a component
+that parses the 6 main opener languages. Each language uses it's own parser and
+core. For more information on the specific languages, please check the
+individual cores.
 
-## Requirements
+* (English, Spanish and French)[https://github.com/opener-project/constituent-parser-base] - OpeNER
+* (German)[https://github.com/opener-project/constituent-parser-de] - Stanford
+  Based
+* (Dutch)[https://github.com/opener-project/constituent-parser-nl] - Alpino
+  Based
 
-* Ruby 1.9.2 or newer
 
-## Installation
+### Confused by some terminology?
 
-Installing as a regular Gem:
+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
+-----------------
+
+Installing the constituent-parser can be done by executing:
 
     gem install opener-constituent-parser
 
-Using Bundler:
+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 constituent parser as a regular shell
+command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
+
+This aplication reads a text from standard input in order to identify the language.
+
+    cat some_kind_of_kaf_file.kaf | constituent-parser
+
+
+This is an excerpt of an example output:
+
+```
+<!--he-->
+      <t id="ter761">
+        <span>
+          <target id="t761" />
+        </span>
+      </t>
+      <!--added-->
+      <t id="ter762">
+        <span>
+          <target id="t762" />
+        </span>
+      </t>
+      <!--.-->
+      <t id="ter763">
+        <span>
+          <target id="t763" />
+        </span>
+      </t>
+      <!--Tree edges-->
+      <edge id="tre2051" from="nter1328" to="nter1327" />
+      <edge id="tre2052" from="nter1329" to="nter1328" />
+      <edge id="tre2053" from="nter1330" to="nter1329" />
+      <edge id="tre2054" from="nter1331" to="nter1330" head="yes" />
+      <edge id="tre2055" from="nter1332" to="nter1331" head="yes" />
+      <edge id="tre2056" from="nter1333" to="nter1332" />
+
+```
+
+### Webservices
+
+You can launch a language identification webservice by executing:
+
+    constituent-parser-server
+
+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:
+
+    constituent-parser-server -p 1234
+
+It then launches at <http://localhost:1234>
+
+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.
+
+
+### Daemon
+
+Last but not least the constituent parser comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
+
+    constituent-parser-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:
+
+* Jruby (1.7.9 or newer)
+* Java 1.7 or newer (There are problems with encoding in older versions).
+* Python 2.6
+
+If you want to use the Dutch constituent parser you need to have:
+
+* Alpino (http://www.let.rug.nl/vannoord/alp/Alpino/AlpinoUserGuide.html)
+
+Language Extension
+------------------
+
+  TODO
+
+
+Where to go from here
+---------------------
+
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/constituent-parser]
+
+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/constituent-parser/issues].
 
-    gem 'opener-constituent-parser',
-      :git    => 'git@github.com:opener-project/constituent-parser.git',
-      :branch => 'master'
 
-Using specific install:
+Contributing
+------------
 
-    gem install specific_install
-    gem specific_install opener-constituent-parser \
-       -l https://github.com/opener-project/constituent-parser.git
+1. Fork it ( http://github.com/opener-project/constituent-parser/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
 
-## Usage
 
-    cat some_input_file.kaf | constituent-parser -l en

data/lib/opener/constituent_parser/cli.rb

@@ -57,12 +57,16 @@ Examples:
 
         stdout, stderr, process = runner.run(input)
 
-        if process.success?
-          puts stdout
+        if process
+          if process.success?
+            puts stdout
 
-          STDERR.puts(stderr) unless stderr.empty?
+            STDERR.puts(stderr) unless stderr.empty?
+          else
+            abort stderr
+          end
         else
-          abort stderr
+          puts stdout
         end
       end
 

data/lib/opener/constituent_parser/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class ConstituentParser
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end # ConstituentParser
 end # Opener

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: opener-constituent-parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opener-webservice
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: opener-constituent-parser-base
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: opener-build-tools
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 description: Constituent parser including a webservice.
-email: 
+email:
 executables:
 - constituent-parser
 - constituent-parser-server
@@ -85,28 +85,27 @@ files:
 - lib/opener/constituent_parser/version.rb
 - lib/opener/constituent_parser/views/index.erb
 - opener-constituent-parser.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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: 
+rubyforge_project:
 rubygems_version: 2.2.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Constituent parser including a webservice.
 test_files: []
-has_rdoc: yard