| Name | noplaintext JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | An application for generating and managing encryption keys and encrypting/decrypting messages. |
| upload_time | 2024-08-08 19:50:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# noplaintext
## Overview
noplaintext is a module that is intended to eliminate hard-coded credentials in scripts by encrypting them using a external key file. This means that only the encrypted credentials are visible and can only be decrypted with a key file that can be stored in a directory not accessible from a github repository, network drive, or wherever else the source code made be. There is a graphical application to generate a key file and encrypt credentials.
## Project Structure
```
/project-root
/src
/crypto_utils
__init__.py
crypto_utils.py
README.md
/gui_app
__init__.py
gui_app.py
README.md
README.md
pyproject.toml
requirements.txt
```
- `/src/crypto_utils`: Contains the cryptographic utility functions for key generation, loading, encryption, and decryption.
- `/src/gui_app`: Contains the GUI application that interacts with the user to perform cryptographic operations.
- `/tests`: Contains tests for the cryptographic utilities.
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/Sluke950/noplaintext.git
```
2. **Navigate to the project directory:**
```bash
cd noplaintext
```
3. **Install dependencies:**
```bash
pip install -r requirements.txt
```
4. **Run the GUI application:**
```bash
python src/noplaintext/gui_app/gui_app.py
```
## Dependencies
- `tkinter` (included with Python)
- `cryptography`
- `logging`
## Usage
1. **Generate Key:** Click the "Generate Key" button to create a new encryption key and save it to a file.
2. **Load Key:** Click the "Load Key" button to load an existing key from a file.
3. **Encrypt Message:** Enter a message and click "Encrypt" to encrypt it using the loaded key.
4. **Decrypt Message:** Enter an encrypted message and click "Decrypt" to decrypt it using the loaded key.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
If you want to contribute to this project, please fork the repository, make your changes, and submit a pull request. All contributions are welcome!
Raw data
{
"_id": null,
"home_page": null,
"name": "noplaintext",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Luke Shuttleworth <Sluke950@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fe/f8/87191518abb4935a18e563a30cae8609cd4653a7b92b15af81ea41f4d4f4/noplaintext-0.4.1.tar.gz",
"platform": null,
"description": "# noplaintext\r\n\r\n## Overview\r\n\r\nnoplaintext is a module that is intended to eliminate hard-coded credentials in scripts by encrypting them using a external key file. This means that only the encrypted credentials are visible and can only be decrypted with a key file that can be stored in a directory not accessible from a github repository, network drive, or wherever else the source code made be. There is a graphical application to generate a key file and encrypt credentials.\r\n\r\n## Project Structure\r\n```\r\n/project-root\r\n /src\r\n /crypto_utils\r\n __init__.py\r\n crypto_utils.py\r\n README.md\r\n /gui_app\r\n __init__.py\r\n gui_app.py\r\n README.md\r\n \r\n README.md\r\n pyproject.toml\r\n requirements.txt\r\n```\r\n\r\n- `/src/crypto_utils`: Contains the cryptographic utility functions for key generation, loading, encryption, and decryption.\r\n- `/src/gui_app`: Contains the GUI application that interacts with the user to perform cryptographic operations.\r\n- `/tests`: Contains tests for the cryptographic utilities.\r\n\r\n## Installation\r\n\r\n1. **Clone the repository:**\r\n\r\n ```bash\r\n git clone https://github.com/Sluke950/noplaintext.git\r\n ```\r\n\r\n2. **Navigate to the project directory:**\r\n\r\n ```bash\r\n cd noplaintext\r\n ```\r\n\r\n3. **Install dependencies:**\r\n\r\n ```bash\r\n pip install -r requirements.txt\r\n ```\r\n\r\n4. **Run the GUI application:**\r\n\r\n ```bash\r\n python src/noplaintext/gui_app/gui_app.py\r\n ```\r\n\r\n## Dependencies\r\n\r\n- `tkinter` (included with Python)\r\n- `cryptography`\r\n- `logging`\r\n\r\n## Usage\r\n\r\n1. **Generate Key:** Click the \"Generate Key\" button to create a new encryption key and save it to a file.\r\n2. **Load Key:** Click the \"Load Key\" button to load an existing key from a file.\r\n3. **Encrypt Message:** Enter a message and click \"Encrypt\" to encrypt it using the loaded key.\r\n4. **Decrypt Message:** Enter an encrypted message and click \"Decrypt\" to decrypt it using the loaded key.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Contributing\r\n\r\nIf you want to contribute to this project, please fork the repository, make your changes, and submit a pull request. All contributions are welcome!\r\n",
"bugtrack_url": null,
"license": null,
"summary": "An application for generating and managing encryption keys and encrypting/decrypting messages.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/Sluke950/noplaintext",
"Issues": "https://github.com/Sluke950/noplaintext/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d35a3b5b3ad045bd9a5801bb7fc1525d85e3939738e4abe7637692310484a0d",
"md5": "2d1698a32d2b6c619cf79b324b2430fa",
"sha256": "79fc1dc29a7e57a4dedf9ce63cfebd93ed5a38b2281de0ca2c95c31088a1127a"
},
"downloads": -1,
"filename": "noplaintext-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2d1698a32d2b6c619cf79b324b2430fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5508,
"upload_time": "2024-08-08T19:49:56",
"upload_time_iso_8601": "2024-08-08T19:49:56.241326Z",
"url": "https://files.pythonhosted.org/packages/6d/35/a3b5b3ad045bd9a5801bb7fc1525d85e3939738e4abe7637692310484a0d/noplaintext-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fef887191518abb4935a18e563a30cae8609cd4653a7b92b15af81ea41f4d4f4",
"md5": "97f806dc36e4a1d43a465668166c02f2",
"sha256": "1557c5e2fcb92209df4f7f2310a8774450edb3f2c37cd6bbadb8bb90e0261217"
},
"downloads": -1,
"filename": "noplaintext-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "97f806dc36e4a1d43a465668166c02f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5094,
"upload_time": "2024-08-08T19:50:00",
"upload_time_iso_8601": "2024-08-08T19:50:00.507893Z",
"url": "https://files.pythonhosted.org/packages/fe/f8/87191518abb4935a18e563a30cae8609cd4653a7b92b15af81ea41f4d4f4/noplaintext-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 19:50:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sluke950",
"github_project": "noplaintext",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "noplaintext"
}
