Metadata-Version: 2.1
Name: ShowSys
Version: 1.0.1
Summary: A simple package to get system spec information
Home-page: https://github.com/natlee/show-system-info
Author: Nat Lee
Author-email: natlee.work@gmail.com
Project-URL: Documentation, https://github.com/natlee/show-system-info
Project-URL: Bug Reports, https://github.com/natlee/show-system-info/issues
Project-URL: Source Code, https://github.com/natlee/show-system-info
Keywords: system,information,spec,hardware,software,os,platform,cpu,memory,disk,network,cli,command,line,interface,tool,utility
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil
Requires-Dist: py-cpuinfo
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'

# 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
```

