# Show System Information
[![Test](https://github.com/NatLee/show-system-info/actions/workflows/test.yml/badge.svg)](https://github.com/NatLee/show-system-info/actions/workflows/test.yml)
[![Release](https://github.com/NatLee/show-system-info/actions/workflows/release.yml/badge.svg)](https://github.com/NatLee/show-system-info/actions/workflows/release.yml)
Show System Information is a Python package that provides a simple way to display system information. It is designed to be easy to use and easy to understand. It is also easy to extend and customize.
## Installation
```bash
pip install showsys
```
Visit [ShowSys on PyPI](https://pypi.org/project/ShowSys/) for more details.
## Usage
### As a Library
You can use ShowSys as a library in your Python code. Here is an example.
```python
from showsys import ShowSys
sysinfo = ShowSys()
sysinfo.info()
```
There are several methods available to display system information. You can use them to display different types of system information.
- system_information
- boot_time
- cpu_info
- memory_info
- swap_info
- network_info
Just call the method you want to use. For example, you can use the following code to display CPU information.
```python
from showsys import ShowSys
sysinfo = ShowSys()
print(sysinfo.cpu_info())
```
It will display the following information.
```python
{
'Physical cores': 12,
'Total cores': 20,
'Max Frequency': '2100.00Mhz',
'Min Frequency': '0.00Mhz',
'Current Frequency': '2100.00Mhz',
'CPU Usage Per Core': ['0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '1.6%', '0.0%', '0.0%', '0.0%', '15.4%', '3.1%', '0.0%', '1.6%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%'],
'Total CPU Usage': '1.6%'
}
```
### Command Line Interface
ShowSys also provides a command line interface. You can use it to display system information from the command line.
```bash
showsys -d # Display system information details
```
Other options are available. You can use the following command to see all available options.
```bash
showsys -h # Show help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/natlee/show-system-info",
"name": "ShowSys",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "system,information,spec,hardware,software,os,platform,cpu,memory,disk,network,cli,command,line,interface,tool,utility",
"author": "Nat Lee",
"author_email": "natlee.work@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/80/8d/813da943eac4356c601a5eff2a879f3c73399adbe9472e5083f9bc1b6dcc/ShowSys-1.0.1.tar.gz",
"platform": null,
"description": "# Show System Information\n\n[![Test](https://github.com/NatLee/show-system-info/actions/workflows/test.yml/badge.svg)](https://github.com/NatLee/show-system-info/actions/workflows/test.yml)\n[![Release](https://github.com/NatLee/show-system-info/actions/workflows/release.yml/badge.svg)](https://github.com/NatLee/show-system-info/actions/workflows/release.yml)\n\nShow System Information is a Python package that provides a simple way to display system information. It is designed to be easy to use and easy to understand. It is also easy to extend and customize.\n\n## Installation\n\n```bash\npip install showsys\n```\n\nVisit [ShowSys on PyPI](https://pypi.org/project/ShowSys/) for more details.\n\n## Usage\n\n### As a Library\n\nYou can use ShowSys as a library in your Python code. Here is an example.\n\n```python\nfrom showsys import ShowSys\nsysinfo = ShowSys()\nsysinfo.info()\n```\n\nThere are several methods available to display system information. You can use them to display different types of system information.\n\n- system_information\n- boot_time\n- cpu_info\n- memory_info\n- swap_info\n- network_info\n\nJust call the method you want to use. For example, you can use the following code to display CPU information.\n\n```python\nfrom showsys import ShowSys\nsysinfo = ShowSys()\nprint(sysinfo.cpu_info())\n```\n\nIt will display the following information.\n\n```python\n{\n 'Physical cores': 12,\n 'Total cores': 20,\n 'Max Frequency': '2100.00Mhz',\n 'Min Frequency': '0.00Mhz',\n 'Current Frequency': '2100.00Mhz',\n 'CPU Usage Per Core': ['0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '1.6%', '0.0%', '0.0%', '0.0%', '15.4%', '3.1%', '0.0%', '1.6%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%', '0.0%'],\n 'Total CPU Usage': '1.6%'\n}\n```\n\n\n### Command Line Interface\n\nShowSys also provides a command line interface. You can use it to display system information from the command line.\n\n```bash\nshowsys -d # Display system information details\n```\n\nOther options are available. You can use the following command to see all available options.\n\n```bash\nshowsys -h # Show help\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple package to get system spec information",
"version": "1.0.1",
"project_urls": {
"Bug Reports": "https://github.com/natlee/show-system-info/issues",
"Documentation": "https://github.com/natlee/show-system-info",
"Homepage": "https://github.com/natlee/show-system-info",
"Source Code": "https://github.com/natlee/show-system-info"
},
"split_keywords": [
"system",
"information",
"spec",
"hardware",
"software",
"os",
"platform",
"cpu",
"memory",
"disk",
"network",
"cli",
"command",
"line",
"interface",
"tool",
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b76beac91d8c71e9e4a789b9107df84b02f64a34d21f70f76839dc16e98838d2",
"md5": "d3d03e127c8d7342788b1578f0898114",
"sha256": "cefce5786426d4cfd897a469d17903a99a28654a8185af34479896133635fb1f"
},
"downloads": -1,
"filename": "ShowSys-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3d03e127c8d7342788b1578f0898114",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6044,
"upload_time": "2024-02-03T21:50:21",
"upload_time_iso_8601": "2024-02-03T21:50:21.114231Z",
"url": "https://files.pythonhosted.org/packages/b7/6b/eac91d8c71e9e4a789b9107df84b02f64a34d21f70f76839dc16e98838d2/ShowSys-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "808d813da943eac4356c601a5eff2a879f3c73399adbe9472e5083f9bc1b6dcc",
"md5": "c79cd0037ff98af18559d64275072744",
"sha256": "52872a0c751834ee51265237acdaaa6ead02d5832a57b8b02d74e5ac2bd3a4a5"
},
"downloads": -1,
"filename": "ShowSys-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c79cd0037ff98af18559d64275072744",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6109,
"upload_time": "2024-02-03T21:50:24",
"upload_time_iso_8601": "2024-02-03T21:50:24.591976Z",
"url": "https://files.pythonhosted.org/packages/80/8d/813da943eac4356c601a5eff2a879f3c73399adbe9472e5083f9bc1b6dcc/ShowSys-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 21:50:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "natlee",
"github_project": "show-system-info",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "showsys"
}