Python package, bump version number (#4)

Author: gabfl

.gitignore

@@ -5,6 +5,9 @@ tools/
 __pycache__/
 *.py[cod]
 .Python
+rpq.egg-info/
+build/
+dist/
 
 # Mac
 .DS_Store

README.md

@@ -103,14 +103,20 @@ Output is similar to [ZCOUNT](https://redis.io/commands/zcount)
 
 The queues can be easily monitored with the Python script `src/queue_monitor.py`
 
-To use the queue monitor, you need to ensure python is installed and use the following command to add the required packages:
-`pip install prettytable argparse redis json`
+To use the queue monitor, you need to ensure python is installed and use the following command:
+```
+# Installation
+pip3 install rpq
+
+# Usage
+rpq_monitor
+```
 
 ### Usage example
 
 ```
 # Basic usage
-./src/queue_monitor.py -H [host] -p [port] (-a [auth] -n [dbnum])
+rpq_monitor -H [host] -p [port] (-a [auth] -n [dbnum])
 +-------------------+-------+-----------+----------+
 | Queue name        | Total | Up to 100 | From 101 |
 +-------------------+-------+-----------+----------+
@@ -122,7 +128,7 @@ To use the queue monitor, you need to ensure python is installed and use the fol
 +-------------------+-------+-----------+----------+
 
 # Specify your own groups
-./src/queue_monitor.py -H [host] -p [port] (-a [auth] -n [dbnum]) -s "[[0, 1000], [1001, 2000], [2001, 3000]]"
+rpq_monitor -H [host] -p [port] (-a [auth] -n [dbnum]) -s "[[0, 1000], [1001, 2000], [2001, 3000]]"
 +-------------------+-------+------------+----------------+----------------+
 | Queue name        | Total | 0 to 1,000 | 1,001 to 2,000 | 2,001 to 3,000 |
 +-------------------+-------+------------+----------------+----------------+

clients/python/README.md

@@ -5,7 +5,12 @@ Python client for redis-priority-queue.
 ## Requirements
 
  - Python 2.7 & 3
- - Redis Python package (`pip install redis`)
+
+## Installation
+
+```
+pip3 install rpq
+```
 
 ## Sample use
 
@@ -14,18 +19,18 @@ Python client for redis-priority-queue.
 
 # Packages
 import redis
-from lib.RpqQueue import RpqQueue
-from lib.RpqLua import RpqLua
+from rpq import RpqQueue
+from rpq import RpqLua
 
 # Redis instance
-r = redis.StrictRedis(host='127.0.0.1', port=6379, db=0, password='')
+r = redis.StrictRedis(host = '127.0.0.1', port = 6379, db = 0, password = '')
 
 # Load LUA Script
-RpqLua = RpqLua(r, '../../src/redis-priority-queue.lua');
+RpqLua = RpqLua.RpqLua(r);
 queue = RpqLua.register();
 
 # RpqQueue instance
-RpqQueue = RpqQueue(queue)
+RpqQueue = RpqQueue.RpqQueue(queue)
 
 # Set queue name
 RpqQueue.setqueueName('simple_queue')

clients/python/count.py renamed to clients/python/examples/count.py

@@ -2,20 +2,18 @@
 
 # Packages
 import redis
-from lib.RpqQueue import RpqQueue
-from lib.RpqLua import RpqLua
-from utils.redis_vars import *
+from rpq import RpqQueue
+from rpq import RpqLua
 
 # Redis instance
-# !!! set Redis credentials into utils/redis_vars.py
-r = redis.StrictRedis(host=rHost, port=rPort, db=rDbnum, password=rAuth)
+r = redis.StrictRedis(host = '127.0.0.1', port = 6379, db = 0, password = '')
 
 # Load LUA Script
-RpqLua = RpqLua(r, '../../src/redis-priority-queue.lua');
+RpqLua = RpqLua.RpqLua(r);
 queue = RpqLua.register();
 
 # RpqQueue instance
-RpqQueue = RpqQueue(queue);
+RpqQueue = RpqQueue.RpqQueue(queue);
 
 # Set queue name
 RpqQueue.setqueueName('simple_queue')
@@ -29,4 +27,4 @@
 print (RpqQueue.count(0, 100))
 
 print ('* count (priority > 100):')
-print (RpqQueue.count(101))
+print (RpqQueue.count(101))

clients/python/peek.py renamed to clients/python/examples/peek.py

@@ -2,25 +2,23 @@
 
 # Packages
 import redis
-from lib.RpqQueue import RpqQueue
-from lib.RpqLua import RpqLua
-from utils.redis_vars import *
+from rpq import RpqQueue
+from rpq import RpqLua
 
 def listItems(items):
     '''Helper to print items'''
     for item in items:
         print (item);
 
 # Redis instance
-# !!! set Redis credentials into utils/redis_vars.py
-r = redis.StrictRedis(host=rHost, port=rPort, db=rDbnum, password=rAuth)
+r = redis.StrictRedis(host = '127.0.0.1', port = 6379, db = 0, password = '')
 
 # Load LUA Script
-RpqLua = RpqLua(r, '../../src/redis-priority-queue.lua');
+RpqLua = RpqLua.RpqLua(r);
 queue = RpqLua.register();
 
 # RpqQueue instance
-RpqQueue = RpqQueue(queue);
+RpqQueue = RpqQueue.RpqQueue(queue);
 
 # Set queue name
 RpqQueue.setqueueName('simple_queue')

clients/python/pop.py renamed to clients/python/examples/pop.py

@@ -2,25 +2,23 @@
 
 # Packages
 import redis
-from lib.RpqQueue import RpqQueue
-from lib.RpqLua import RpqLua
-from utils.redis_vars import *
+from rpq import RpqQueue
+from rpq import RpqLua
 
 def listItems(items):
     '''Helper to print items'''
     for item in items:
         print (item);
 
 # Redis instance
-# !!! set Redis credentials into utils/redis_vars.py
-r = redis.StrictRedis(host=rHost, port=rPort, db=rDbnum, password=rAuth)
+r = redis.StrictRedis(host = '127.0.0.1', port = 6379, db = 0, password = '')
 
 # Load LUA Script
-RpqLua = RpqLua(r, '../../src/redis-priority-queue.lua');
+RpqLua = RpqLua.RpqLua(r);
 queue = RpqLua.register();
 
 # RpqQueue instance
-RpqQueue = RpqQueue(queue);
+RpqQueue = RpqQueue.RpqQueue(queue);
 
 # Set queue name
 RpqQueue.setqueueName('simple_queue')

clients/python/push.py renamed to clients/python/examples/push.py

@@ -2,9 +2,8 @@
 
 # Packages
 import redis, random
-from lib.RpqQueue import RpqQueue
-from lib.RpqLua import RpqLua
-from utils.redis_vars import *
+from rpq import RpqQueue
+from rpq import RpqLua
 
 def generateRandom():
     '''Helper: get a random integer'''
@@ -15,15 +14,14 @@ def getItem():
     return 'item_' + str(generateRandom());
 
 # Redis instance
-# !!! set Redis credentials into utils/redis_vars.py
-r = redis.StrictRedis(host=rHost, port=rPort, db=rDbnum, password=rAuth)
+r = redis.StrictRedis(host = '127.0.0.1', port = 6379, db = 0, password = '')
 
 # Load LUA Script
-RpqLua = RpqLua(r, '../../src/redis-priority-queue.lua');
+RpqLua = RpqLua.RpqLua(r);
 queue = RpqLua.register();
 
 # RpqQueue instance
-RpqQueue = RpqQueue(queue);
+RpqQueue = RpqQueue.RpqQueue(queue);
 
 # Set queue name
 RpqQueue.setqueueName('simple_queue')
@@ -38,4 +36,4 @@ def getItem():
 print ('* push (with priority):')
 item = getItem() # Item we will push to the queue
 print ('Pushing item "%s" to the queue' % (item))
-print (RpqQueue.push(item, 1000))
+print (RpqQueue.push(item, 1000))

clients/python/lib/RpqLua.py

@@ -1,25 +1,39 @@
 #!/usr/bin/env python3
 
 class RpqLua:
-    def __init__(self, redisConnection, luaPath):
+    def __init__(self, redisConnection):
         '''Sets Redis connection, load LUA from path'''
+
         self.setRedisConnection(redisConnection);
-        self.loadSource(luaPath);
+        self.loadSource(self.getLuaPath());
+
+    def getLuaPath(self):
+        """
+            Returns the LUA path in the filesystem
+        """
+
+        import rpq_src, pkg_resources
+
+        return pkg_resources.resource_filename('rpq_src', 'redis-priority-queue.lua');
 
     def file_get_contents(self, filename):
         '''Get a file content'''
+
         with open(filename) as f:
             return f.read()
 
     def setRedisConnection(self, connection):
         '''Set a Redis connection'''
+
         self.connection = connection;
 
     def loadSource(self, path):
         '''Load LUA script source code from a file'''
+
         self.source = self.file_get_contents(path);
 
     def register(self):
         '''Load the script into Redis'''
+
         self.queue = self.connection.register_script(self.source)
         return self.queue;

clients/python/utils/redis_vars.py

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.cfg

@@ -0,0 +1,23 @@
+from setuptools import setup
+
+setup (
+    name = 'rpq',
+    version = '1.0.4',
+    description = 'Simple Redis work queue with added features (priorities, pop multiple items at once)',
+    long_description = 'README.md',
+    author = 'Gabriel Bordeaux',
+    author_email = '[email protected]',
+    url = 'https://github.com/gabfl/redis-priority-queue',
+    license = 'MIT',
+    packages = ['rpq', 'rpq_src'],
+    package_dir = { 'rpq': 'clients/python/lib', 'rpq_src': 'src' },
+    package_data={
+      'rpq_src': ['*.lua'],
+   },
+    install_requires = ['redis', 'argparse', 'prettytable'], # external dependencies
+    entry_points = {
+        'console_scripts': [
+            'rpq_monitor = rpq_src.queue_monitor:main',
+        ],
+    },
+)

setup.py

@@ -22,6 +22,10 @@
                     help="Sort groups", type=json.loads)
 args = parser.parse_args()
 
+# Global vars
+t = None
+r = None
+
 def setSortGroups(sortGroups = None):
     """Return the sorting groups, either user defined or from the default list"""
     if sortGroups is None: # Default groups
@@ -32,10 +36,14 @@ def setSortGroups(sortGroups = None):
 
 def getCount(queueName, min, max):
     """Fetches set count from Redis"""
+
+    global r
+
     return r.zcount(queueName, min, max);
 
 def getColumnTitle(min, max):
     """Human readable column titles"""
+
     if str(min) == '-inf' and str(max) == '+inf':
         return 'Total';
     elif str(min) == '-inf':
@@ -49,38 +57,46 @@ def getColumnTitle(min, max):
 
 def setColumnAlign(titles):
     """Set PrettyTable column alignment"""
-    global t;
+
+    global t
+
     for i, title in enumerate(titles):
         if i == 0: # First column (title)
             t.align[title] = 'l'; # Left
         else: # Any other column
             t.align[title] = 'r'; # Right
 
-# Redis connection
-r = redis.StrictRedis(host=args.host, port=args.port, db=args.dbnum, password=args.auth)
+def main():
+    global t, r
+
+    # Redis connection
+    r = redis.StrictRedis(host = args.host, port = args.port, db = args.dbnum, password = args.auth)
+
+    # Sort groups
+    sortGroups = setSortGroups(args.sort_groups);
 
-# Sort groups
-sortGroups = setSortGroups(args.sort_groups);
+    # Column titles (queue name, then a column per sorting group)
+    titles = ['Queue name'];
+    titles.extend([getColumnTitle(sortGroup[0], sortGroup[1]) for sortGroup in sortGroups]);
 
-# Column titles (queue name, then a column per sorting group)
-titles = ['Queue name'];
-titles.extend([getColumnTitle(sortGroup[0], sortGroup[1]) for sortGroup in sortGroups]);
+    # Create table
+    t = PrettyTable(titles);
+    setColumnAlign(titles);
 
-# Create table
-t = PrettyTable(titles);
-setColumnAlign(titles);
+    # Get queues
+    queueNames = r.smembers('rpq|names')
 
-# Get queues
-queueNames = r.smembers('rpq|names')
+    # Add a row par queue
+    for queueName in sorted(queueNames):
+        # Get row
+        row = [queueName.decode("utf-8")]
+        row.extend(['{0:,}'.format(getCount(queueName, sortGroup[0], sortGroup[1])) for sortGroup in sortGroups]);
 
-# Add a row par queue
-for queueName in sorted(queueNames):
-    # Get row
-    row = [queueName.decode("utf-8")]
-    row.extend(['{0:,}'.format(getCount(queueName, sortGroup[0], sortGroup[1])) for sortGroup in sortGroups]);
+        # Add row
+        t.add_row(row);
 
-    # Add row
-    t.add_row(row);
+    # Print table
+    print (t);
 
-# Print table
-print (t);
+if __name__ == '__main__':
+    main()

clients/python/utils/__init__.py renamed to src/__init__.py

@@ -1,7 +1,7 @@
 -- redis-priority-queue
 -- Author: Gabriel Bordeaux (gabfl)
 -- Github: https://github.com/gabfl/redis-priority-queue
--- Version: 1.0.3
+-- Version: 1.0.4
 -- (can only be used in 3.2+)
 
 -- Get mandatory vars