Metadata-Version: 2.1
Name: threaded-task-executor
Version: 1.0
Summary: Spawn a thread that executes tasks in order
Home-page: http://github.com/enchant97/python-threadedtaskexecutor
Author: enchant97
Author-email: contact@enchantedcode.co.uk
License: mit
Description: # Threaded Task Executor
        Allows functions to be called in a seperate thread and executed in FIFO order.
        ## Possible Uses:
        - For serial communication where send/recv order matters
        - Run background tasks in tkinter easily, without freezing gui
        - Any application where background tasks are required to be executed in order
        ## Gettings Started:
        ### Installing
        ```
        pip install threaded-task-executor
        ```
        ### Importing
        ```python
        from threaded_task_executor import Task_Queue, Task
        ```
        ### How To Use
        ```python
        tasks = Task_Queue()
        tasks.add_task(Task(print, args=("test 1")))
        tasks.add_task(Task(print, args=("test 2")))
        ```
        When this is run it should start the thread
        and execute the tasks in FIFO order.
        
        ## Documentation:
        ```python
        Task(func, callback=None, task_name="", args=(), kwargs={})
        ```
        - func : the function that will be called when executed
        - callback : function that will be run when the task has started and finished
            - callback("STARTED", task_name)
            - callback("FINISHED", task_name)
        - task_name : the name of the task
        - args : tuple of arguments that will be given to the function
        - kwargs : dict of keyword arguments that will be given to the function
        
        ```python
        Task_Queue(daemon=None)
        ```
        - daemon : (True, False, None) : Whether main thread has to wait for thread to finish before stopping main thread
        - add_task(new_task) : Adds a new task obj, if there is no threads running will start one
        - get_current_task() : Allows for the current task that is executing to be returned
        - tasks_left() : Returns the number of tasks left to be completed, includes currently executing task if any.
        
Keywords: threading tasks order queue
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Description-Content-Type: text/markdown
