# Cow-says Gear (cow-says)
## Overview
### Summary
The CowSays gear is an demo utility gear that makes animals speak. It uses as an example to illustrate how our skeleton
gear template (available at https://gitlab.com/flywheel-io/scientific-solutions/gears/templates/skeleton) can be used.
### Cite
*License:* MIT
### Classification
*Category:* converter
*Gear Level:*
- [ ] Project
- [ ] Subject
- [ ] Session
- [X] Acquisition
- [ ] Analysis
----
[[_TOC_]]
----
### Inputs
- *text-input*
- __Name__: text-file
- __Type__: file
- __Optional__: False
- __Description__: Text file for the animal.
### Config
- *debug*
- __Name__: debug
- __Type__: boolean
- __Description__: Log debug messages
- __Default__: False
- *animal*
- __Name__: animal
- __Type__: string
- __Description__: Type of animal
- __Default__: cow
### Outputs
This gear will generate an image of the selected
animal along with the message from the input text file.
<!-- markdownlint-disable-file MD040 -->
```
______________
< Flywheel rocks >
==============
\
\
^__^
(oo)\_______
(__)\ )\/\
||----w |
|| ||
```
## Usage
### Description
This gear takes an input text file and
print out the message in the text file along
with selected animal type in the gear log.
#### File Specifications
##### text-file
A text file that contains message that user wish to be printed on the gear log
### Workflow
A picture and description of the workflow
```mermaid
graph LR;
A[Input-File]:::input --> C;
C[Upload] --> D[Acquisition container];
D:::container --> E((Gear));
E:::gear --> F[Gear Log]:::container;
classDef container fill:#57d,color:#fff
classDef input fill:#7a9,color:#fff
classDef gear fill:#659,color:#fff
```
Description of workflow
1. Upload file to an Acquisition container
1. Select file as input to cow-says gear
1. View the outputs of the gear in Gear Log
## Contributing
[For more information about how to get started contributing to that gear,
checkout [CONTRIBUTING.md](CONTRIBUTING.md).]
<!-- markdownlint-disable-file -->
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/flywheel-io/flywheel-apps/templates/poetry-cow-says",
"name": "fw-gear-cow-says",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "Flywheel, Gears, Example",
"author": "Flywheel",
"author_email": "support@flywheel.io",
"download_url": null,
"platform": null,
"description": "# Cow-says Gear (cow-says) \n\n## Overview\n\n### Summary \n\nThe CowSays gear is an demo utility gear that makes animals speak. It uses as an example to illustrate how our skeleton\ngear template (available at https://gitlab.com/flywheel-io/scientific-solutions/gears/templates/skeleton) can be used.\n\n### Cite \n\n*License:* MIT\n\n### Classification\n\n*Category:* converter\n\n*Gear Level:*\n\n- [ ] Project\n- [ ] Subject\n- [ ] Session\n- [X] Acquisition\n- [ ] Analysis\n\n----\n\n[[_TOC_]]\n\n----\n### Inputs\n\n- *text-input*\n - __Name__: text-file\n - __Type__: file\n - __Optional__: False\n - __Description__: Text file for the animal.\n\n### Config\n\n- *debug*\n - __Name__: debug\n - __Type__: boolean\n - __Description__: Log debug messages\n - __Default__: False\n\n- *animal*\n - __Name__: animal\n - __Type__: string\n - __Description__: Type of animal\n - __Default__: cow\n\n### Outputs\n\nThis gear will generate an image of the selected\nanimal along with the message from the input text file.\n\n<!-- markdownlint-disable-file MD040 -->\n```\n ______________\n< Flywheel rocks >\n ==============\n \\\n \\\n ^__^ \n (oo)\\_______ \n (__)\\ )\\/\\ \n ||----w | \n || || \n```\n\n## Usage\n\n### Description\n\nThis gear takes an input text file and\nprint out the message in the text file along\nwith selected animal type in the gear log.\n\n#### File Specifications\n\n##### text-file\n\nA text file that contains message that user wish to be printed on the gear log\n\n### Workflow\n\nA picture and description of the workflow\n\n```mermaid\ngraph LR;\n A[Input-File]:::input --> C;\n C[Upload] --> D[Acquisition container];\n D:::container --> E((Gear));\n E:::gear --> F[Gear Log]:::container;\n \n classDef container fill:#57d,color:#fff\n classDef input fill:#7a9,color:#fff\n classDef gear fill:#659,color:#fff\n\n```\n\nDescription of workflow\n\n1. Upload file to an Acquisition container\n1. Select file as input to cow-says gear\n1. View the outputs of the gear in Gear Log\n\n## Contributing\n\n[For more information about how to get started contributing to that gear,\ncheckout [CONTRIBUTING.md](CONTRIBUTING.md).]\n<!-- markdownlint-disable-file -->",
"bugtrack_url": null,
"license": "MIT",
"summary": "A gear that makes animal speak",
"version": "2.3.4",
"project_urls": {
"Homepage": "https://gitlab.com/flywheel-io/flywheel-apps/templates/poetry-cow-says",
"Repository": "https://gitlab.com/flywheel-io/flywheel-apps/templates/poetry-cow-says"
},
"split_keywords": [
"flywheel",
" gears",
" example"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a716c8bab6d807035c53c31fa25c4be0ad9b43edb02b6d16cf526439f925df5",
"md5": "7f7d678eb6c2e5c3530ad7cb12bf4477",
"sha256": "cabb3f5b6c85c406f61a6eaa4a0618b57a86a87ff4077e7cb27edabd1e6090ec"
},
"downloads": -1,
"filename": "fw_gear_cow_says-2.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f7d678eb6c2e5c3530ad7cb12bf4477",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 3988,
"upload_time": "2024-08-23T23:19:08",
"upload_time_iso_8601": "2024-08-23T23:19:08.172814Z",
"url": "https://files.pythonhosted.org/packages/6a/71/6c8bab6d807035c53c31fa25c4be0ad9b43edb02b6d16cf526439f925df5/fw_gear_cow_says-2.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 23:19:08",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "flywheel-io",
"gitlab_project": "flywheel-apps",
"lcname": "fw-gear-cow-says"
}
JSON