task-q


Nametask-q JSON
Version 1.1.3 PyPI version JSON
download
home_page
SummaryA simple commandline app that implements a task queue
upload_time2021-01-13 20:05:14
maintainer
docs_urlNone
authorRodrigo Cunha
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TaskQ

Simple CLI for multi user queue execution in Linux. TaskQ allows a single computer
to be used by different users concurrently. TaskQ allows each user to submit a
task to the same queue, which will be handled by the Task Handler Bot.

## 1. Setup

### 1.1. Installing TaskQ

TaskQ needs to be installed in order to set its dependecies correctly.
In order to do that, it needs a folder to be the TaskQ home, where the app
will save its local files, and also an UID to define
the owner of TaskQ's queue. It is important to note that the Task Handler Bot
will run with the privileges of user that executed the installation step below.

``
sudo taskq install $HOME $(id -u $USER)
``

### 1.2. Starting Task Handler

The Task Handler is the bot that will execute the tasks in the TaskQ queue.
It is necessary to start it manually. It is important to note that only the
TaskQ queue owner has the priviliges to start or to stop the Task Handler.

``
taskq start
``

In order to stop the queue, do:

``
taskq stop
``

## 2. Using the TaskQ


### 2.1. Show the queue

To show the queue waiting list, run the command below:

``
taskq show-queue
``

It is possible to filter the table with the options below:
- **all**: shows all the tasks in the queue, including the completed and failed ones.
- **running**: shows only the tasks that are running at the moment
- **mine**: shows only the tasks that belong to the user
- **done**: shows only the tasks that are complete


### 2.2. Add a task to the queue

A task for TaskQ is basically a bash command that will be executed within the
queue owner context. To add a task to the queue, do:

``
taskq add '<command string>'
``

### 2.3. Abort a task

Aborting a task will remove it out of the waiting list:

``
taskq abort <task id>
``

### 2.4. Reset a task

Reseting a task will put it back into the waiting list:

``
taskq reset <task id>
``

For more information, excecute ``taskq --help``.



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "task-q",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Rodrigo Cunha",
    "author_email": "rodra.xyz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/67/f8/cf590fd217517bc52f999e4743cbd0a1b45419f48898472e422bcdb4e353/task-q-1.1.3.tar.gz",
    "platform": "",
    "description": "# TaskQ\n\nSimple CLI for multi user queue execution in Linux. TaskQ allows a single computer\nto be used by different users concurrently. TaskQ allows each user to submit a\ntask to the same queue, which will be handled by the Task Handler Bot.\n\n## 1. Setup\n\n### 1.1. Installing TaskQ\n\nTaskQ needs to be installed in order to set its dependecies correctly.\nIn order to do that, it needs a folder to be the TaskQ home, where the app\nwill save its local files, and also an UID to define\nthe owner of TaskQ's queue. It is important to note that the Task Handler Bot\nwill run with the privileges of user that executed the installation step below.\n\n``\nsudo taskq install $HOME $(id -u $USER)\n``\n\n### 1.2. Starting Task Handler\n\nThe Task Handler is the bot that will execute the tasks in the TaskQ queue.\nIt is necessary to start it manually. It is important to note that only the\nTaskQ queue owner has the priviliges to start or to stop the Task Handler.\n\n``\ntaskq start\n``\n\nIn order to stop the queue, do:\n\n``\ntaskq stop\n``\n\n## 2. Using the TaskQ\n\n\n### 2.1. Show the queue\n\nTo show the queue waiting list, run the command below:\n\n``\ntaskq show-queue\n``\n\nIt is possible to filter the table with the options below:\n- **all**: shows all the tasks in the queue, including the completed and failed ones.\n- **running**: shows only the tasks that are running at the moment\n- **mine**: shows only the tasks that belong to the user\n- **done**: shows only the tasks that are complete\n\n\n### 2.2. Add a task to the queue\n\nA task for TaskQ is basically a bash command that will be executed within the\nqueue owner context. To add a task to the queue, do:\n\n``\ntaskq add '<command string>'\n``\n\n### 2.3. Abort a task\n\nAborting a task will remove it out of the waiting list:\n\n``\ntaskq abort <task id>\n``\n\n### 2.4. Reset a task\n\nReseting a task will put it back into the waiting list:\n\n``\ntaskq reset <task id>\n``\n\nFor more information, excecute ``taskq --help``.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple commandline app that implements a task queue",
    "version": "1.1.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0325b0cc313eb008f4cbb98483cd4a4e",
                "sha256": "9d9bd49ac1d3259fd899f1fe3bd331dd9c4f851fed3c10adcf47f180efc8861f"
            },
            "downloads": -1,
            "filename": "task_q-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0325b0cc313eb008f4cbb98483cd4a4e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8892,
            "upload_time": "2021-01-13T20:05:12",
            "upload_time_iso_8601": "2021-01-13T20:05:12.873492Z",
            "url": "https://files.pythonhosted.org/packages/03/34/c699c44586326b16821b290ee605a68662e43b5789c9f8738cb55ee781f7/task_q-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "75dd710bde05130d27a157a7c7b4402b",
                "sha256": "5f9428d75a0f6aa8354fb7e15773724e2d8a273b4c1fff6a9b7f0f03772fee4d"
            },
            "downloads": -1,
            "filename": "task-q-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "75dd710bde05130d27a157a7c7b4402b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7295,
            "upload_time": "2021-01-13T20:05:14",
            "upload_time_iso_8601": "2021-01-13T20:05:14.267725Z",
            "url": "https://files.pythonhosted.org/packages/67/f8/cf590fd217517bc52f999e4743cbd0a1b45419f48898472e422bcdb4e353/task-q-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-01-13 20:05:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "task-q"
}
        
Elapsed time: 0.22289s