diff --git a/doc_gen/index.rst b/doc_gen/index.rst index 0fc6c9f..5e3e556 100644 --- a/doc_gen/index.rst +++ b/doc_gen/index.rst @@ -65,7 +65,19 @@ CPU Disks ----- -.. automodule:: pyninja.features.disks +.. automodule:: pyninja.features.disks.__init__ + +Disks - Linux +------------- +.. automodule:: pyninja.features.disks.linux + +Disks - macOS +------------- +.. automodule:: pyninja.features.disks.macOS + +Disks - Windows +--------------- +.. automodule:: pyninja.features.disks.windows Docker ------ diff --git a/docs/README.html b/docs/README.html index 7eb3199..94aa6b2 100644 --- a/docs/README.html +++ b/docs/README.html @@ -4,7 +4,7 @@
- +OS-agnostic function to get all disks connected to the host system.
+Get disks attached to Linux devices.
Extracts size in bytes from a string.
Updates mount points for physical devices based on diskutil data.
Parses diskutil info -all output into structured data.
Get disks attached to macOS devices.
Reformats each drive’s information for Windows OS.
Get disks attached to Windows devices.
+Get physical drives connected to a Windows machine.
lib_path – Returns the library path for disk information.
+lib_path – Library path for disk information.
Returns disks information for Windows machines.
+Returns the formatted data for all the drives as a list of key-value pairs.
List[Dict[str, str]]
@@ -1085,9 +1100,71 @@OS-agnostic function to get all disks connected to the host system.
+Regular expression to remove ANSI escape sequences.
+text – Text with ansi escape characters.
+Cleaned text.
+str
+Powershell Core command to get physical disks and their partitions with drive letters (mount points).
+lib_path – Library path for disk information.
+List of tuples with disk_number, partition_number, mount_point.
+List[Tuple[str, str, str]]
+Get all physical disks and their partitions with mount points.
+lib_path – Library path for disk information.
+Returns a dictionary of DeviceID as key and mount paths as value.
+Dict[str, List[str]]
+Get disks attached to Windows devices.
+lib_path – Library path for disk information.
+Returns disks information for Windows machines.
+List[Dict[str, str]]
+pyninja.features.disks
pyninja.features.disks.__init__
pyninja.features.disks.linux
pyninja.features.disks.macOS
pyninja.features.disks.windows