| Name | cryptshield JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Secure Encryption and Deletion Application |
| upload_time | 2025-02-17 03:48:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2023 Wilmer Martinez <info@wilmermartinez.dev>
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.
|
| keywords |
encryption
deletion
secure
application
python
cryptography
cryptshield
guardian
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
cryptography
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Secure Encryption and Deletion Application
This Python application allows you to securely encrypt files and directories using the **Fernet** library and permanently delete them with the **shred** command. It is useful for protecting sensitive data and ensuring it cannot be recovered.
## **Main Features**
- **Secure Encryption:** Uses the Fernet library to encrypt files and directories with a user-provided key.
- **Permanent Deletion:** Securely removes files and directories using the **shred** command.
- **Recursive Processing:** Supports encrypting and deleting files within directories recursively.
- **User Confirmation Options:** Can be configured to require user confirmation before encrypting or deleting files.
## **Requirements**
- Python 3.x
- Required libraries: `cryptography`, `hashlib`
---
## **Usage**
### **Running `cryptshield`**
#### Basic syntax:
```sh
cryptshield [COMMAND] [OPTION1] [OPTION2]
```
#### Examples:
```sh
# Encrypt a file
cryptshield encrypt /path/to/file secret_key
# Decrypt a file
cryptshield decrypt /path/to/file.encrypted secret_key
# Encrypt a text
cryptshield encrypt_text "Sample text" secret_key
"gAAAAABnsO0xV07ndDmt-fO..."
# Decrypt a text
cryptshield decrypt_text "gAAAAABnsO0xV07ndDmt-fO..." secret_key
"Sample text"
# Secure file deletion
cryptshield delete /path/to/file
```
---
## Release Information
### Version 1.0.0
You can download the latest release of the **Cryptshield** package as a `.deb` file from the following link:
[Download Cryptshield 1.0.0 (.deb)](https://github.com/wilmerm/cryptshield/releases/download/v1.0.0/cryptshield_1.0.0_all.deb)
### Installation
To install the package on your system, run the following command:
```bash
wget https://github.com/wilmerm/cryptshield/releases/download/v1.0.0/cryptshield_1.0.0_all.deb
sudo dpkg -i cryptshield_1.0.0_all.deb
```
After installation, you can run the `cryptshield` command by simply typing:
```bash
cryptshield encrypt [FILE] [KEY]
```
If you encounter any issues with dependencies, you can resolve them using:
```bash
sudo apt-get install -f
```
---
## **Setup**
Ensure the required libraries are installed using the following command:
```sh
pip install -r requirements.txt
```
If you plan to use **secure deletion**, make sure you have administrator (`sudo`) privileges.
### Installation and `.deb` Package Creation
Follow these steps to create and install the `.deb` package for *Cryptshield*:
#### 1. Build the Package
Run:
```bash
dpkg-buildpackage -us -uc
```
#### 2. Install and Test
```bash
sudo dpkg -i ../cryptshield_<version>_all.deb
cryptshield
```
If there are dependency issues, fix them with:
```bash
sudo apt-get install -f
```
### Building and Publishing the Library
To compile and upload the library to PyPI, follow these steps:
1. Ensure you have the necessary dependencies:
```sh
pip install build twine
```
2. Build the package:
```sh
python -m build
```
3. (Optional) Verify the package:
```sh
twine check dist/*
```
4. Upload the package to PyPI:
```sh
python -m twine upload dist/*
```
---
## **Contributing**
If you'd like to contribute to this project or report an issue, feel free to open an issue or submit a pull request on GitHub.
---
## **License**
This application is distributed under the **MIT License**.
## Contribution 💗
If you find value in this project and would like to show your support, please consider making a donation via PayPal:
[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)
Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!
Raw data
{
"_id": null,
"home_page": null,
"name": "cryptshield",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "encryption, deletion, secure, application, python, cryptography, cryptshield, guardian",
"author": null,
"author_email": "Wilmer Martinez <info@wilmermartinez.dev>",
"download_url": "https://files.pythonhosted.org/packages/68/e7/452795a33099165972e5770f92bcf763a9aa65bca5987353b27588f872f3/cryptshield-1.0.1.tar.gz",
"platform": null,
"description": "# Secure Encryption and Deletion Application\n\nThis Python application allows you to securely encrypt files and directories using the **Fernet** library and permanently delete them with the **shred** command. It is useful for protecting sensitive data and ensuring it cannot be recovered.\n\n## **Main Features**\n\n- **Secure Encryption:** Uses the Fernet library to encrypt files and directories with a user-provided key.\n- **Permanent Deletion:** Securely removes files and directories using the **shred** command.\n- **Recursive Processing:** Supports encrypting and deleting files within directories recursively.\n- **User Confirmation Options:** Can be configured to require user confirmation before encrypting or deleting files.\n\n## **Requirements**\n\n- Python 3.x\n- Required libraries: `cryptography`, `hashlib`\n\n---\n\n## **Usage**\n\n### **Running `cryptshield`**\n\n#### Basic syntax:\n\n```sh\ncryptshield [COMMAND] [OPTION1] [OPTION2]\n```\n\n#### Examples:\n\n```sh\n# Encrypt a file\ncryptshield encrypt /path/to/file secret_key\n\n# Decrypt a file\ncryptshield decrypt /path/to/file.encrypted secret_key\n\n# Encrypt a text\ncryptshield encrypt_text \"Sample text\" secret_key\n\"gAAAAABnsO0xV07ndDmt-fO...\"\n\n# Decrypt a text\ncryptshield decrypt_text \"gAAAAABnsO0xV07ndDmt-fO...\" secret_key\n\"Sample text\"\n\n# Secure file deletion\ncryptshield delete /path/to/file\n```\n\n---\n\n## Release Information\n\n### Version 1.0.0\n\nYou can download the latest release of the **Cryptshield** package as a `.deb` file from the following link:\n\n[Download Cryptshield 1.0.0 (.deb)](https://github.com/wilmerm/cryptshield/releases/download/v1.0.0/cryptshield_1.0.0_all.deb)\n\n### Installation\n\nTo install the package on your system, run the following command:\n\n```bash\nwget https://github.com/wilmerm/cryptshield/releases/download/v1.0.0/cryptshield_1.0.0_all.deb\n\nsudo dpkg -i cryptshield_1.0.0_all.deb\n```\n\nAfter installation, you can run the `cryptshield` command by simply typing:\n\n```bash\ncryptshield encrypt [FILE] [KEY]\n```\n\nIf you encounter any issues with dependencies, you can resolve them using:\n\n```bash\nsudo apt-get install -f\n```\n\n---\n\n## **Setup**\n\nEnsure the required libraries are installed using the following command:\n\n```sh\npip install -r requirements.txt\n```\n\nIf you plan to use **secure deletion**, make sure you have administrator (`sudo`) privileges.\n\n\n### Installation and `.deb` Package Creation\n\nFollow these steps to create and install the `.deb` package for *Cryptshield*:\n\n#### 1. Build the Package\nRun:\n```bash\ndpkg-buildpackage -us -uc\n```\n\n#### 2. Install and Test\n```bash\nsudo dpkg -i ../cryptshield_<version>_all.deb\ncryptshield\n```\n\nIf there are dependency issues, fix them with:\n```bash\nsudo apt-get install -f\n```\n\n### Building and Publishing the Library\n\nTo compile and upload the library to PyPI, follow these steps:\n\n1. Ensure you have the necessary dependencies:\n\n ```sh\n pip install build twine\n ```\n\n2. Build the package:\n\n ```sh\n python -m build\n ```\n\n3. (Optional) Verify the package:\n\n ```sh\n twine check dist/*\n ```\n\n4. Upload the package to PyPI:\n\n ```sh\n python -m twine upload dist/*\n ```\n\n---\n\n## **Contributing**\n\nIf you'd like to contribute to this project or report an issue, feel free to open an issue or submit a pull request on GitHub.\n\n---\n\n## **License**\n\nThis application is distributed under the **MIT License**.\n\n## Contribution \ud83d\udc97\n\nIf you find value in this project and would like to show your support, please consider making a donation via PayPal:\n\n[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)\n\nYour generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 Wilmer Martinez <info@wilmermartinez.dev>\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Secure Encryption and Deletion Application",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://github.com/wilmerm/cryptshield?tab=readme-ov-file#secure-encryption-and-deletion-application",
"Homepage": "https://github.com/wilmerm/cryptshield",
"Issues": "https://github.com/wilmerm/cryptshield/issues",
"Release": "https://github.com/wilmerm/cryptshield/releases",
"Repository": "https://github.com/wilmerm/cryptshield"
},
"split_keywords": [
"encryption",
" deletion",
" secure",
" application",
" python",
" cryptography",
" cryptshield",
" guardian"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "235aa14fe29f4b889691436614a6fe3908af552ff7d417ae0585b3ffbb919ac1",
"md5": "f91c66614fe070468827b9f6601c4622",
"sha256": "b7e36a1302d73c1932bbd7be369d3489bbb1962ff2ec99d0b452966ffee11139"
},
"downloads": -1,
"filename": "cryptshield-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f91c66614fe070468827b9f6601c4622",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8574,
"upload_time": "2025-02-17T03:48:57",
"upload_time_iso_8601": "2025-02-17T03:48:57.523936Z",
"url": "https://files.pythonhosted.org/packages/23/5a/a14fe29f4b889691436614a6fe3908af552ff7d417ae0585b3ffbb919ac1/cryptshield-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "68e7452795a33099165972e5770f92bcf763a9aa65bca5987353b27588f872f3",
"md5": "f2d4d1eb7a75f7c197436b20e5670717",
"sha256": "7329f012af4197a27457d547c710d3bc41128b5d2967e2cb6593d88b1aaa8758"
},
"downloads": -1,
"filename": "cryptshield-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f2d4d1eb7a75f7c197436b20e5670717",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10382,
"upload_time": "2025-02-17T03:48:59",
"upload_time_iso_8601": "2025-02-17T03:48:59.336387Z",
"url": "https://files.pythonhosted.org/packages/68/e7/452795a33099165972e5770f92bcf763a9aa65bca5987353b27588f872f3/cryptshield-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 03:48:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wilmerm",
"github_project": "cryptshield?tab=readme-ov-file#secure-encryption-and-deletion-application",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "cryptography",
"specs": []
}
],
"lcname": "cryptshield"
}
