| Name | PyArchitecture JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Python module to get kernel information via OS specific CLI commands |
| upload_time | 2025-01-05 20:11:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 TheVickypedia 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. |
| keywords |
physical-drives
pyarchitecture
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyArchitecture
PyArchitecture is a lightweight python module to get kernel information via OS specific CLI commands.
![Python][label-pyversion]
![Platform][label-platform]
[![pypi][label-actions-pypi]][gha_pypi]
[![functional-tests][label-func-test-pypi]][gha_func_test]
[![Pypi][label-pypi]][pypi]
[![Pypi-format][label-pypi-format]][pypi-files]
[![Pypi-status][label-pypi-status]][pypi]
## Summary
PyArchitecture is designed to retrieve hard-to-find kernel information like CPU/GPU model name, physical disks,
and memory profiles without using any external dependencies.
> Although this project does not rely on external dependencies, it does use system tools, as outlined below.
| Library / Override | Linux | Darwin (macOS) | Windows |
|--------------------------|------------------|-----------------------------|------------------------------------------|
| **CPU**<br/>`cpu_lib` | `/proc/cpuinfo` | `/usr/sbin/sysctl` | `C:\Windows\System32\wbem\wmic.exe` |
| **PCI**<br/>`gpu_lib` | `/usr/bin/lspci` | `/usr/sbin/system_profiler` | `C:\Windows\System32\wbem\wmic.exe` |
| **Memory**<br/>`mem_lib` | `/proc/meminfo` | `/usr/sbin/sysctl` | N/A |
| **Disk**<br/>`disk_lib` | `/usr/bin/lsblk` | `/usr/sbin/diskutil` | `C:\Program Files\PowerShell\7\pwsh.exe` |
## Installation
```shell
pip install PyArchitecture
```
## Usage
**Initiate - IDE**
```python
import pyarchitecture
if __name__ == '__main__':
all_disks = pyarchitecture.disks.get_all_disks()
print(all_disks)
cpu_info = pyarchitecture.cpu.get_cpu_info()
print(cpu_info)
gpu_info = pyarchitecture.gpu.get_gpu_info()
print(gpu_info)
mem_info = pyarchitecture.memory.get_memory_info()
print(mem_info)
```
**Initiate - CLI**
```shell
pyarchitecture all
```
> Use `pyarchitecture --help` for usage instructions.
## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`pre-commit` will ensure linting
**Requirement**
```shell
python -m pip install pre-commit
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[![pypi-module][label-pypi-package]][pypi-repo]
[https://pypi.org/project/PyArchitecture/][pypi]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[license]: https://github.com/thevickypedia/PyArchitecture/blob/main/LICENSE
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PyArchitecture-blue?style=for-the-badge&logo=Python
[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
[label-actions-pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/python-publish.yaml/badge.svg
[label-func-test-pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/functional-tests.yaml/badge.svg
[label-pypi]: https://img.shields.io/pypi/v/PyArchitecture
[label-pypi-format]: https://img.shields.io/pypi/format/PyArchitecture
[label-pypi-status]: https://img.shields.io/pypi/status/PyArchitecture
[gha_pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/python-publish.yaml
[gha_func_test]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/functional-tests.yaml
[pypi]: https://pypi.org/project/PyArchitecture
[pypi-files]: https://pypi.org/project/PyArchitecture/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
[release-notes]: https://github.com/thevickypedia/PyArchitecture/blob/main/release_notes.rst
Raw data
{
"_id": null,
"home_page": null,
"name": "PyArchitecture",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "physical-drives, PyArchitecture",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# PyArchitecture\nPyArchitecture is a lightweight python module to get kernel information via OS specific CLI commands.\n\n![Python][label-pyversion]\n\n![Platform][label-platform]\n\n[![pypi][label-actions-pypi]][gha_pypi]\n[![functional-tests][label-func-test-pypi]][gha_func_test]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Summary\n\nPyArchitecture is designed to retrieve hard-to-find kernel information like CPU/GPU model name, physical disks,\nand memory profiles without using any external dependencies.\n\n> Although this project does not rely on external dependencies, it does use system tools, as outlined below.\n\n| Library / Override | Linux | Darwin (macOS) | Windows |\n|--------------------------|------------------|-----------------------------|------------------------------------------|\n| **CPU**<br/>`cpu_lib` | `/proc/cpuinfo` | `/usr/sbin/sysctl` | `C:\\Windows\\System32\\wbem\\wmic.exe` |\n| **PCI**<br/>`gpu_lib` | `/usr/bin/lspci` | `/usr/sbin/system_profiler` | `C:\\Windows\\System32\\wbem\\wmic.exe` |\n| **Memory**<br/>`mem_lib` | `/proc/meminfo` | `/usr/sbin/sysctl` | N/A |\n| **Disk**<br/>`disk_lib` | `/usr/bin/lsblk` | `/usr/sbin/diskutil` | `C:\\Program Files\\PowerShell\\7\\pwsh.exe` |\n\n## Installation\n\n```shell\npip install PyArchitecture\n```\n\n## Usage\n\n**Initiate - IDE**\n```python\nimport pyarchitecture\n\nif __name__ == '__main__':\n all_disks = pyarchitecture.disks.get_all_disks()\n print(all_disks)\n cpu_info = pyarchitecture.cpu.get_cpu_info()\n print(cpu_info)\n gpu_info = pyarchitecture.gpu.get_gpu_info()\n print(gpu_info)\n mem_info = pyarchitecture.memory.get_memory_info()\n print(mem_info)\n```\n\n**Initiate - CLI**\n```shell\npyarchitecture all\n```\n\n> Use `pyarchitecture --help` for usage instructions.\n\n## [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`pre-commit` will ensure linting\n\n**Requirement**\n```shell\npython -m pip install pre-commit\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/PyArchitecture/][pypi]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[license]: https://github.com/thevickypedia/PyArchitecture/blob/main/LICENSE\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PyArchitecture-blue?style=for-the-badge&logo=Python\n[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue\n[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg\n[label-actions-pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/python-publish.yaml/badge.svg\n[label-func-test-pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/functional-tests.yaml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/PyArchitecture\n[label-pypi-format]: https://img.shields.io/pypi/format/PyArchitecture\n[label-pypi-status]: https://img.shields.io/pypi/status/PyArchitecture\n[gha_pypi]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/python-publish.yaml\n[gha_func_test]: https://github.com/thevickypedia/PyArchitecture/actions/workflows/functional-tests.yaml\n[pypi]: https://pypi.org/project/PyArchitecture\n[pypi-files]: https://pypi.org/project/PyArchitecture/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n[release-notes]: https://github.com/thevickypedia/PyArchitecture/blob/main/release_notes.rst\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 TheVickypedia 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. ",
"summary": "Python module to get kernel information via OS specific CLI commands",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/thevickypedia/PyArchitecture",
"Source": "https://github.com/thevickypedia/PyArchitecture"
},
"split_keywords": [
"physical-drives",
" pyarchitecture"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0afd65498e1dba7dbd0b01825e61db230c1e9aaa0277601f5f9d487072837637",
"md5": "a9d10cae414cdc127d1af0d852262880",
"sha256": "dec56923836b7f19a07d0f92b41db52ba6073f374d841b82bf33749f6d024a85"
},
"downloads": -1,
"filename": "PyArchitecture-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9d10cae414cdc127d1af0d852262880",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19583,
"upload_time": "2025-01-05T20:11:36",
"upload_time_iso_8601": "2025-01-05T20:11:36.210233Z",
"url": "https://files.pythonhosted.org/packages/0a/fd/65498e1dba7dbd0b01825e61db230c1e9aaa0277601f5f9d487072837637/PyArchitecture-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-05 20:11:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "PyArchitecture",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyarchitecture"
}
