# Shello-world: simple Python functions to run shell commands
A few simple Python functions allow you to run shell commands from your Python code.
## Why shello-world?
It is a simple and quick solution if you don't want to use a big library or framework.
## Usage
Let's take a look at a simple example below:
```python
from shello_world import shell_execute, shell_run
# Both functions work similarly
# Use shell_run if you want to run a command
# directly in your shell, like you'd enter it
shell_run("color a") # Change font color to green
# But shell_run doesn't return anything
output = shell_run("echo 'This text is printed in the shell'")
print(output is None) # True
# Use shell_execute to get output to use it in your code
# shell_execute doesn't print anything
systeminfo = shell_execute("systeminfo")
# But it always returns result as a string
print(systeminfo.upper())
#
# HOST NAME:
# OS NAME:
# OS VERSION:
# ...
#
```
## Installation
### pip
```
pip install shello-world
```
### poetry
```
poetry add shello-world
```
## Links
[PyPI](https://pypi.org/project/shello-world/)
[GitHub](https://github.com/numericmaestro/shello-world)
Raw data
{
"_id": null,
"home_page": "https://github.com/numericmaestro/shello-world",
"name": "shello-world",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "shell",
"author": "numericmaestro",
"author_email": "re5lyltx@duck.com",
"download_url": "https://files.pythonhosted.org/packages/04/3b/cc32f52dbcefc78f0dd67b8ab3c2746245bb2e9b157419bab3b1182abe77/shello_world-0.1.5.tar.gz",
"platform": null,
"description": "\n# Shello-world: simple Python functions to run shell commands\nA few simple Python functions allow you to run shell commands from your Python code.\n\n## Why shello-world?\nIt is a simple and quick solution if you don't want to use a big library or framework.\n\n## Usage\nLet's take a look at a simple example below:\n```python\nfrom shello_world import shell_execute, shell_run\n\n# Both functions work similarly\n\n# Use shell_run if you want to run a command\n# directly in your shell, like you'd enter it\nshell_run(\"color a\") # Change font color to green\n# But shell_run doesn't return anything\noutput = shell_run(\"echo 'This text is printed in the shell'\")\nprint(output is None) # True\n\n# Use shell_execute to get output to use it in your code\n# shell_execute doesn't print anything\nsysteminfo = shell_execute(\"systeminfo\")\n# But it always returns result as a string\nprint(systeminfo.upper())\n#\n# HOST NAME:\n# OS NAME:\n# OS VERSION:\n# ...\n#\n```\n\n## Installation\n### pip\n```\npip install shello-world\n```\n### poetry\n```\npoetry add shello-world\n```\n\n## Links\n[PyPI](https://pypi.org/project/shello-world/) \n[GitHub](https://github.com/numericmaestro/shello-world)",
"bugtrack_url": null,
"license": "0BSD",
"summary": "A few simple Python functions allow you to run shell commands from your Python code",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/numericmaestro/shello-world",
"Repository": "https://github.com/numericmaestro/shello-world"
},
"split_keywords": [
"shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "388a12c0dc632885e1a20c8dd7c255754b28c7721c2f4650d9b1a46fd5c7e870",
"md5": "e7d0325d011e6778357f257e61a181b9",
"sha256": "2a6e068e838b67c27c10a2709c04e3c8c9fd06e538ab527c43f48f4c955cc035"
},
"downloads": -1,
"filename": "shello_world-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7d0325d011e6778357f257e61a181b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 3621,
"upload_time": "2023-05-08T20:51:15",
"upload_time_iso_8601": "2023-05-08T20:51:15.449445Z",
"url": "https://files.pythonhosted.org/packages/38/8a/12c0dc632885e1a20c8dd7c255754b28c7721c2f4650d9b1a46fd5c7e870/shello_world-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "043bcc32f52dbcefc78f0dd67b8ab3c2746245bb2e9b157419bab3b1182abe77",
"md5": "c7962c53c37084e7f3cad8e3d3ded0d2",
"sha256": "6b21a622647a329d4848d9189202aa10964ec1765f150c10e7f18e9d2df64118"
},
"downloads": -1,
"filename": "shello_world-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "c7962c53c37084e7f3cad8e3d3ded0d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 2541,
"upload_time": "2023-05-08T20:51:17",
"upload_time_iso_8601": "2023-05-08T20:51:17.568871Z",
"url": "https://files.pythonhosted.org/packages/04/3b/cc32f52dbcefc78f0dd67b8ab3c2746245bb2e9b157419bab3b1182abe77/shello_world-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-08 20:51:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "numericmaestro",
"github_project": "shello-world",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "shello-world"
}
JSON
