| Name | GailBotTools JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | None |
| Summary | A set of tools for handling data to create GailBot plugins |
| upload_time | 2024-11-21 19:53:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2023 Muhammad Umair Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
gailbot
plugins
data
tools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
lxml
gailbot
pydantic
pyyaml
userpaths
toml
boto3
argparse
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GailBotPluginsTools
## Overview
GailBotPluginsTools is a package designed to facilitate the creation and management of plugins for the GailBot platform. It simplifies the interaction with transcriptions, providing data handlers that manipulate XML markers and utterances.
## Features
- **Marker Utterance Dictionary**: Efficiently manages utterances, their timings, and speaker information.
- **Structured Interaction**: Provides an outer layer that wraps around the marker utterance dictionary for enhanced functionality.
- **Data Objects**: Defines necessary data structures for handling utterances effectively.
## Usage
The package includes several key modules:
### `marker_utterance_dict.py`
- **Class**: `MarkerUtteranceDict`
- **Purpose**: Creates a dictionary to manage utterances, keeping track of speaker information, start and end times, and overlaps.
- **Key Methods**:
- `__init__`: Initializes the dictionary with utterance data.
- `turn_criteria_overlaps`: Checks if the difference between two utterances meets a defined threshold.
### `StructureInteract.py`
- **Class**: `StructureInteract`
- **Purpose**: Interacts with the marker utterance dictionary and manages the output path for plugin results.
- **Key Methods**:
- `apply`: The main driver function that processes the input data and populates the data structure.
- `parse_xml_to_gbpluginmethods`: Converts XML data into a format usable by the GailBot Plugin methods.
### `data_objects.py`
- **Class**: `UttObj`
- **Purpose**: Defines the structure for an utterance object, encapsulating its properties like start time, end time, speaker, and text.
## Installation
To install the package, use the following command:
```bash
pip install gailbottools
```
## Example
Here is a simple example of how to use the package:
```python
from gailbot_plugin_tools import StructureInteract
# Sample XML data
xml_data = """
<transcript>
<u speaker="Speaker1">
<w start="0.0" end="0.5">Hello</w>
<w start="0.6" end="1.0">World</w>
</u>
</transcript>
"""
# Create an instance of StructureInteract
interactor = StructureInteract()
# Apply the XML data
interactor.apply(xml_data)
```
## Contributing
Contributions are welcome! Please submit a pull request or open an issue for suggestions and enhancements.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Authors
- Hannah Shader
- Jason Wu
- Jacob Boyar
- Vivian Li
- Eva Caro
- Manuel Pena
Raw data
{
"_id": null,
"home_page": null,
"name": "GailBotTools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "gailbot, plugins, data, tools",
"author": null,
"author_email": "HiLab <hil@elist.tufts.edu>",
"download_url": "https://files.pythonhosted.org/packages/56/53/98da81a1d218b750764ab02b4c7bea26e21df8348189826d3e037c242384/gailbottools-0.0.10.tar.gz",
"platform": null,
"description": "# GailBotPluginsTools\n\n## Overview\n\nGailBotPluginsTools is a package designed to facilitate the creation and management of plugins for the GailBot platform. It simplifies the interaction with transcriptions, providing data handlers that manipulate XML markers and utterances.\n\n## Features\n\n- **Marker Utterance Dictionary**: Efficiently manages utterances, their timings, and speaker information.\n- **Structured Interaction**: Provides an outer layer that wraps around the marker utterance dictionary for enhanced functionality.\n- **Data Objects**: Defines necessary data structures for handling utterances effectively.\n\n## Usage\n\nThe package includes several key modules:\n\n### `marker_utterance_dict.py`\n\n- **Class**: `MarkerUtteranceDict`\n- **Purpose**: Creates a dictionary to manage utterances, keeping track of speaker information, start and end times, and overlaps.\n- **Key Methods**:\n - `__init__`: Initializes the dictionary with utterance data.\n - `turn_criteria_overlaps`: Checks if the difference between two utterances meets a defined threshold.\n\n### `StructureInteract.py`\n\n- **Class**: `StructureInteract`\n- **Purpose**: Interacts with the marker utterance dictionary and manages the output path for plugin results.\n- **Key Methods**:\n - `apply`: The main driver function that processes the input data and populates the data structure.\n - `parse_xml_to_gbpluginmethods`: Converts XML data into a format usable by the GailBot Plugin methods.\n\n### `data_objects.py`\n\n- **Class**: `UttObj`\n- **Purpose**: Defines the structure for an utterance object, encapsulating its properties like start time, end time, speaker, and text.\n\n## Installation\n\nTo install the package, use the following command:\n\n```bash\npip install gailbottools\n```\n\n## Example\n\nHere is a simple example of how to use the package:\n\n```python\nfrom gailbot_plugin_tools import StructureInteract\n\n# Sample XML data\nxml_data = \"\"\"\n<transcript>\n <u speaker=\"Speaker1\">\n <w start=\"0.0\" end=\"0.5\">Hello</w>\n <w start=\"0.6\" end=\"1.0\">World</w>\n </u>\n</transcript>\n\"\"\"\n\n# Create an instance of StructureInteract\ninteractor = StructureInteract()\n# Apply the XML data\ninteractor.apply(xml_data)\n```\n\n## Contributing\n\nContributions are welcome! Please submit a pull request or open an issue for suggestions and enhancements.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Authors\n\n- Hannah Shader\n- Jason Wu\n- Jacob Boyar\n- Vivian Li\n- Eva Caro\n- Manuel Pena\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Muhammad Umair Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A set of tools for handling data to create GailBot plugins",
"version": "0.0.10",
"project_urls": {
"homepage": "https://github.com/GailBot-System/GailBotPlugins"
},
"split_keywords": [
"gailbot",
" plugins",
" data",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d27310b2a142171203e525f8d4c587b03232637a404cb59127b91558cef6e81c",
"md5": "1e3ca71c3d5c54aeb43699df746a3552",
"sha256": "e9ed953b1f6a528e67ebcdcd88c5ed3695ac05b88ac2e16779e5c8d47b6f2dc4"
},
"downloads": -1,
"filename": "GailBotTools-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e3ca71c3d5c54aeb43699df746a3552",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19684,
"upload_time": "2024-11-21T19:52:35",
"upload_time_iso_8601": "2024-11-21T19:52:35.903501Z",
"url": "https://files.pythonhosted.org/packages/d2/73/10b2a142171203e525f8d4c587b03232637a404cb59127b91558cef6e81c/GailBotTools-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "565398da81a1d218b750764ab02b4c7bea26e21df8348189826d3e037c242384",
"md5": "f664961386c7bd2cce1251ecebc919aa",
"sha256": "ede7ff0c6ee712a7e4f76cc7fe63f4f77844f2324fae238f76fecdeda2a8617c"
},
"downloads": -1,
"filename": "gailbottools-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "f664961386c7bd2cce1251ecebc919aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16744,
"upload_time": "2024-11-21T19:53:11",
"upload_time_iso_8601": "2024-11-21T19:53:11.825804Z",
"url": "https://files.pythonhosted.org/packages/56/53/98da81a1d218b750764ab02b4c7bea26e21df8348189826d3e037c242384/gailbottools-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 19:53:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GailBot-System",
"github_project": "GailBotPlugins",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "lxml",
"specs": [
[
"==",
"4.9.1"
]
]
},
{
"name": "gailbot",
"specs": [
[
">=",
"0.0.1"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "userpaths",
"specs": [
[
"==",
"0.1.3"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
},
{
"name": "boto3",
"specs": [
[
">=",
"1.35.0"
]
]
},
{
"name": "argparse",
"specs": [
[
">=",
"3.12"
]
]
}
],
"lcname": "gailbottools"
}
