Restructure disk summary for all OS

thevickypedia · Nov 29, 2024 · 9e025fd · 9e025fd
1 parent 89e90d0
commit 9e025fd
Show file tree

Hide file tree

Showing 13 changed files with 357 additions and 148 deletions.
diff --git 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
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>PyNinja &#8212; PyNinja  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -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/genindex.html b/docs/genindex.html
@@ -78,28 +78,20 @@ <h2 id="_">_</h2>
       <li><a href="index.html#pyninja.features.cpu._darwin">_darwin() (in module pyninja.features.cpu)</a>
 
       <ul>
-        <li><a href="index.html#pyninja.features.disks._darwin">(in module pyninja.features.disks)</a>
-</li>
         <li><a href="index.html#pyninja.features.gpu._darwin">(in module pyninja.features.gpu)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.features.cpu._linux">_linux() (in module pyninja.features.cpu)</a>
 
       <ul>
-        <li><a href="index.html#pyninja.features.disks._linux">(in module pyninja.features.disks)</a>
-</li>
         <li><a href="index.html#pyninja.features.gpu._linux">(in module pyninja.features.gpu)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#pyninja.features.disks._reformat_windows">_reformat_windows() (in module pyninja.features.disks)</a>
-</li>
       <li><a href="index.html#pyninja.features.cpu._windows">_windows() (in module pyninja.features.cpu)</a>
 
       <ul>
-        <li><a href="index.html#pyninja.features.disks._windows">(in module pyninja.features.disks)</a>
-</li>
         <li><a href="index.html#pyninja.features.gpu._windows">(in module pyninja.features.gpu)</a>
 </li>
       </ul></li>
@@ -144,6 +136,8 @@ <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.secure.calculate_hash">calculate_hash() (in module pyninja.modules.secure)</a>
+</li>
+      <li><a href="index.html#pyninja.features.disks.windows.clean_ansi_escape_sequences">clean_ansi_escape_sequences() (in module pyninja.features.disks.windows)</a>
 </li>
       <li><a href="index.html#pyninja.monitor.config.clear_session">clear_session() (in module pyninja.monitor.config)</a>
 </li>
@@ -197,8 +191,6 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="index.html#pyninja.modules.payloads.ListFiles.directory">directory (pyninja.modules.payloads.ListFiles attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.disk_lib">disk_lib (pyninja.modules.models.EnvConfig attribute)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.Templates.disk_report">disk_report (pyninja.modules.enums.Templates attribute)</a>
@@ -207,6 +199,8 @@ <h2 id="D">D</h2>
         <li><a href="index.html#pyninja.modules.models.EnvConfig.disk_report">(pyninja.modules.models.EnvConfig attribute)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.models.DiskLib">DiskLib (class in pyninja.modules.models)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.docker_container">docker_container (pyninja.modules.enums.APIEndpoints attribute)</a>
@@ -223,6 +217,14 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="index.html#pyninja.modules.enums.Cookies.drive">drive (pyninja.modules.enums.Cookies attribute)</a>
 </li>
+      <li><a href="index.html#pyninja.features.disks.linux.drive_info">drive_info() (in module pyninja.features.disks.linux)</a>
+
+      <ul>
+        <li><a href="index.html#pyninja.features.disks.macOS.drive_info">(in module pyninja.features.disks.macOS)</a>
+</li>
+        <li><a href="index.html#pyninja.features.disks.windows.drive_info">(in module pyninja.features.disks.windows)</a>
+</li>
+      </ul></li>
       <li><a href="index.html#pyninja.executors.squire.dynamic_numbers">dynamic_numbers() (in module pyninja.executors.squire)</a>
 </li>
   </ul></td>
@@ -283,7 +285,7 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_all_disks">get_all_disks (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
-      <li><a href="index.html#pyninja.features.disks.get_all_disks">get_all_disks() (in module pyninja.features.disks)</a>
+      <li><a href="index.html#pyninja.features.disks.__init__.get_all_disks">get_all_disks() (in module pyninja.features.disks.__init__)</a>
 
       <ul>
         <li><a href="index.html#pyninja.routes.metrics.get_all_disks">(in module pyninja.routes.metrics)</a>
@@ -310,6 +312,8 @@ <h2 id="G">G</h2>
       <li><a href="index.html#pyninja.main.get_desc">get_desc() (in module pyninja.main)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_disk">get_disk (pyninja.modules.enums.APIEndpoints attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.features.disks.windows.get_disk_usage">get_disk_usage() (in module pyninja.features.disks.windows)</a>
 </li>
       <li><a href="index.html#pyninja.routes.metrics.get_disk_utilization">get_disk_utilization() (in module pyninja.routes.metrics)</a>
 </li>
@@ -324,17 +328,19 @@ <h2 id="G">G</h2>
 </li>
       </ul></li>
       <li><a href="index.html#pyninja.routes.orchestration.get_docker_volumes">get_docker_volumes() (in module pyninja.routes.orchestration)</a>
+</li>
+      <li><a href="index.html#pyninja.features.disks.windows.get_drives">get_drives() (in module pyninja.features.disks.windows)</a>
 </li>
       <li><a href="index.html#pyninja.monitor.config.get_expiry">get_expiry() (in module pyninja.monitor.config)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_file">get_file (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
       <li><a href="index.html#pyninja.routes.fullaccess.get_file">get_file() (in module pyninja.routes.fullaccess)</a>
-</li>
-      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_ip">get_ip (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_ip">get_ip (pyninja.modules.enums.APIEndpoints attribute)</a>
+</li>
       <li><a href="index.html#pyninja.routes.ipaddr.get_ip_address">get_ip_address() (in module pyninja.routes.ipaddr)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.get_library">get_library() (in module pyninja.modules.models)</a>
@@ -348,6 +354,8 @@ <h2 id="G">G</h2>
       <li><a href="index.html#pyninja.features.gpu.get_names">get_names() (in module pyninja.features.gpu)</a>
 </li>
       <li><a href="index.html#pyninja.features.process.get_performance">get_performance() (in module pyninja.features.process)</a>
+</li>
+      <li><a href="index.html#pyninja.features.disks.windows.get_physical_disks_and_partitions">get_physical_disks_and_partitions() (in module pyninja.features.disks.windows)</a>
 </li>
       <li><a href="index.html#pyninja.features.operations.get_process_info">get_process_info() (in module pyninja.features.operations)</a>
 </li>
@@ -535,7 +543,13 @@ <h2 id="M">M</h2>
 </li>
         <li><a href="index.html#module-pyninja.features.cpu">pyninja.features.cpu</a>
 </li>
-        <li><a href="index.html#module-pyninja.features.disks">pyninja.features.disks</a>
+        <li><a href="index.html#module-pyninja.features.disks.__init__">pyninja.features.disks.__init__</a>
+</li>
+        <li><a href="index.html#module-pyninja.features.disks.linux">pyninja.features.disks.linux</a>
+</li>
+        <li><a href="index.html#module-pyninja.features.disks.macOS">pyninja.features.disks.macOS</a>
+</li>
+        <li><a href="index.html#module-pyninja.features.disks.windows">pyninja.features.disks.windows</a>
 </li>
         <li><a href="index.html#module-pyninja.features.dockerized">pyninja.features.dockerized</a>
 </li>
@@ -628,9 +642,9 @@ <h2 id="P">P</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.parse_api_secret">parse_api_secret() (pyninja.modules.models.EnvConfig class method)</a>
 </li>
-      <li><a href="index.html#pyninja.features.disks.parse_diskutil_output">parse_diskutil_output() (in module pyninja.features.disks)</a>
+      <li><a href="index.html#pyninja.features.disks.macOS.parse_diskutil_output">parse_diskutil_output() (in module pyninja.features.disks.macOS)</a>
 </li>
-      <li><a href="index.html#pyninja.features.disks.parse_size">parse_size() (in module pyninja.features.disks)</a>
+      <li><a href="index.html#pyninja.features.disks.macOS.parse_size">parse_size() (in module pyninja.features.disks.macOS)</a>
 </li>
       <li><a href="index.html#pyninja.executors.squire.private_ip_address">private_ip_address() (in module pyninja.executors.squire)</a>
 </li>
@@ -692,10 +706,31 @@ <h2 id="P">P</h2>
 </li>
       </ul></li>
       <li>
-    pyninja.features.disks
+    pyninja.features.disks.__init__
+
+      <ul>
+        <li><a href="index.html#module-pyninja.features.disks.__init__">module</a>
+</li>
+      </ul></li>
+      <li>
+    pyninja.features.disks.linux
+
+      <ul>
+        <li><a href="index.html#module-pyninja.features.disks.linux">module</a>
+</li>
+      </ul></li>
+      <li>
+    pyninja.features.disks.macOS
+
+      <ul>
+        <li><a href="index.html#module-pyninja.features.disks.macOS">module</a>
+</li>
+      </ul></li>
+      <li>
+    pyninja.features.disks.windows
 
       <ul>
-        <li><a href="index.html#module-pyninja.features.disks">module</a>
+        <li><a href="index.html#module-pyninja.features.disks.windows">module</a>
 </li>
       </ul></li>
       <li>
@@ -719,6 +754,8 @@ <h2 id="P">P</h2>
         <li><a href="index.html#module-pyninja.features.operations">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     pyninja.features.process
 
@@ -733,8 +770,6 @@ <h2 id="P">P</h2>
         <li><a href="index.html#module-pyninja.features.service">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     pyninja.main
 
@@ -877,6 +912,8 @@ <h2 id="R">R</h2>
       <li><a href="index.html#pyninja.modules.exceptions.RedirectException">RedirectException</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.redoc">redoc (pyninja.modules.enums.APIEndpoints attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.features.disks.windows.reformat_windows">reformat_windows() (in module pyninja.features.disks.windows)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -976,7 +1013,7 @@ <h2 id="U">U</h2>
 </li>
       <li><a href="index.html#pyninja.modules.exceptions.UnSupportedOS">UnSupportedOS</a>
 </li>
-      <li><a href="index.html#pyninja.features.disks.update_mountpoints">update_mountpoints() (in module pyninja.features.disks)</a>
+      <li><a href="index.html#pyninja.features.disks.macOS.update_mountpoints">update_mountpoints() (in module pyninja.features.disks.macOS)</a>
 </li>
   </ul></td>
 </tr></table>