# task-tracker
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Install
Currently, task-tracker is not available on pip or conda. It will be
accessible via the command below after release, whenever a stable
version is created.
``` sh
pip install task_tracker
```
## How to use
*Example on how to use task-tracker on a `lasagne recipe`.*
<div>
> **Note**
>
> You can find the notebook and the results of the `lasagne recipe` at
> <https://github.com/KonKob/task-tracker/blob/main/test_data>.
</div>
------------------------------------------------------------------------
### This is how the landing page looks like after completing a trial:
- Whenever the trial is started here, an audio recording is started,
that can be transcribed after completion of the trial.
- At the right you see the timeline of tasks over the session so far.
You can update it at any time.
- In the middle of the landing page, you can add a description manually
to running or finished tasks.
- The proband metadata can be saved at any time by clicking
`Export proband metadata`.
- To pause all tasks, you can click `Start pause for all` during a
running trial.
### The proband metadata can be entered in the following mask:
### Tasks, that you want to track, are shown in different tabs.
- Whenever you click on a task, this task is started and another task
running in this tab is ended. You can end a task by clicking
`No task running` as well.
- If you find, that you forgot a tasks, you can add it by entering the
name in the grey line `Other` and then clicking the grey button
`Other`.
- To pause a task, just hit `Start pause`.
------------------------------------------------------------------------
### Exporting the results creates excel files.
``` python
from task_tracker.utils import load_trial
trial = load_trial("../test_data/2023-08-07_17.43.23_0000_Chef/")
trial.tasks_dataframe.head()
```
<div>
<style scoped>
.dataframe tbody tr th:only-of-type {
vertical-align: middle;
}
.dataframe tbody tr th {
vertical-align: top;
}
.dataframe thead th {
text-align: right;
}
</style>
| | lane | duration_in_s | task_number | task_name | start_time | end_time | description_0 |
|-----|--------------------|---------------|-------------|-----------|------------|----------|---------------|
| 0 | Kitchen appliances | 1.3528 | 12 | Pause | 203.6099 | 204.9627 | 220°C |
| 1 | Kitchen appliances | 52.8952 | 6 | Stove | 89.5415 | 142.4367 | NaN |
| 2 | Kitchen appliances | 111.9687 | 12 | Oven | 142.4370 | 255.7585 | 220°C |
| 3 | Ingredients | 28.0470 | 0 | Onions | 10.3749 | 38.4219 | NaN |
| 4 | Ingredients | 19.8456 | 2 | Carrots | 39.5850 | 59.4306 | NaN |
</div>
### For visualization, several plots are created.
#### The cumulative duration spent in certain tasks can be shown as bar and tie plots.
#### It can also be shown, how much time was spent in tasks running in parallel to other tasks.
Raw data
{
"_id": null,
"home_page": "https://github.com/KonKob/task-tracker",
"name": "task-tracker-task-tracker",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "Konstantin Kobel",
"author_email": "kobel.konstantin@web.de",
"download_url": "",
"platform": null,
"description": "# task-tracker\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Install\n\nCurrently, task-tracker is not available on pip or conda. It will be\naccessible via the command below after release, whenever a stable\nversion is created.\n\n``` sh\npip install task_tracker\n```\n\n## How to use\n\n*Example on how to use task-tracker on a `lasagne recipe`.*\n\n<div>\n\n> **Note**\n>\n> You can find the notebook and the results of the `lasagne recipe` at\n> <https://github.com/KonKob/task-tracker/blob/main/test_data>.\n\n</div>\n\n------------------------------------------------------------------------\n\n### This is how the landing page looks like after completing a trial:\n\n\n\n- Whenever the trial is started here, an audio recording is started,\n that can be transcribed after completion of the trial.\n\n- At the right you see the timeline of tasks over the session so far.\n You can update it at any time.\n\n- In the middle of the landing page, you can add a description manually\n to running or finished tasks.\n\n- The proband metadata can be saved at any time by clicking\n `Export proband metadata`.\n\n- To pause all tasks, you can click `Start pause for all` during a\n running trial.\n\n### The proband metadata can be entered in the following mask:\n\n\n\n### Tasks, that you want to track, are shown in different tabs.\n\n\n\n- Whenever you click on a task, this task is started and another task\n running in this tab is ended. You can end a task by clicking\n `No task running` as well.\n\n- If you find, that you forgot a tasks, you can add it by entering the\n name in the grey line `Other` and then clicking the grey button\n `Other`.\n\n- To pause a task, just hit `Start pause`.\n\n------------------------------------------------------------------------\n\n### Exporting the results creates excel files.\n\n``` python\nfrom task_tracker.utils import load_trial\ntrial = load_trial(\"../test_data/2023-08-07_17.43.23_0000_Chef/\")\ntrial.tasks_dataframe.head()\n```\n\n<div>\n<style scoped>\n .dataframe tbody tr th:only-of-type {\n vertical-align: middle;\n }\n .dataframe tbody tr th {\n vertical-align: top;\n }\n .dataframe thead th {\n text-align: right;\n }\n</style>\n\n| | lane | duration_in_s | task_number | task_name | start_time | end_time | description_0 |\n|-----|--------------------|---------------|-------------|-----------|------------|----------|---------------|\n| 0 | Kitchen appliances | 1.3528 | 12 | Pause | 203.6099 | 204.9627 | 220\u00b0C |\n| 1 | Kitchen appliances | 52.8952 | 6 | Stove | 89.5415 | 142.4367 | NaN |\n| 2 | Kitchen appliances | 111.9687 | 12 | Oven | 142.4370 | 255.7585 | 220\u00b0C |\n| 3 | Ingredients | 28.0470 | 0 | Onions | 10.3749 | 38.4219 | NaN |\n| 4 | Ingredients | 19.8456 | 2 | Carrots | 39.5850 | 59.4306 | NaN |\n\n</div>\n\n### For visualization, several plots are created.\n\n#### The cumulative duration spent in certain tasks can be shown as bar and tie plots.\n\n\n\n#### It can also be shown, how much time was spent in tasks running in parallel to other tasks.\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "A tool to track tasks, record audio and collect probands' demographics, designed to be used in a think-aloud approach",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/KonKob/task-tracker"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb2ec04f70b5baf1cffe430d7a64167ac25a8a13f8e3222ecb1d69cb5b796f53",
"md5": "0dfe8018e1780f4fb76fe0e39761301d",
"sha256": "a70e2c7b956a46692570fdbdeb2f23672360acd165ab5bfd7d3d47705c53cb60"
},
"downloads": -1,
"filename": "task_tracker_task_tracker-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0dfe8018e1780f4fb76fe0e39761301d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 22504,
"upload_time": "2023-09-26T11:31:49",
"upload_time_iso_8601": "2023-09-26T11:31:49.158067Z",
"url": "https://files.pythonhosted.org/packages/fb/2e/c04f70b5baf1cffe430d7a64167ac25a8a13f8e3222ecb1d69cb5b796f53/task_tracker_task_tracker-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 11:31:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KonKob",
"github_project": "task-tracker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "task-tracker-task-tracker"
}
JSON
