<p align="center">
<img src="https://raw.githubusercontent.com/Botnikkk/botnikkk-package/main/images/logo.jpg"/>
</p>
# botnikkk
Under construction! Not ready for use yet! Currently experimenting and planning!
Developed by BotNikkk / Nikkk
# How To Use :
## 1. centre() function
Usage = Centering Elemtents.
```python
import botnikkk
botnikkk.centre('text')
```
It also takes 3 extra parameters as input :
1. symbol : determines what symbol will fill in the blank space, deault parameter = " "
```python
botnikkk.centre('text',symbol='=')
```
2. left_alignment : determines the space that will be used on the left hand side of the centred string, defaul parameter = None/calculated automatically
```python
botnikkk.centre('text', left_alignment=23)
```
3. str_end : determines what symbol will print as end= in print statement, deault parameter = "\n"
```python
botnikkk.centre('text',str_end='end')
```
#### OUTPUT EXAMPLE :
<p align="center">
<img src="https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_centre.png?raw=true"/>
</p>
## 2. format_input() function
Usage = centering the input variable.
```python
import botnikkk
answer = botnikkk.format_input('input_question')
```
#### OUTPUT EXAMPLE :
<p align="center">
<img src="https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_input.png?raw=true"/>
</p>
## 3. int_check() function
Usage = checks if an input variable is a interger or not, takes repetetive inputs if not Interger.
```python
import botnikkk
answer = botnikkk.int_check('any_variable')
```
#### OUTPUT EXAMPLE :
<p align="center">
<img src="https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_int.png?raw=true"/>
</p>
## 4. ans_check() function
Usage = takes a list of strings as input and displays it to the user as centred options, returns the choosen option.
```python
import botnikkk
answer = botnikkk.ans_check(['list_of_variables'])
```
#### OUTPUT EXAMPLE :
<p align="center">
<img src="https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_ans.png?raw=true"/>
</p>
## 5. get_alignments() function
Usage = takes a string as input and returns a dictionary containing the designing alignments of the said string in the form :
```python
dic= {"left_align":value , "left_gap":value, "right_gap":value, "default_gap":value }
```
which can be used to format a string accoring to the alignment format of package in such form :
```python
print_string= left_align*" " + "|" + left_gap*" " + string + right_gap*" " + "|"
```
```python
import botnikkk
alignments = botnikkk.get_alignments("string")
```
#### OUTPUT EXAMPLE :
<p align="center">
<img src="https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_alignment.png?raw=true"/>
</p>
## 6. redirect() function
Usage = takes a input string as screen name and redirects the user to the said screen in a countdown of 3 seconds. Can only be used in async functions due it's await nature.
```python
import botnikkk
import asyncio
async def function():
#some code
await botnikkk.redirect("screen_name")
#some more code
asyncio.run(function())
```
check out : https://botnikkk.github.io and https://github.com/Botnikkk/botnikkk-package
Raw data
{
"_id": null,
"home_page": null,
"name": "botnikkk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, camera stream, sockets",
"author": "BotNikkk",
"author_email": "<nikhi.ace.chd@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/69/6bc757647850c68ad8d3da9f20aba53902429f0c9f8eb3f893aa40f6a8e2/botnikkk-0.1.3.tar.gz",
"platform": null,
"description": "\r\n<p align=\"center\">\r\n\r\n <img src=\"https://raw.githubusercontent.com/Botnikkk/botnikkk-package/main/images/logo.jpg\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n# botnikkk \r\n\r\n\r\n\r\nUnder construction! Not ready for use yet! Currently experimenting and planning!\r\n\r\n\r\n\r\nDeveloped by BotNikkk / Nikkk\r\n\r\n\r\n\r\n# How To Use :\r\n\r\n\r\n\r\n## 1. centre() function\r\n\r\n\r\n\r\nUsage = Centering Elemtents.\r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\n\r\n\r\nbotnikkk.centre('text')\r\n\r\n```\r\n\r\n\r\n\r\nIt also takes 3 extra parameters as input :\r\n\r\n\r\n\r\n1. symbol : determines what symbol will fill in the blank space, deault parameter = \" \"\r\n\r\n\r\n\r\n```python\r\n\r\nbotnikkk.centre('text',symbol='=')\r\n\r\n```\r\n\r\n\r\n\r\n2. left_alignment : determines the space that will be used on the left hand side of the centred string, defaul parameter = None/calculated automatically\r\n\r\n\r\n\r\n```python\r\n\r\nbotnikkk.centre('text', left_alignment=23)\r\n\r\n```\r\n\r\n\r\n\r\n3. str_end : determines what symbol will print as end= in print statement, deault parameter = \"\\n\"\r\n\r\n\r\n\r\n```python\r\n\r\nbotnikkk.centre('text',str_end='end')\r\n\r\n```\r\n\r\n#### OUTPUT EXAMPLE :\r\n\r\n\r\n\r\n<p align=\"center\">\r\n\r\n <img src=\"https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_centre.png?raw=true\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n## 2. format_input() function\r\n\r\n\r\n\r\nUsage = centering the input variable.\r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\n\r\n\r\nanswer = botnikkk.format_input('input_question')\r\n\r\n```\r\n\r\n\r\n\r\n#### OUTPUT EXAMPLE :\r\n\r\n<p align=\"center\">\r\n\r\n <img src=\"https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_input.png?raw=true\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n## 3. int_check() function\r\n\r\n\r\n\r\nUsage = checks if an input variable is a interger or not, takes repetetive inputs if not Interger.\r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\n\r\n\r\nanswer = botnikkk.int_check('any_variable')\r\n\r\n```\r\n\r\n\r\n\r\n#### OUTPUT EXAMPLE :\r\n\r\n<p align=\"center\">\r\n\r\n <img src=\"https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_int.png?raw=true\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n## 4. ans_check() function\r\n\r\n\r\n\r\nUsage = takes a list of strings as input and displays it to the user as centred options, returns the choosen option. \r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\n\r\n\r\nanswer = botnikkk.ans_check(['list_of_variables'])\r\n\r\n```\r\n\r\n#### OUTPUT EXAMPLE :\r\n\r\n<p align=\"center\">\r\n\r\n <img src=\"https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_ans.png?raw=true\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n## 5. get_alignments() function\r\n\r\n\r\n\r\nUsage = takes a string as input and returns a dictionary containing the designing alignments of the said string in the form :\r\n\r\n```python\r\n\r\ndic= {\"left_align\":value , \"left_gap\":value, \"right_gap\":value, \"default_gap\":value }\r\n\r\n``` \r\n\r\nwhich can be used to format a string accoring to the alignment format of package in such form :\r\n\r\n```python\r\n\r\nprint_string= left_align*\" \" + \"|\" + left_gap*\" \" + string + right_gap*\" \" + \"|\" \r\n\r\n``` \r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\n\r\n\r\nalignments = botnikkk.get_alignments(\"string\")\r\n\r\n```\r\n\r\n#### OUTPUT EXAMPLE :\r\n\r\n<p align=\"center\">\r\n\r\n <img src=\"https://github.com/Botnikkk/botnikkk-package/blob/main/images/output_alignment.png?raw=true\"/>\r\n\r\n</p>\r\n\r\n\r\n\r\n## 6. redirect() function\r\n\r\n\r\n\r\nUsage = takes a input string as screen name and redirects the user to the said screen in a countdown of 3 seconds. Can only be used in async functions due it's await nature.\r\n\r\n\r\n\r\n```python\r\n\r\nimport botnikkk\r\n\r\nimport asyncio\r\n\r\n\r\n\r\nasync def function():\r\n\r\n\r\n\r\n #some code\r\n\r\n await botnikkk.redirect(\"screen_name\")\r\n\r\n #some more code\r\n\r\n\r\n\r\nasyncio.run(function())\r\n\r\n```\r\n\r\n\r\n\r\n\r\n\r\ncheck out : https://botnikkk.github.io and https://github.com/Botnikkk/botnikkk-package\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "a personal package",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"python",
" camera stream",
" sockets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f7bfd62195b4fe53175d0337e9fa493b4747183320813b8e7e1d6af314a04c0",
"md5": "0930fafbaf48a615f60948a2cb33c352",
"sha256": "dba298c19d397ab115123e78d4462dadde703829672edfb9862052c190a42164"
},
"downloads": -1,
"filename": "botnikkk-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0930fafbaf48a615f60948a2cb33c352",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4657,
"upload_time": "2024-04-28T11:20:04",
"upload_time_iso_8601": "2024-04-28T11:20:04.494387Z",
"url": "https://files.pythonhosted.org/packages/5f/7b/fd62195b4fe53175d0337e9fa493b4747183320813b8e7e1d6af314a04c0/botnikkk-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2696bc757647850c68ad8d3da9f20aba53902429f0c9f8eb3f893aa40f6a8e2",
"md5": "104baf6b7ab25538c2cc2846eb031db1",
"sha256": "b20e1c8db3a41702d95195f506898e0c9f07d1475e192316042da36bf471bd48"
},
"downloads": -1,
"filename": "botnikkk-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "104baf6b7ab25538c2cc2846eb031db1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4679,
"upload_time": "2024-04-28T11:20:06",
"upload_time_iso_8601": "2024-04-28T11:20:06.501998Z",
"url": "https://files.pythonhosted.org/packages/f2/69/6bc757647850c68ad8d3da9f20aba53902429f0c9f8eb3f893aa40f6a8e2/botnikkk-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 11:20:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "botnikkk"
}
JSON