Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed Jan 1, 2025
1 parent 1080a96 commit c25fd8b
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# 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
Expand All @@ -10,6 +19,7 @@ pip install PhyDisk

## Usage

**Initiate - IDE**
```python
import phydisk

Expand All @@ -18,6 +28,13 @@ if __name__ == '__main__':
print(all_disks)
```

**Initiate - CLI**
```shell
phydisk print
```

> Use `phydisk --help` for usage instructions.
### Source Commands

**Linux**
Expand Down Expand Up @@ -49,3 +66,41 @@ Get-PhysicalDisk | ForEach-Object {
}
}
```


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

0 comments on commit c25fd8b

Please sign in to comment.