# **Flow Input Library (FlowInput)**
The library is distributed under the MIT license and can be downloaded and used by anyone.
----------
## How to install
To install, you can download use pip: `pip install FlowInput`
Or download library from the repository from [GitHub](https://github.com/FunsyCode/FlowInput.git)
----------
## Using
----------
### Input
The arguments of main functions are:
#### input():
>prompt: str, default: str, color: Color or BgColor
- **prompt:** `A String, representing a default message before the input.`
- **default:** `A String, representing a default message in the input`
- **color:** `A Color or BgColor Varible, representing Red, Green and Blue colors in the input`
----------
### Colors
The main classes are:
#### Color
**Color:** `A Class width many Str Variables, width ANSI codes of colors`
#### BgColor
**BgColor:** `A Class width many Str Variables, width ANSI codes of background colors`
----------
The arguments of main function are:
#### coloring():
>key: dict, string: str
- **key:** `A Dict Variable, in which the key is the word that needs to be colored, and the value is the color. Key of dict, have built-in words like this: __start__, __end__, __mid__, __all__. You can see their in examples`
- **string** `A Str Variable, which is the text to be colored`
----------
## Some examples
**Input**
import FlowInput
FlowInput.input('What's your name? ', 'My name is Funsy!')
----------
**Color**
from FlowInput import colors
print(colors.coloring({'from': colors.Color.BLUE}, 'Hello from FlowInput!'))
print(colors.coloring({'__start__': colors.BgColor.RED}, 'Hello from FlowInput!'))
----------
**Input & Color**
import FlowInput
FlowInput.input('What’s your name? ', 'Funsy', FlowInput.colors.Color.BLUE)
Raw data
{
"_id": null,
"home_page": "https://github.com/FunsyCode/FlowInput",
"name": "FlowInput",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "input flowinput",
"author": "Funsy",
"author_email": "abramovicegor842@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/45/16/05e663b48daaa537dd89c4822720eba2e8b3ac696052d1dd8e6100de9c5f/flowinput-1.0.24.tar.gz",
"platform": null,
"description": "# **Flow Input Library (FlowInput)**\r\n\r\nThe library is distributed under the MIT license and can be downloaded and used by anyone.\r\n\r\n----------\r\n\r\n\r\n## How to install\r\nTo install, you can download use pip: `pip install FlowInput`\r\n\r\nOr download library from the repository from [GitHub](https://github.com/FunsyCode/FlowInput.git)\r\n\r\n----------\r\n\r\n## Using\r\n\r\n----------\r\n\r\n### Input\r\nThe arguments of main functions are:\r\n\r\n#### input():\r\n>prompt: str, default: str, color: Color or BgColor\r\n\r\n- **prompt:** `A String, representing a default message before the input.`\r\n- **default:** `A String, representing a default message in the input`\r\n- **color:** `A Color or BgColor Varible, representing Red, Green and Blue colors in the input`\r\n\r\n----------\r\n### Colors\r\n\r\nThe main classes are:\r\n\r\n#### Color\r\n**Color:** `A Class width many Str Variables, width ANSI codes of colors`\r\n\r\n#### BgColor\r\n**BgColor:** `A Class width many Str Variables, width ANSI codes of background colors`\r\n\r\n----------\r\n\r\nThe arguments of main function are:\r\n\r\n#### coloring():\r\n>key: dict, string: str\r\n\r\n- **key:** `A Dict Variable, in which the key is the word that needs to be colored, and the value is the color. Key of dict, have built-in words like this: __start__, __end__, __mid__, __all__. You can see their in examples`\r\n- **string** `A Str Variable, which is the text to be colored`\r\n\r\n----------\r\n\r\n## Some examples\r\n\r\n**Input**\r\n \r\n import FlowInput\r\n\r\n FlowInput.input('What's your name? ', 'My name is Funsy!')\r\n\r\n----------\r\n \r\n**Color**\r\n \r\n from FlowInput import colors\r\n \r\n print(colors.coloring({'from': colors.Color.BLUE}, 'Hello from FlowInput!'))\r\n \r\n print(colors.coloring({'__start__': colors.BgColor.RED}, 'Hello from FlowInput!'))\r\n\r\n\r\n----------\r\n\r\n**Input & Color**\r\n \r\n import FlowInput\r\n \r\n FlowInput.input('What\u2019s your name? ', 'Funsy', FlowInput.colors.Color.BLUE)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "This is the simplest module for improved work with input.",
"version": "1.0.24",
"project_urls": {
"GitHub": "https://github.com/FunsyCode/FlowInput",
"Homepage": "https://github.com/FunsyCode/FlowInput"
},
"split_keywords": [
"input",
"flowinput"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3574016dd00d0ed152cd70409e0d9962d10ba89135e54b28c079c8cd88e58c5e",
"md5": "5a13f904754ecf80aed2d681ebe50750",
"sha256": "bba422617af5511ddc854fc8ab8b07ed3b7d85fc1b1059a1ee734364f6d09427"
},
"downloads": -1,
"filename": "FlowInput-1.0.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a13f904754ecf80aed2d681ebe50750",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5095,
"upload_time": "2024-12-04T17:45:45",
"upload_time_iso_8601": "2024-12-04T17:45:45.402562Z",
"url": "https://files.pythonhosted.org/packages/35/74/016dd00d0ed152cd70409e0d9962d10ba89135e54b28c079c8cd88e58c5e/FlowInput-1.0.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "451605e663b48daaa537dd89c4822720eba2e8b3ac696052d1dd8e6100de9c5f",
"md5": "3ffac8ced2dc840af6cf152e1f20b8e5",
"sha256": "6d0f044d49ab908e9bf67fa5bc19155334bb4edfefdbd7e45adf0534590f2c81"
},
"downloads": -1,
"filename": "flowinput-1.0.24.tar.gz",
"has_sig": false,
"md5_digest": "3ffac8ced2dc840af6cf152e1f20b8e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 4071,
"upload_time": "2024-12-04T17:45:46",
"upload_time_iso_8601": "2024-12-04T17:45:46.963968Z",
"url": "https://files.pythonhosted.org/packages/45/16/05e663b48daaa537dd89c4822720eba2e8b3ac696052d1dd8e6100de9c5f/flowinput-1.0.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 17:45:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FunsyCode",
"github_project": "FlowInput",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flowinput"
}
JSON
