README
1Redis::JobQueue package version 1.19
2====================================
3
4The Redis::JobQueue package is a set of Perl modules which provides a
5simple job queue with Redis server capabilities.
6
7The Redis::JobQueue package was written, tested, and found working on
8recent Linux distributions.
9
10INSTALLATION
11
12To install this package type the following:
13
14 perl Makefile.PL
15 make
16 make test
17 make install
18
19DEPENDENCIES
20
21In order to install and use this package you will need Perl version
225.010 or better. Some modules within this package depend on other
23packages that are distributed separately from Perl. We recommend that
24you have the following packages installed before you install
25Redis::JobQueue :
26
27 Data::UUID
28 Digest::SHA1
29 List::MoreUtils
30 Mouse
31 Params::Util
32 Redis
33 Storable
34 Try::Tiny
35
36The Redis::JobQueue package has the following optional dependencies:
37
38 Net::EmptyPort
39 Test::Deep
40 Test::Exception
41 Test::NoWarnings
42 Test::RedisServer
43
44If the optional modules are missing, some "prereq" tests are skipped.
45
46The installation of the missing dependencies can either be accomplished
47through your OS package manager or through CPAN (or downloading the source
48for all dependencies and compiling them manually).
49
50TESTING
51
52You need to have a running Redis instance before launching the test.
53
54DOCUMENTATION
55
56Every Redis::JobQueue package module has a man page.
57A simple description of each module is included below in the SEE ALSO section.
58
59SOURCE CODE
60Redis::JobQueue is hosted on GitHub:
61https://github.com/TrackingSoft/Redis-JobQueue
62
63SEE ALSO
64
65The basic operation of the Redis::JobQueue package modules:
66
67 Redis::JobQueue - Object interface for creating and executing jobs
68 queues, as well as monitoring the status and results
69 of jobs
70 Redis::JobQueue::Job - Object interface for creating and manipulating jobs
71 Redis::JobQueue::Util - String manipulation utilities
72
73COPYRIGHT AND LICENCE
74
75Copyright (C) 2012-2016 by TrackingSoft LLC.
76
77This package is free software; you can redistribute it and/or modify it under
78the same terms as Perl itself. See perlartistic at
79http://dev.perl.org/licenses/artistic.html .
80
81This program is distributed in the hope that it will be useful,
82but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
83or FITNESS FOR A PARTICULAR PURPOSE.
84