| Name | PhyDisk JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Python module to get physical drives connected to a host machine |
| upload_time | 2025-01-01 02:53:59 |
| 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
phydisk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PhyDisk (Physical Disk)
PhyDisk is an ultra lightweight python module to get all physical disks connected to a host machine.
![Python][label-pyversion]
![Platform][label-platform]
[![pypi][label-actions-pypi]][gha_pypi]
[![Pypi][label-pypi]][pypi]
[![Pypi-format][label-pypi-format]][pypi-files]
[![Pypi-status][label-pypi-status]][pypi]
## Installation
```shell
pip install PhyDisk
```
## Usage
**Initiate - IDE**
```python
import phydisk
if __name__ == '__main__':
all_disks = phydisk.get_all_disks()
print(all_disks)
```
**Initiate - CLI**
```shell
phydisk print
```
> Use `phydisk --help` for usage instructions.
### Source Commands
**Linux**
```shell
/usr/bin/lsblk -o NAME,SIZE,TYPE,MODEL,MOUNTPOINT -J
```
**macOS**
```shell
/usr/sbin/diskutil info -all
```
**Windows**
```shell
C:\\Program Files\\PowerShell\\7\\pwsh.exe -Command
Get-PhysicalDisk | ForEach-Object {
$disk = $_
$partitions = Get-Partition -DiskNumber $disk.DeviceID
$partitions | ForEach-Object {
[PSCustomObject]@{
DiskNumber = $disk.DeviceID
Partition = $_.PartitionNumber
DriveLetter = (Get-Volume -Partition $_).DriveLetter
MountPoint = (Get-Volume -Partition $_).DriveLetter
}
}
}
```
## 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/PhyDisk/][pypi]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[license]: https://github.com/thevickypedia/PhyDisk/blob/master/LICENSE
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PhyDisk-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/PhyDisk/actions/workflows/python-publish.yaml/badge.svg
[label-pypi]: https://img.shields.io/pypi/v/PhyDisk
[label-pypi-format]: https://img.shields.io/pypi/format/PhyDisk
[label-pypi-status]: https://img.shields.io/pypi/status/PhyDisk
[gha_pypi]: https://github.com/thevickypedia/PhyDisk/actions/workflows/python-publish.yaml
[pypi]: https://pypi.org/project/PhyDisk
[pypi-files]: https://pypi.org/project/PhyDisk/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
Raw data
{
"_id": null,
"home_page": null,
"name": "PhyDisk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "physical-drives, PhyDisk",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# PhyDisk (Physical Disk)\nPhyDisk is an ultra lightweight python module to get all physical disks connected to a host machine.\n\n![Python][label-pyversion]\n\n![Platform][label-platform]\n\n[![pypi][label-actions-pypi]][gha_pypi]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Installation\n\n```shell\npip install PhyDisk\n```\n\n## Usage\n\n**Initiate - IDE**\n```python\nimport phydisk\n\nif __name__ == '__main__':\n all_disks = phydisk.get_all_disks()\n print(all_disks)\n```\n\n**Initiate - CLI**\n```shell\nphydisk print\n```\n\n> Use `phydisk --help` for usage instructions.\n\n### Source Commands\n\n**Linux**\n\n```shell\n/usr/bin/lsblk -o NAME,SIZE,TYPE,MODEL,MOUNTPOINT -J\n```\n\n**macOS**\n\n```shell\n/usr/sbin/diskutil info -all\n```\n\n**Windows**\n\n```shell\nC:\\\\Program Files\\\\PowerShell\\\\7\\\\pwsh.exe -Command\nGet-PhysicalDisk | ForEach-Object {\n $disk = $_\n $partitions = Get-Partition -DiskNumber $disk.DeviceID\n $partitions | ForEach-Object {\n [PSCustomObject]@{\n DiskNumber = $disk.DeviceID\n Partition = $_.PartitionNumber\n DriveLetter = (Get-Volume -Partition $_).DriveLetter\n MountPoint = (Get-Volume -Partition $_).DriveLetter\n }\n }\n}\n```\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/PhyDisk/][pypi]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[license]: https://github.com/thevickypedia/PhyDisk/blob/master/LICENSE\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PhyDisk-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/PhyDisk/actions/workflows/python-publish.yaml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/PhyDisk\n[label-pypi-format]: https://img.shields.io/pypi/format/PhyDisk\n[label-pypi-status]: https://img.shields.io/pypi/status/PhyDisk\n[gha_pypi]: https://github.com/thevickypedia/PhyDisk/actions/workflows/python-publish.yaml\n[pypi]: https://pypi.org/project/PhyDisk\n[pypi-files]: https://pypi.org/project/PhyDisk/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\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 physical drives connected to a host machine",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/thevickypedia/PhyDisk",
"Source": "https://github.com/thevickypedia/PhyDisk"
},
"split_keywords": [
"physical-drives",
" phydisk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c39786dd305e75df05a5c8e2e99c1f86e6c6a66f5d6567291a782a4fbc1b3930",
"md5": "a41a105d9c40dd5881935956706f64b0",
"sha256": "08a8833df4be3aca6763ac5e4984903f5af3ff576586465a35b79e413b05e374"
},
"downloads": -1,
"filename": "PhyDisk-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a41a105d9c40dd5881935956706f64b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10886,
"upload_time": "2025-01-01T02:53:59",
"upload_time_iso_8601": "2025-01-01T02:53:59.109894Z",
"url": "https://files.pythonhosted.org/packages/c3/97/86dd305e75df05a5c8e2e99c1f86e6c6a66f5d6567291a782a4fbc1b3930/PhyDisk-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-01 02:53:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "PhyDisk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "phydisk"
}
