rq-ruby1.8 3.4.3 → 3.4.5

data/lib/rq/sqlite.rb

@@ -8,6 +8,8 @@
 # modify  it  under the terms of the BSD License as published by  the  Free
 # Software  Foundation. See also the rq LICENSE file.
 #
+# The license was changed for older sqlite-1.3.1 in agreement with Jamis Buck.
+#
 # The SQLite/Ruby Interface is distributed in the hope that it will be useful,
 # but   WITHOUT   ANY   WARRANTY;  without  even  the  implied  warranty  of
 # MERCHANTABILITY  or  FITNESS  FOR  A  PARTICULAR  PURPOSE.
@@ -16,6 +18,9 @@
 #
 # Author: Jamis Buck (jamis@jamisbuck.org)
 # --------------------------------------------------------------------------
+#
+# NOTE: rq still users the older sqlite2 engine and bindings. This will 
+# change.
 
 require '_sqlite'
 require 'time'

data/lib/rq/usage.rb

@@ -89,7 +89,13 @@ NAME
 
 SYNOPSIS
 
-  rq (queue | export RQ_Q=q) mode [mode_args]* [options]*
+  rq queue mode [mode_args]* [options]*
+
+  ruby queue (rq) is a zero-admin zero-configuration tool used to create
+  instant unix clusters on a multi-core machine, and/or multiple nodes in a
+  network, or in the Cloud. rq requires only a centrally mounted directory
+  (e.g. NFS) in order to manage a simple sqlite database as a distributed
+  priority work queue. See QUICK START below.
 
 usage_banner
 #--}}}
@@ -99,35 +105,96 @@ usage_banner
 #--{{{
 <<-usage
 #{ USAGE_BANNER }
-URIS
+DESCRIPTION
 
-    #{ WEBSITE } - main website
-    http://www.linuxjournal.com/article/7922
+  ruby queue (rq) is a zero-admin zero-configuration tool used to create
+  instant unix clusters. the simple design allows researchers with minimal unix
+  experience to install and configure, in only a few minutes and without root
+  privileges, a robust unix cluster capable of distributing processes to many
+  nodes - bringing dozens of powerful cpus to their knees with a single blow.
+  clearly this software should be kept out of the hands of free radicals, seti
+  enthusiasts, and one mr. j safran.
 
-  and
-  
-    http://rubyforge.org/projects/codeforpeople/
-    http://codeforpeople.com/lib/ruby/rq/
+  the central concept of rq is that n nodes work in isolation to pull jobs
+  from an centrally mounted nfs priority work queue in a synchronized fashion.
+  the nodes have absolutely no knowledge of each other and all communication
+  is done via the queue meaning that, so long as the queue is available via
+  nfs and a single node is running jobs from it, the system will continue to
+  process jobs.  there is no centralized process whatsoever - all nodes work
+  to take jobs from the queue and run them as fast as possible.  this creates
+  a system which load balances automatically and is robust in face of node
+  failures.
 
-LICENSE
+  although the rq system is simple in it's design it features powerful
+  functionality such as priority management, predicate and sql query, compact
+  streaming command-line processing, programmable api, hot-backup, and
+  input/capture of the stdin/stdout/stderr io streams of remote jobs. to date
+  rq has had no reported runtime failures and is in operation at
+  dozens of research centers around the world. while rq is written in
+  the Ruby programming language, there is no Ruby programming
+  involved in using rq.
 
-   rq is distributed under the BSD license, see the ./LICENSE file
+QUICK START
+
+  install rq using rubygems
+
+    gem1.8 install rq-ruby1.8
+    ln -sf `gem1.8 contents rq-ruby1.8|grep bin/rq$` /usr/local/bin/rq
+    rq --help
+
+  set up a directory for the queue - this can be a local, or an NFS/sshfs
+  mounted drive:
+
+    rq dir create
+
+  on every node create a queue runner, specifying the number of cores (here 8)
+
+    rq dir feed --daemon --log=rq.log --max_feed=8
+
+  submit two jobs - shell style
+   
+    rq dir submit 'sleep 10'
+    rq dir submit 'sleep 9'
+
+  check status
+
+    rq dir status
+
+  shows
+
+        --- 
+        jobs: 
+          pending: 0
+          holding: 0
+          running: 2
+          finished: 0
+          dead: 0
+          total: 2
+        temporal: 
+          running: 
+            min: {2: 00h00m03.49s}
+            max: {1: 00h00m03.60s}
+        performance: 
+          avg_time_per_job: 00h00m00.00s
+          n_jobs_in_last_hrs: 
+            1: 0
+            12: 0
+            24: 0
+        exit_status: 
+          successes: 0
+          failures: 0
+          ok: 0
+
+  Now, that was easy!!
 
 INSTALL
 
   See the ./INSTALL file, but quickly
 
-  gems (per node):
-
-    gem >=3.4.3:
+  gem >=#{VERSION}:
 
-      - install sqlite2 (Debian apt-get install libsqlite0-dev)
-      - wget http://rubyforge.org/frs/download.php/1070/sqlite-1.3.1.gem
-      - gem1.8 install sqlite-1.3.1.gem
-      - gem1.8 install posixlock
-      - gem1.8 install arrayfields
-      - gem1.8 install lockfile
-      - gem1.8 install rq-ruby1.8 (or run from source)
+    - install sqlite2 (Debian apt-get install libsqlite0-dev)
+    - gem1.8 install rq-ruby1.8 
 
     Also available from http://bio4.dnsalias.net/download/gem/ruby1.8/
 
@@ -144,37 +211,6 @@ INSTALL
 
     see ./INSTALL file for latest
 
-DESCRIPTION
-
-  ruby queue (rq) is a zero-admin zero-configuration tool used to create instant
-  unix clusters.  rq requires only a central nfs filesystem in order to manage a
-  simple sqlite database as a distributed priority work queue.  this simple
-  design allows researchers with minimal unix experience to install and
-  configure, in only a few minutes and without root privileges, a robust unix
-  cluster capable of distributing processes to many nodes - bringing dozens of
-  powerful cpus to their knees with a single blow.  clearly this software should
-  be kept out of the hands of free radicals, seti enthusiasts, and one mr. j
-  safran.
-
-  the central concept of rq is that n nodes work in isolation to pull jobs
-  from an centrally mounted nfs priority work queue in a synchronized fashion.
-  the nodes have absolutely no knowledge of each other and all communication
-  is done via the queue meaning that, so long as the queue is available via
-  nfs and a single node is running jobs from it, the system will continue to
-  process jobs.  there is no centralized process whatsoever - all nodes work
-  to take jobs from the queue and run them as fast as possible.  this creates
-  a system which load balances automatically and is robust in face of node
-  failures.
-
-  although the rq system is simple in it's design it features powerful
-  functionality such as priority management, predicate and sql query, compact
-  streaming command-line processing, programmable api, hot-backup, and
-  input/capture of the stdin/stdout/stderr io streams of remote jobs. to date
-  rq has had no reported runtime failures and is in operation at
-  dozens of research centers around the world. while rq is written in
-  the Ruby programming language, there is no Ruby programming
-  involved in using rq.
-
 INVOCATION
 
   the first argument to any rq command is the always the name of the queue
@@ -1178,6 +1214,16 @@ DIAGNOSTICS
  success : $? == 0
  failure : $? != 0
 
+URIS
+
+    #{ WEBSITE } - main website
+    http://www.linuxjournal.com/article/7922
+    http://rubyforge.org/projects/codeforpeople/ (original)
+
+LICENSE
+
+   rq is distributed under the BSD license, see the ./LICENSE file
+
 CREDITS
 
   - kim baugh       : patient tester and design input
@@ -1190,7 +1236,7 @@ CREDITS
 
 INSTALL
 
-    gem install rq-ruby1.8 (see top of page)
+    gem1.8 install rq-ruby1.8 (see top of page)
 
 TEST
 

data/rq-ruby1.8.gemspec

@@ -5,14 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rq-ruby1.8}
-  s.version = "3.4.3"
+  s.version = "3.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pjotr Prins"]
-  s.date = %q{2011-07-21}
+  s.date = %q{2011-07-23}
   s.description = %q{Zero configuration job scheduler for computer clusters}
   s.email = %q{pjotr.public01@thebird.nl}
   s.executables = ["rqmailer", "rq"]
+  s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README",
@@ -32,6 +33,8 @@ Gem::Specification.new do |s|
     "bin/rq",
     "bin/rqmailer",
     "example/a.rb",
+    "ext/extconf.rb",
+    "ext/sqlite.c",
     "extconf.rb",
     "gemspec.rb",
     "install.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rq-ruby1.8
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 29
   prerelease: false
   segments: 
   - 3
   - 4
-  - 3
-  version: 3.4.3
+  - 5
+  version: 3.4.5
 platform: ruby
 authors: 
 - Pjotr Prins
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-21 00:00:00 +02:00
+date: 2011-07-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,8 +97,8 @@ email: pjotr.public01@thebird.nl
 executables: 
 - rqmailer
 - rq
-extensions: []
-
+extensions: 
+- ext/extconf.rb
 extra_rdoc_files: 
 - LICENSE
 - README
@@ -117,6 +117,8 @@ files:
 - bin/rq
 - bin/rqmailer
 - example/a.rb
+- ext/extconf.rb
+- ext/sqlite.c
 - extconf.rb
 - gemspec.rb
 - install.rb