dwipe 1.0.0__tar.gz

dwipe-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joe D
+
+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.

dwipe-1.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: dwipe
+Version: 1.0.0
+Summary: A tool to wipe disks and partitions for Linux
+Author-email: Joe Defen <joedef@google.com>
+License: MIT
+Project-URL: Homepage, https://github.com/joedefen/dwipe
+Project-URL: Bug Tracker, https://github.com/joedefen/dwipe/issues
+Keywords: disk,partition,wipe,clean
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: importlib-metadata; python_version < "3.8"
+Requires-Dist: psutil>=5.9
+
+# dwipe
+`dwipe` to wipe disks and partitions for Linux for your security.
+
+* Install `dwipe` using `pipx install dwipe`, or however you python scripts from PyPi.org.
+
+
+`dwipe` features include:
+* shows the disks and partitions that could be wiped along with useful information to help choose them (i.e., labels, sizes, and types)
+* allows starting multiple wipes and shows their progress.
+* allows filtering for devices by name in case of too many for one screen.
+* allows stopping wipes in progress.
+* not offering to wipe disks that are mounted or would have conflicting/overlapping wipes in progress.
+* allowing to "lock" a disk to prevent mistaken wipes on that disk.
+  
+## Usage
+* Run `dwipe` from the command line.
+
+Here is a typical screen:
+
+![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-main-screen.png?raw=true)
+
+The possible state values and meaning are:
+* **-** : indicates the device is ready for wiping if desired.
+* **^** : similar to **-**, but also indicates the device was added after `dwipe` started
+* **Mnt** :  the partition is mounted or the disk has partitions that are mounted.  You cannot wipe the device in this state.
+* **N%** : if a percent is seen, then a wipe is in progress.
+* **STOP** :  indicates that a wipe is being stopped.
+* **s** :  indicates that a wipe was stopped (so the device is partly wiped) and wiping can be restarted.
+* **W** :  indicates that a wipe was completed and wiping can be restarted.
+* **Lock** :  indicates that the disk is manually locked, its partitions are hidden, and you cannot wipe the disk or its partitions.
+* **Unlk** :  indicates that the disk was manually unlocked after a manual lock; this is a transitory state.
+
+The top line shows available actions and other info. Some actions are context sensitive:
+* **w** : **wipe** : wipe the selected device; before starting, you must confirm your intent.
+* **s** : **stop** : stops the selected wipe in progress (can take a while).
+* **S** : **Stop** : stops all wipes in progress (can take a while).
+* **q** : **quit** : quits the app after stopping wipes in progress.
+* **?** : **help** : bring up help screen with all actions and navigation keys explained.
+* **/** : **search** : limits the show devices to those matching the given regex plus all wipes in progress.
+
+The top line shows the "Mode" which is Random or Zeros. For some disks, zeroing may be faster than random.  Typing **r** toggles the mode (this is seen on the help screen). When Random, a wiped device is filled with random data and then the first 16KB is zeroed.
+
+The write rate and estimating remaining times are shown when wiping a device.  Due to write queueing, the initial rates may be inflated, final rates are deflated, and the times are optimistic.
+
+
+### The Help Screen
+When **?** is typed, the help screen looks like:
+
+![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-help-screen.png?raw=true)

dwipe-1.0.0/README.md

@@ -0,0 +1,49 @@
+# dwipe
+`dwipe` to wipe disks and partitions for Linux for your security.
+
+* Install `dwipe` using `pipx install dwipe`, or however you python scripts from PyPi.org.
+
+
+`dwipe` features include:
+* shows the disks and partitions that could be wiped along with useful information to help choose them (i.e., labels, sizes, and types)
+* allows starting multiple wipes and shows their progress.
+* allows filtering for devices by name in case of too many for one screen.
+* allows stopping wipes in progress.
+* not offering to wipe disks that are mounted or would have conflicting/overlapping wipes in progress.
+* allowing to "lock" a disk to prevent mistaken wipes on that disk.
+  
+## Usage
+* Run `dwipe` from the command line.
+
+Here is a typical screen:
+
+![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-main-screen.png?raw=true)
+
+The possible state values and meaning are:
+* **-** : indicates the device is ready for wiping if desired.
+* **^** : similar to **-**, but also indicates the device was added after `dwipe` started
+* **Mnt** :  the partition is mounted or the disk has partitions that are mounted.  You cannot wipe the device in this state.
+* **N%** : if a percent is seen, then a wipe is in progress.
+* **STOP** :  indicates that a wipe is being stopped.
+* **s** :  indicates that a wipe was stopped (so the device is partly wiped) and wiping can be restarted.
+* **W** :  indicates that a wipe was completed and wiping can be restarted.
+* **Lock** :  indicates that the disk is manually locked, its partitions are hidden, and you cannot wipe the disk or its partitions.
+* **Unlk** :  indicates that the disk was manually unlocked after a manual lock; this is a transitory state.
+
+The top line shows available actions and other info. Some actions are context sensitive:
+* **w** : **wipe** : wipe the selected device; before starting, you must confirm your intent.
+* **s** : **stop** : stops the selected wipe in progress (can take a while).
+* **S** : **Stop** : stops all wipes in progress (can take a while).
+* **q** : **quit** : quits the app after stopping wipes in progress.
+* **?** : **help** : bring up help screen with all actions and navigation keys explained.
+* **/** : **search** : limits the show devices to those matching the given regex plus all wipes in progress.
+
+The top line shows the "Mode" which is Random or Zeros. For some disks, zeroing may be faster than random.  Typing **r** toggles the mode (this is seen on the help screen). When Random, a wiped device is filled with random data and then the first 16KB is zeroed.
+
+The write rate and estimating remaining times are shown when wiping a device.  Due to write queueing, the initial rates may be inflated, final rates are deflated, and the times are optimistic.
+
+
+### The Help Screen
+When **?** is typed, the help screen looks like:
+
+![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-help-screen.png?raw=true)

dwipe-1.0.0/pyproject.toml

@@ -0,0 +1,89 @@
+# HOW TO DEVELOP
+
+#
+# Prep Work (ensure need modules are up-to-date):
+#   sudo apt install python3-pip
+#   sudo apt install python3-pip-whl
+#   pip install build --break-system-packages
+#   sudo apt install twine
+#   -- antiquated way
+#      sudo pacman -Syu python-pip
+#      sudo pacman -Syu python-build
+#      sudo pacman -Syu python-twine
+#   -- antiquated way
+#      python3 -m pip install --upgrade pip
+#      python3 -m pip install --upgrade build
+#      python3 -m pip install --upgrade twine
+#
+# Optionally, `python3 -m venv venv`, and then
+#   - source env/bin/activate # to activate
+#   - deactivate # to deactivate
+# 
+# For a "live" local install:
+#  ./deploy  # uninstall: pip uninstall dwipe # to remove
+# To run:   ./run.sh
+
+# HOW TO PUBLISH...
+# PUBLIC Build and deploy (from project directory):
+#   ## BUMP the version (below in [project])
+#   rm -rf dist; python3 -m build; ls dist/.
+#   python3 -m twine upload dist/*     # keyring --disable # may be required
+#     ## Enter __token__ and the saved TOKEN (in bitwarden)
+#   pipx upgrade dwipe || pipx install dwipe # >= python3.11
+#   --OR-- sudo python3 -m pip install dwipe # <= python3.10
+#   ## VISIT  https://pypi.org/project/dwipe and delete old versions
+#
+# TEST Build and test (from project directory):
+#   ## BUMP the version (below in [project])
+#   rm -r dist; python3 -m build
+#   python3 -m twine upload --repository testpypi dist/* # keyring --disable # may be required
+#     ## Enter __token__ and the saved TOKEN (in bitwarden)
+#   sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps --break-system-packages dwipe
+#   ## VISIT  https://test.pypi.org/project/dwipe and delete old versions
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dwipe"
+version = "1.0.0"
+description = "A tool to wipe disks and partitions for Linux"
+authors = [
+    { name = "Joe Defen", email = "joedef@google.com" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+
+keywords = ["disk", "partition", "wipe", "clean", ]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux"
+]
+dependencies = [
+    'importlib-metadata; python_version<"3.8"',
+    'psutil>=5.9',
+]
+
+[project.urls]
+"Homepage" = "https://github.com/joedefen/dwipe"
+"Bug Tracker" = "https://github.com/joedefen/dwipe/issues"
+
+[project.scripts]
+dwipe = "dwipe.main:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+
+exclude = [
+    "__pycache__",
+]
+

dwipe-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+