# securewipe 3.0.0
- `securewipe` is a Python package for securely wiping files or folders by overwriting them with random data. It also provides a command-line interface (CLI) for easy usage.
- You can rely on Securewipe to overwrite the data using various patterns, ensuring it is virtually impossible to recover.
## Benefits
- **Security:** Ensures sensitive files or directories are securely wiped by overwriting them with random data, making recovery impossible.
- **Ease of Use:** Provides a straightforward CLI interface and Python API for integrating secure file wiping into applications and scripts.
- **Customization:** Allows customization through Python scripts for specific file or directory wiping requirements.
## Installation
You can install `securewipe` via pip:
```bash
pip install securewipe
```
## Usage
### Command-Line Interface (CLI)
#### Overwrite a specific file
To overwrite a specific file with random data:
```bash
securewipe --self-destruct /path/to/file.txt
```
#### Overwrite all files in a directory
To overwrite all files within a directory with random data:
```bash
securewipe --self-destruct /path/to/folder/
```
### Python Code Examples
#### Self-destruct current script
```python
from securewipe import replace_random
try:
replace_random(__file__)
print("Self-destructed successfully.")
except Exception as e:
print(f"Error: {e}")
```
#### Overwrite a specific file
```python
from securewipe import replace_random
file_path = '/path/to/file.txt'
try:
replace_random(file_path)
print(f"Successfully overwritten: {file_path}")
except Exception as e:
print(f"Error: {e}")
```
#### Overwrite all files in a directory
```python
import os
from securewipe import replace_random
folder_path = '/path/to/folder/'
try:
for file_name in os.listdir(folder_path):
file_path = os.path.join(folder_path, file_name)
if os.path.isfile(file_path):
replace_random(file_path)
print(f"Successfully overwritten: {file_path}")
except Exception as e:
print(f"Error: {e}")
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgements
Thank you for using `securewipe`! If you find it useful, please consider starring the repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/Bytebreach/securewipe",
"name": "securewipe",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Fidal",
"author_email": "mrfidal@proton.me",
"download_url": "https://files.pythonhosted.org/packages/5e/0b/3c20dc630dc130d3a1b3d756c989791c3516dd91c982b28ace1765cf0263/securewipe-3.0.0.tar.gz",
"platform": null,
"description": "# securewipe 3.0.0\r\n\r\n- `securewipe` is a Python package for securely wiping files or folders by overwriting them with random data. It also provides a command-line interface (CLI) for easy usage.\r\n- You can rely on Securewipe to overwrite the data using various patterns, ensuring it is virtually impossible to recover.\r\n\r\n## Benefits\r\n\r\n- **Security:** Ensures sensitive files or directories are securely wiped by overwriting them with random data, making recovery impossible.\r\n- **Ease of Use:** Provides a straightforward CLI interface and Python API for integrating secure file wiping into applications and scripts.\r\n- **Customization:** Allows customization through Python scripts for specific file or directory wiping requirements.\r\n \r\n## Installation\r\n\r\nYou can install `securewipe` via pip:\r\n\r\n```bash\r\npip install securewipe\r\n```\r\n\r\n## Usage\r\n\r\n### Command-Line Interface (CLI)\r\n\r\n#### Overwrite a specific file\r\n\r\nTo overwrite a specific file with random data:\r\n\r\n```bash\r\nsecurewipe --self-destruct /path/to/file.txt\r\n```\r\n\r\n#### Overwrite all files in a directory\r\n\r\nTo overwrite all files within a directory with random data:\r\n\r\n```bash\r\nsecurewipe --self-destruct /path/to/folder/\r\n```\r\n\r\n### Python Code Examples\r\n\r\n#### Self-destruct current script\r\n\r\n```python\r\nfrom securewipe import replace_random\r\n\r\ntry:\r\n replace_random(__file__)\r\n print(\"Self-destructed successfully.\")\r\nexcept Exception as e:\r\n print(f\"Error: {e}\")\r\n```\r\n\r\n#### Overwrite a specific file\r\n\r\n```python\r\nfrom securewipe import replace_random\r\n\r\nfile_path = '/path/to/file.txt'\r\n\r\ntry:\r\n replace_random(file_path)\r\n print(f\"Successfully overwritten: {file_path}\")\r\nexcept Exception as e:\r\n print(f\"Error: {e}\")\r\n```\r\n\r\n#### Overwrite all files in a directory\r\n\r\n```python\r\nimport os\r\nfrom securewipe import replace_random\r\n\r\nfolder_path = '/path/to/folder/'\r\n\r\ntry:\r\n for file_name in os.listdir(folder_path):\r\n file_path = os.path.join(folder_path, file_name)\r\n if os.path.isfile(file_path):\r\n replace_random(file_path)\r\n print(f\"Successfully overwritten: {file_path}\")\r\nexcept Exception as e:\r\n print(f\"Error: {e}\")\r\n```\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n## Acknowledgements\r\n\r\nThank you for using `securewipe`! If you find it useful, please consider starring the repository.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python package for securely wiping files or folders.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/Bytebreach/securewipe"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b1929469b633c2e0f38a1be858d1985358146ad5c98ea1814aa0db5ea88969bf",
"md5": "1aef788d7fa2b2488551218982ca6ad9",
"sha256": "f7e069b34bdbd7ea1178138a910322919a951db159fb9ae110578b432c89c2e6"
},
"downloads": -1,
"filename": "securewipe-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aef788d7fa2b2488551218982ca6ad9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4306,
"upload_time": "2024-07-13T17:44:42",
"upload_time_iso_8601": "2024-07-13T17:44:42.836602Z",
"url": "https://files.pythonhosted.org/packages/b1/92/9469b633c2e0f38a1be858d1985358146ad5c98ea1814aa0db5ea88969bf/securewipe-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e0b3c20dc630dc130d3a1b3d756c989791c3516dd91c982b28ace1765cf0263",
"md5": "738e88e50bee756e57ebb68ec0eb0429",
"sha256": "dbfa5eaec94bd9ec85d1b0d3183d7cb8a472004f80fc568b3b4a3214a07a0b0f"
},
"downloads": -1,
"filename": "securewipe-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "738e88e50bee756e57ebb68ec0eb0429",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3580,
"upload_time": "2024-07-13T17:44:44",
"upload_time_iso_8601": "2024-07-13T17:44:44.663450Z",
"url": "https://files.pythonhosted.org/packages/5e/0b/3c20dc630dc130d3a1b3d756c989791c3516dd91c982b28ace1765cf0263/securewipe-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 17:44:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Bytebreach",
"github_project": "securewipe",
"github_not_found": true,
"lcname": "securewipe"
}
JSON
