| Name | commandkit JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | simple library to implement commands, events dispatchers |
| upload_time | 2024-12-25 11:35:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | Copyright 2022 'programminglaboratorys' 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. and the names are copyrighted |
| keywords |
commands
python3
commandkit
events
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# commandkit
easy tool to parse string to commands, easy tool to create commandlines
# installation
Run the following to install:
```cmd
pip install commandkit
```
### or
```cmd
python -m pip install commandkit
```
if that didn't work, try replacing `pip` with `pip3`.
need help? or have bugs to report, let me know in [here](https://discord.gg/vzEZnC7CM8)
## simple example
```python
from commandkit import CommandLine
cmder = CommandLine()
@cmder.command(name="foo")
def foo(cmd, num):
# do stuff with the cmd and num
...
@cmder.command(description="Calculate f(num) = num * 5")
def bar(num: int):
return num*5
cmder.process_command("foo kick 10")
print(cmder.process_command("bar 10")) # output: 50
```
# Documentation
you can check commandkit docs [here](https://commandkit.readthedocs.io/en/latest/)
Raw data
{
"_id": null,
"home_page": null,
"name": "commandkit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "commands, python3, commandkit, events",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a9/00/635d44bd33398fe11ebee93b0d54d430c0ff0b1993a25b369beb1afeffd5/commandkit-0.2.0.tar.gz",
"platform": null,
"description": "# commandkit\r\n\r\neasy tool to parse string to commands, easy tool to create commandlines\r\n\r\n# installation\r\n\r\nRun the following to install:\r\n\r\n```cmd\r\npip install commandkit\r\n```\r\n\r\n### or\r\n\r\n```cmd\r\npython -m pip install commandkit\r\n```\r\n\r\nif that didn't work, try replacing `pip` with `pip3`.\r\n\r\nneed help? or have bugs to report, let me know in [here](https://discord.gg/vzEZnC7CM8)\r\n\r\n## simple example\r\n\r\n```python\r\nfrom commandkit import CommandLine\r\ncmder = CommandLine()\r\n\r\n@cmder.command(name=\"foo\")\r\ndef foo(cmd, num):\r\n # do stuff with the cmd and num\r\n ...\r\n\r\n@cmder.command(description=\"Calculate f(num) = num * 5\")\r\ndef bar(num: int):\r\n return num*5\r\n\r\ncmder.process_command(\"foo kick 10\")\r\nprint(cmder.process_command(\"bar 10\")) # output: 50\r\n```\r\n\r\n# Documentation\r\n\r\nyou can check commandkit docs [here](https://commandkit.readthedocs.io/en/latest/)\r\n",
"bugtrack_url": null,
"license": "Copyright 2022 'programminglaboratorys' 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. and the names are copyrighted ",
"summary": "simple library to implement commands, events dispatchers",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/programminglaboratorys/commandkit/blob/main/CHANGELOG",
"Documentation": "https://commandkit.readthedocs.io/en/latest/",
"Homepage": "https://github.com/programminglaboratorys/commandkit",
"Issues": "https://github.com/programminglaboratorys/commandkit/issues"
},
"split_keywords": [
"commands",
" python3",
" commandkit",
" events"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ff6e4638519b0757b1adeeb68d10af9311825113d4d08a998213a588f501306",
"md5": "15385a8c28b2148f392aec564553218d",
"sha256": "cf25275af1cca0bc6841e61b30cac4a147e8c077b2915051917fb722a80aaa87"
},
"downloads": -1,
"filename": "commandkit-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15385a8c28b2148f392aec564553218d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10926,
"upload_time": "2024-12-25T11:35:12",
"upload_time_iso_8601": "2024-12-25T11:35:12.126247Z",
"url": "https://files.pythonhosted.org/packages/3f/f6/e4638519b0757b1adeeb68d10af9311825113d4d08a998213a588f501306/commandkit-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a900635d44bd33398fe11ebee93b0d54d430c0ff0b1993a25b369beb1afeffd5",
"md5": "6438f812ace82e08c6b8f2f043e1931e",
"sha256": "3a012558a0f0082b26aa87aa90d9acfa3b4841f9aed0e9df618c28462790ab79"
},
"downloads": -1,
"filename": "commandkit-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6438f812ace82e08c6b8f2f043e1931e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10011,
"upload_time": "2024-12-25T11:35:14",
"upload_time_iso_8601": "2024-12-25T11:35:14.725585Z",
"url": "https://files.pythonhosted.org/packages/a9/00/635d44bd33398fe11ebee93b0d54d430c0ff0b1993a25b369beb1afeffd5/commandkit-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 11:35:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "programminglaboratorys",
"github_project": "commandkit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "commandkit"
}
