dwipe


Namedwipe JSON
Version 1.0.4 PyPI version JSON
download
home_pageNone
SummaryA tool to wipe disks and partitions for Linux
upload_time2024-09-12 11:54:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords disk partition wipe clean scrub
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # dwipe
`dwipe` is tool to wipe disks and partitions for Linux helps secure you data. `dwipes` aims to reduce mistakes by providing ample information about your devices during selection.

> **Quick Start:**
> * Install `dwipe` using `pipx install dwipe`, or however you install python scripts from PyPi.org.
> * Run `dwipe` from a terminal and observe the context sensitive help on the 1st line.

To help with your disk scrubbing, `dwipe`:
* shows disks and partitions that can be wiped along with selected information to help choose them (i.e.,; labels, sizes, and types); disallowed are mounted devices and overlapping wipes and manually "locked" disks.
* updates the device list when it changes;  newly added devices are marked differently to make it easier to see them.
* supports starting multiple wipes, shows their progress, and shows completion states.
* supports either zeroing devices or filling with random data.
* supports filtering for devices by name/pattern in case of too many for one screen, etc.
* supports stopping wipes in progress.

`dwipe` shows file system labels, and if not the partition label.  It is best practice to label partitions and file systems well to make selection easier.
  
## Usage
> Simply run `dwipe` from the command line w/o arguments normally. Its command line arguments mostly for debugging including "--dry-run" which lets you test/practice the interface w/o risk.

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 meanings 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 'W' (Wiped) and 's' (partly wiped) states are disk persistent.  For those states, more information is provided about the wipe including when and percent complete.


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

You can navigate the list of devices with arrow keys and vi-like keys.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dwipe",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "disk, partition, wipe, clean, scrub",
    "author": null,
    "author_email": "Joe Defen <joedef@google.com>",
    "download_url": "https://files.pythonhosted.org/packages/3e/73/217aaae243f96d397bceb436d66e0bbd6cf03584c0385278a4da3bb087d7/dwipe-1.0.4.tar.gz",
    "platform": null,
    "description": "# dwipe\n`dwipe` is tool to wipe disks and partitions for Linux helps secure you data. `dwipes` aims to reduce mistakes by providing ample information about your devices during selection.\n\n> **Quick Start:**\n> * Install `dwipe` using `pipx install dwipe`, or however you install python scripts from PyPi.org.\n> * Run `dwipe` from a terminal and observe the context sensitive help on the 1st line.\n\nTo help with your disk scrubbing, `dwipe`:\n* shows disks and partitions that can be wiped along with selected information to help choose them (i.e.,; labels, sizes, and types); disallowed are mounted devices and overlapping wipes and manually \"locked\" disks.\n* updates the device list when it changes;  newly added devices are marked differently to make it easier to see them.\n* supports starting multiple wipes, shows their progress, and shows completion states.\n* supports either zeroing devices or filling with random data.\n* supports filtering for devices by name/pattern in case of too many for one screen, etc.\n* supports stopping wipes in progress.\n\n`dwipe` shows file system labels, and if not the partition label.  It is best practice to label partitions and file systems well to make selection easier.\n  \n## Usage\n> Simply run `dwipe` from the command line w/o arguments normally. Its command line arguments mostly for debugging including \"--dry-run\" which lets you test/practice the interface w/o risk.\n\nHere is a typical screen:\n\n![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-main-screen.png?raw=true)\n\nThe possible state values and meanings are:\n* **-** : indicates the device is ready for wiping if desired.\n* **^** : similar to **-**, but also indicates the device was added after `dwipe` started\n* **Mnt** :  the partition is mounted or the disk has partitions that are mounted.  You cannot wipe the device in this state.\n* **N%** : if a percent is seen, then a wipe is in progress.\n* **STOP** :  indicates that a wipe is being stopped.\n* **s** :  indicates that a wipe was stopped (so the device is partly wiped) and wiping can be restarted.\n* **W** :  indicates that a wipe was completed and wiping can be restarted.\n* **Lock** :  indicates that the disk is manually locked, its partitions are hidden, and you cannot wipe the disk or its partitions.\n* **Unlk** :  indicates that the disk was manually unlocked after a manual lock; this is a transitory state.\n\nThe top line shows available actions and other info. Some actions are context sensitive:\n* **w** : **wipe** : wipe the selected device; before starting, you must confirm your intent.\n* **s** : **stop** : stops the selected wipe in progress (can take a while).\n* **S** : **Stop** : stops all wipes in progress (can take a while).\n* **q** : **quit** : quits the app after stopping wipes in progress.\n* **?** : **help** : bring up help screen with all actions and navigation keys explained.\n* **/** : **search** : limits the show devices to those matching the given regex plus all wipes in progress.\n\nThe 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.\n\nThe 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.\n\nThe 'W' (Wiped) and 's' (partly wiped) states are disk persistent.  For those states, more information is provided about the wipe including when and percent complete.\n\n\n### The Help Screen\nWhen **?** is typed, the help screen looks like:\n\n![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-help-screen.png?raw=true)\n\nYou can navigate the list of devices with arrow keys and vi-like keys.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A tool to wipe disks and partitions for Linux",
    "version": "1.0.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/joedefen/dwipe/issues",
        "Homepage": "https://github.com/joedefen/dwipe"
    },
    "split_keywords": [
        "disk",
        " partition",
        " wipe",
        " clean",
        " scrub"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de84e51b6b66dc1deb623ce15dc4f4a5436478ff982360b19dbaaf3a45fc5315",
                "md5": "eea115e2d79519e27fa983244b27c827",
                "sha256": "23069c142702c504d9f94a4ceb3fb745c88b37101f64ad76124ffc7cf19658e9"
            },
            "downloads": -1,
            "filename": "dwipe-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eea115e2d79519e27fa983244b27c827",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21744,
            "upload_time": "2024-09-12T11:54:40",
            "upload_time_iso_8601": "2024-09-12T11:54:40.890613Z",
            "url": "https://files.pythonhosted.org/packages/de/84/e51b6b66dc1deb623ce15dc4f4a5436478ff982360b19dbaaf3a45fc5315/dwipe-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e73217aaae243f96d397bceb436d66e0bbd6cf03584c0385278a4da3bb087d7",
                "md5": "c4c2b2b924d0d9d50f8c8a47fac1992f",
                "sha256": "6a3eaf23f8eb47c27021881cc61399138d8a3a4b3b10bc98d021021e754838a6"
            },
            "downloads": -1,
            "filename": "dwipe-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "c4c2b2b924d0d9d50f8c8a47fac1992f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 23693,
            "upload_time": "2024-09-12T11:54:42",
            "upload_time_iso_8601": "2024-09-12T11:54:42.399854Z",
            "url": "https://files.pythonhosted.org/packages/3e/73/217aaae243f96d397bceb436d66e0bbd6cf03584c0385278a4da3bb087d7/dwipe-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-12 11:54:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "joedefen",
    "github_project": "dwipe",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "dwipe"
}
        
Elapsed time: 0.50892s