# StealthText
StealthText is a simple and secure library for encrypting and decrypting text messages using AES encryption. This package also provides a command-line interface for easy use.
## Features
- **Encryption**: Securely encrypt text messages.
- **Decryption**: Decrypt previously encrypted messages.
- **Command-Line Interface**: Easily encrypt or decrypt messages directly from the terminal.
## Installation
You can install `StealthText` using pip:
```bash
pip install StealthText
```
## Usage
### Importing the Library
You can use `StealthText` in your Python code by importing the `encrypt` and `decrypt` functions:
```python
from stealthtext import encrypt, decrypt
```
### Encrypting a Message
To encrypt a message, use the `encrypt` function:
```python
password = 'your_password' # Use a strong password
message = 'Hello, world!' # Message to encrypt
encrypted_message = encrypt(message, password)
print(f'Encrypted Message: {encrypted_message}')
```
### Decrypting a Message
To decrypt an encrypted message, use the `decrypt` function:
```python
encrypted_message = 'your_encrypted_message_here' # Replace with your encrypted message
try:
decrypted_message = decrypt(encrypted_message, password)
print(f'Decrypted Message: {decrypted_message}')
except Exception as e:
print("Decryption failed:", e)
```
## Command-Line Interface
### Encrypt a Message
You can also use the command-line interface to encrypt messages:
```bash
stealthtext encrypt your_password "Hello, world!"
```
### Decrypt a Message
To decrypt a message from the command line, use:
```bash
stealthtext decrypt your_password "your_encrypted_message_here"
```
### Command-Line Arguments
- **action**: The action to perform, either `encrypt` or `decrypt`.
- **password**: The password used for encryption or decryption.
- **message**: The message to encrypt or the encrypted message to decrypt.
### Example
Here’s a full example of using the CLI:
1. Encrypt a message :
```bash
stealthtext encrypt my_secret_password "This is a secret message."
```
Output :
Encrypted Message: [Base64 encoded string]
2. Decrypt the message:
```bash
stealthtext decrypt my_secret_password "[Base64 encoded string]"
```
Output :
Decrypted Message: This is a secret message.
## Security Recommendations
- Always use a strong password for encryption.
- Keep your passwords and encrypted messages secure.
- Consider using a password manager to store your passwords.
## Contribution
Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ByteBreach/StealthText",
"name": "StealthText",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "MrFidal",
"author_email": "mrfidal@proton.me",
"download_url": "https://files.pythonhosted.org/packages/24/43/1bac5e789f7a88925b68c33a9b37e100dd652fa46db2ec42e36b8f76dcae/StealthText-0.1.0.tar.gz",
"platform": null,
"description": "# StealthText\r\n\r\nStealthText is a simple and secure library for encrypting and decrypting text messages using AES encryption. This package also provides a command-line interface for easy use.\r\n\r\n## Features\r\n\r\n- **Encryption**: Securely encrypt text messages.\r\n- **Decryption**: Decrypt previously encrypted messages.\r\n- **Command-Line Interface**: Easily encrypt or decrypt messages directly from the terminal.\r\n\r\n## Installation\r\n\r\nYou can install `StealthText` using pip:\r\n\r\n```bash\r\npip install StealthText\r\n```\r\n\r\n## Usage\r\n\r\n### Importing the Library\r\n\r\nYou can use `StealthText` in your Python code by importing the `encrypt` and `decrypt` functions:\r\n\r\n```python\r\nfrom stealthtext import encrypt, decrypt\r\n```\r\n\r\n### Encrypting a Message\r\n\r\nTo encrypt a message, use the `encrypt` function:\r\n\r\n```python\r\npassword = 'your_password' # Use a strong password\r\nmessage = 'Hello, world!' # Message to encrypt\r\n\r\nencrypted_message = encrypt(message, password)\r\nprint(f'Encrypted Message: {encrypted_message}')\r\n```\r\n\r\n### Decrypting a Message\r\n\r\nTo decrypt an encrypted message, use the `decrypt` function:\r\n\r\n```python\r\nencrypted_message = 'your_encrypted_message_here' # Replace with your encrypted message\r\n\r\ntry:\r\n decrypted_message = decrypt(encrypted_message, password)\r\n print(f'Decrypted Message: {decrypted_message}')\r\nexcept Exception as e:\r\n print(\"Decryption failed:\", e)\r\n```\r\n\r\n## Command-Line Interface\r\n\r\n### Encrypt a Message\r\n\r\nYou can also use the command-line interface to encrypt messages:\r\n\r\n```bash\r\nstealthtext encrypt your_password \"Hello, world!\"\r\n```\r\n\r\n### Decrypt a Message\r\n\r\nTo decrypt a message from the command line, use:\r\n\r\n```bash\r\nstealthtext decrypt your_password \"your_encrypted_message_here\"\r\n```\r\n\r\n### Command-Line Arguments\r\n\r\n- **action**: The action to perform, either `encrypt` or `decrypt`.\r\n- **password**: The password used for encryption or decryption.\r\n- **message**: The message to encrypt or the encrypted message to decrypt.\r\n\r\n### Example\r\n\r\nHere\u2019s a full example of using the CLI:\r\n\r\n1. Encrypt a message :\r\n\r\n```bash\r\nstealthtext encrypt my_secret_password \"This is a secret message.\"\r\n```\r\n\r\nOutput :\r\n\r\nEncrypted Message: [Base64 encoded string] \r\n\r\n\r\n2. Decrypt the message:\r\n\r\n```bash\r\nstealthtext decrypt my_secret_password \"[Base64 encoded string]\"\r\n```\r\n\r\nOutput :\r\n\r\nDecrypted Message: This is a secret message.\r\n\r\n\r\n## Security Recommendations\r\n\r\n- Always use a strong password for encryption.\r\n- Keep your passwords and encrypted messages secure.\r\n- Consider using a password manager to store your passwords.\r\n\r\n## Contribution\r\n\r\nContributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.\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",
"bugtrack_url": null,
"license": null,
"summary": "A simple encryption and decryption library for secure messaging.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/ByteBreach/StealthText"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aab98a97a828fc63482bdb1a19b7d471af4074fbec2847ae938fc850b1db8a76",
"md5": "39dd337d38c43eda42c97891d8f69ed7",
"sha256": "32c0ed4e44dff58a5a2d71142a80f82989e911798e721bb42cb62b9430e0d762"
},
"downloads": -1,
"filename": "StealthText-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39dd337d38c43eda42c97891d8f69ed7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3865,
"upload_time": "2024-10-29T20:39:28",
"upload_time_iso_8601": "2024-10-29T20:39:28.633399Z",
"url": "https://files.pythonhosted.org/packages/aa/b9/8a97a828fc63482bdb1a19b7d471af4074fbec2847ae938fc850b1db8a76/StealthText-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24431bac5e789f7a88925b68c33a9b37e100dd652fa46db2ec42e36b8f76dcae",
"md5": "897dc3b70295d3de72c4c6f3c6e8c9ff",
"sha256": "de626677fb8698d3fbe593d40ce64fa9c065c5c202c78ee29f465e6113c9e640"
},
"downloads": -1,
"filename": "StealthText-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "897dc3b70295d3de72c4c6f3c6e8c9ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3478,
"upload_time": "2024-10-29T20:39:30",
"upload_time_iso_8601": "2024-10-29T20:39:30.957900Z",
"url": "https://files.pythonhosted.org/packages/24/43/1bac5e789f7a88925b68c33a9b37e100dd652fa46db2ec42e36b8f76dcae/StealthText-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 20:39:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ByteBreach",
"github_project": "StealthText",
"github_not_found": true,
"lcname": "stealthtext"
}
JSON
