# SystemInfo Package
This Python package provides a simple and easy-to-use way to gather system information, including details about the operating system, CPU, GPU (if available), and disk usage. The package uses popular Python libraries such as `platform`, `psutil`, `socket`, `cpuinfo`, and `GPUtil` to retrieve and present the system data.
## Installation
```bash
pip install systeminfo-python3
```
## Usage
To use the package, you can follow these steps:
1. Import the `SystemInfo` class from the package:
```python
from Systeminfo.system_Info import SystemInfo
```
2. Create an instance of the `SystemInfo` class:
```python
system_info = SystemInfo()
```
3. Get all the information using the `get_all_info()` method:
```python
all_info = system_info.get_all_info()
```
4. Print the system information:
```python
print("===== System Information =====")
for key, value in all_info["System Information"].items():
print(f"{key}: {value}")
```
5. Print the CPU information:
```python
print("\n===== CPU Information =====")
for key, value in all_info["CPU Information"].items():
print(f"{key}: {value}")
```
6. Print the GPU information if available:
```python
if "GPU Information" in all_info:
print("\n===== GPU Information =====")
for gpu_info in all_info["GPU Information"]:
for key, value in gpu_info.items():
print(f"{key}: {value}")
```
7. Print the disk information:
```python
print("\n===== Disk Information =====")
for disk_info in all_info["Disk Information"]:
for key, value in disk_info.items():
print(f"{key}: {value}")
print("-------")
```
### Example
Here's an example of how to use the package to retrieve and print system information:
```python
from Systeminfo.system_Info import SystemInfo
# Create an instance of the SystemInfo class
system_info = SystemInfo()
# Get all the information using the SystemInfo class
all_info = system_info.get_all_info()
# Print the system information
print("===== System Information =====")
for key, value in all_info["System Information"].items():
print(f"{key}: {value}")
# Print the CPU information
print("\n===== CPU Information =====")
for key, value in all_info["CPU Information"].items():
print(f"{key}: {value}")
# Print the GPU information if available
if "GPU Information" in all_info:
print("\n===== GPU Information =====")
for gpu_info in all_info["GPU Information"]:
for key, value in gpu_info.items():
print(f"{key}: {value}")
# Print the disk information
print("\n===== Disk Information =====")
for disk_info in all_info["Disk Information"]:
for key, value in disk_info.items():
print(f"{key}: {value}")
print("-------")
```
## Dependencies
The package relies on the following external Python libraries:
- `platform`: Provides access to the underlying platform's identifying data.
- `psutil`: Offers system and process-related information.
- `socket`: Provides access to network communication capabilities.
- `cpuinfo`: Provides information about the CPU (Central Processing Unit).
- `GPUtil`: Allows retrieving GPU (Graphics Processing Unit) information (optional).
## Compatibility
The package is compatible with Python 3.9 and above.
## License
This package is released under the [MIT License](LICENSE). You are free to use, modify, and distribute it as per the terms of the license.
Raw data
{
"_id": null,
"home_page": "https://github.com/jasserabdou/SystemInfo-Python3-Package",
"name": "systeminfo-python3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,systeminfo",
"author": "Jasser Abdelfattah",
"author_email": "jasserabdelfattah12@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/47/23661db6122ff8d1086ad8d3544748c53d626764fb3a6c1a937cfc20576b/systeminfo-python3-0.1.1.tar.gz",
"platform": null,
"description": "# SystemInfo Package\r\n\r\nThis Python package provides a simple and easy-to-use way to gather system information, including details about the operating system, CPU, GPU (if available), and disk usage. The package uses popular Python libraries such as `platform`, `psutil`, `socket`, `cpuinfo`, and `GPUtil` to retrieve and present the system data.\r\n\r\n## Installation\r\n```bash\r\npip install systeminfo-python3\r\n```\r\n\r\n## Usage\r\n\r\nTo use the package, you can follow these steps:\r\n\r\n1. Import the `SystemInfo` class from the package:\r\n\r\n```python\r\nfrom Systeminfo.system_Info import SystemInfo\r\n```\r\n\r\n2. Create an instance of the `SystemInfo` class:\r\n\r\n```python\r\nsystem_info = SystemInfo()\r\n```\r\n\r\n3. Get all the information using the `get_all_info()` method:\r\n\r\n```python\r\nall_info = system_info.get_all_info()\r\n```\r\n\r\n4. Print the system information:\r\n\r\n```python\r\nprint(\"===== System Information =====\")\r\nfor key, value in all_info[\"System Information\"].items():\r\n print(f\"{key}: {value}\")\r\n```\r\n\r\n5. Print the CPU information:\r\n\r\n```python\r\nprint(\"\\n===== CPU Information =====\")\r\nfor key, value in all_info[\"CPU Information\"].items():\r\n print(f\"{key}: {value}\")\r\n```\r\n\r\n6. Print the GPU information if available:\r\n\r\n```python\r\nif \"GPU Information\" in all_info:\r\n print(\"\\n===== GPU Information =====\")\r\n for gpu_info in all_info[\"GPU Information\"]:\r\n for key, value in gpu_info.items():\r\n print(f\"{key}: {value}\")\r\n```\r\n\r\n7. Print the disk information:\r\n\r\n```python\r\nprint(\"\\n===== Disk Information =====\")\r\nfor disk_info in all_info[\"Disk Information\"]:\r\n for key, value in disk_info.items():\r\n print(f\"{key}: {value}\")\r\n print(\"-------\")\r\n```\r\n\r\n### Example\r\n\r\nHere's an example of how to use the package to retrieve and print system information:\r\n\r\n```python\r\nfrom Systeminfo.system_Info import SystemInfo\r\n\r\n# Create an instance of the SystemInfo class\r\nsystem_info = SystemInfo()\r\n\r\n# Get all the information using the SystemInfo class\r\nall_info = system_info.get_all_info()\r\n\r\n# Print the system information\r\nprint(\"===== System Information =====\")\r\nfor key, value in all_info[\"System Information\"].items():\r\n print(f\"{key}: {value}\")\r\n\r\n# Print the CPU information\r\nprint(\"\\n===== CPU Information =====\")\r\nfor key, value in all_info[\"CPU Information\"].items():\r\n print(f\"{key}: {value}\")\r\n\r\n# Print the GPU information if available\r\nif \"GPU Information\" in all_info:\r\n print(\"\\n===== GPU Information =====\")\r\n for gpu_info in all_info[\"GPU Information\"]:\r\n for key, value in gpu_info.items():\r\n print(f\"{key}: {value}\")\r\n\r\n# Print the disk information\r\nprint(\"\\n===== Disk Information =====\")\r\nfor disk_info in all_info[\"Disk Information\"]:\r\n for key, value in disk_info.items():\r\n print(f\"{key}: {value}\")\r\n print(\"-------\")\r\n```\r\n\r\n## Dependencies\r\n\r\nThe package relies on the following external Python libraries:\r\n\r\n- `platform`: Provides access to the underlying platform's identifying data.\r\n- `psutil`: Offers system and process-related information.\r\n- `socket`: Provides access to network communication capabilities.\r\n- `cpuinfo`: Provides information about the CPU (Central Processing Unit).\r\n- `GPUtil`: Allows retrieving GPU (Graphics Processing Unit) information (optional).\r\n\r\n## Compatibility\r\n\r\nThe package is compatible with Python 3.9 and above.\r\n\r\n## License\r\n\r\nThis package is released under the [MIT License](LICENSE). You are free to use, modify, and distribute it as per the terms of the license.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A package that provides system information for your device.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/jasserabdou/SystemInfo-Python3-Package"
},
"split_keywords": [
"python",
"systeminfo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9035f0b20a475d614f4882f4f22383dd70146e470abf4a1d7000505bc1ffe696",
"md5": "1a4245eedec6f4dc59adad88571daf9f",
"sha256": "496fba49f9c107304b98d3229a4f767306eaab2ba2fdebc8b58db44343841c54"
},
"downloads": -1,
"filename": "systeminfo_python3-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a4245eedec6f4dc59adad88571daf9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4478,
"upload_time": "2023-08-07T05:02:48",
"upload_time_iso_8601": "2023-08-07T05:02:48.303074Z",
"url": "https://files.pythonhosted.org/packages/90/35/f0b20a475d614f4882f4f22383dd70146e470abf4a1d7000505bc1ffe696/systeminfo_python3-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "504723661db6122ff8d1086ad8d3544748c53d626764fb3a6c1a937cfc20576b",
"md5": "44b467d017f08c56240e95b48256ba89",
"sha256": "458b8618def1616d5f45b59985bd77b331e394962b07f92f503f6ad1acdb069e"
},
"downloads": -1,
"filename": "systeminfo-python3-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "44b467d017f08c56240e95b48256ba89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4062,
"upload_time": "2023-08-07T05:02:49",
"upload_time_iso_8601": "2023-08-07T05:02:49.994643Z",
"url": "https://files.pythonhosted.org/packages/50/47/23661db6122ff8d1086ad8d3544748c53d626764fb3a6c1a937cfc20576b/systeminfo-python3-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-07 05:02:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jasserabdou",
"github_project": "SystemInfo-Python3-Package",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "systeminfo-python3"
}
JSON
