Metadata-Version: 2.1
Name: pool_workers
Version: 0.0.3
Summary: A small package for dealing with pools, workers and queues.
Home-page: https://github.com/medram/pool_workers
Author: Mohammed ER-Ramouchy
Author-email: mohammed@ramouchy.com
License: UNKNOWN
Description: # Pool_Workers
        Pool_Workers is a small package for dealing with pools, workers and queues.
        
        ## Installation:
        ```
        $ pip install pool_workers
        ```
        
        ## How to Use?
        Please see some examples at 'examples' folder.
        
        ## More info:
        Describe some useful functions at pool & worker objects
        
        ```Python
        pool = Pool(...)
        
        pool.start()		# Start all workers to process queue tasks.
        pool.is_alive()		# Return true if is there any alive worker, else false.
        pool.is_idle()		# Return true if is there any worker in idle mode, else false.
        pool.is_done()		# Return true if the queue is empty (no tasks left to process).
        pool.is_paused()	# Return true if the all workers have been paused, else false.
        pool.shutdown()		# Abort all workers
        pool.join()			# Wait for all workers to finish the all queue tasks.
        pool.result()		# return a list result
        pool.pause()		# pause the all workers
        pool.resume()		# resume the all workers
        pool.count()		# count workers
        pool.update()		# adjust the number of workers
        
        worker = Worker(...)
        
        worker.start()
        worker.abort()		# stop worker in a safe way
        worker.aborted()
        worker.pause()
        worker.paused()
        worker.resume()
        # And like a normal thread, worker has also:
        worker.is_alive()
        worker.join()
        
        
        ```
        
        ## License
        MIT License
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
