# Encryptionsuite (File Encryption and Decryption)
This is a CLI tool for encrypting and decrypting files and folders.
Be carefull on how you use, irresponsible use can lead user to turning their data into chunks
if encryption keys are miss-handled.
For every encrypte file an Encryption key used is save in filename.xml file
where filename is name of the input file to be encrypted.
## Installation
1. Install via pip:
```shell
pip install Encryptionsuite
```
2. Install from github:
```shell
pip install git+https://github.com/skye-cyber/Encryptionsuite.git
```
## Usage
To run the CLI app, use the following command:
```shell
Encryptionsuite [options]
```
Replace `[options]` with the appropriate command-line options based on the functionality you want to execute.
## Available Options
`1`.``-m/--mode`` operation to be performed(encryption or Decryption) value ```[encrypt, decrypt]```
`2`.``-i/--input_file``
`3`.``-k/--key`` only when decrypting
## Examples
1. Example command 1:
```shell
Encryptionsuite -m encrypt -i example.txt or ```FED --mode encrypt -input_file example.txt```
```
in this case the output file will be 'example.txt.encrypted'
2. Example command 2:
```shell
Encryptionsuite -m decrypt -i example.txt.encrypted -k xxxx where xxxx is the encryption key used
```
2. Example command 3 using key file inplace of the key itself:
```shell
Encryptionsuite -m decrypt -i example.txt.encrypted -k file where file is the file containing the key
```
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
## License
This project is an open source software.
Feel free to modify and customize this template according to your specific project requirements and add any additional sections or information that you think would be helpful for users.
Raw data
{
"_id": null,
"home_page": null,
"name": "Encryptionsuite",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "Encryptionsuite, FED, File-encryptor, File-decryptor, encrypt-files, decrypt-files, encrypt, decrypt, cryptography",
"author": "Wambua aka skye-cyber",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/76/22/5a3f15aeaa245f7b97d66f8e24b7437d1663d57d536cb74311287641a47b/Encryptionsuite-1.0.1.tar.gz",
"platform": null,
"description": "# Encryptionsuite (File Encryption and Decryption)\nThis is a CLI tool for encrypting and decrypting files and folders.\nBe carefull on how you use, irresponsible use can lead user to turning their data into chunks\nif encryption keys are miss-handled.\nFor every encrypte file an Encryption key used is save in filename.xml file\nwhere filename is name of the input file to be encrypted.\n\n## Installation\n\n1. Install via pip:\n\n ```shell\n pip install Encryptionsuite\n ```\n2. Install from github:\n\n ```shell\n pip install git+https://github.com/skye-cyber/Encryptionsuite.git\n ```\n\n\n## Usage\n\nTo run the CLI app, use the following command:\n\n ```shell\n Encryptionsuite [options]\n ```\n\nReplace `[options]` with the appropriate command-line options based on the functionality you want to execute.\n\n## Available Options\n`1`.``-m/--mode`` operation to be performed(encryption or Decryption) value ```[encrypt, decrypt]```\n\n`2`.``-i/--input_file``\n\n`3`.``-k/--key`` only when decrypting\n\n## Examples\n\n1. Example command 1:\n\n ```shell\n Encryptionsuite -m encrypt -i example.txt or ```FED --mode encrypt -input_file example.txt```\n ```\nin this case the output file will be 'example.txt.encrypted'\n\n2. Example command 2:\n ```shell\n Encryptionsuite -m decrypt -i example.txt.encrypted -k xxxx where xxxx is the encryption key used\n ```\n2. Example command 3 using key file inplace of the key itself:\n ```shell\n Encryptionsuite -m decrypt -i example.txt.encrypted -k file where file is the file containing the key\n ```\n\n## Contributing\n\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n## License\n\nThis project is an open source software.\n\n\nFeel free to modify and customize this template according to your specific project requirements and add any additional sections or information that you think would be helpful for users.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"encryptionsuite",
" fed",
" file-encryptor",
" file-decryptor",
" encrypt-files",
" decrypt-files",
" encrypt",
" decrypt",
" cryptography"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f9eb861864af96a08286da3bcf9233c2b9c254a35dcfc6ac59e319a2a6e1e0c",
"md5": "0d64244758933c65a275c5c29663474e",
"sha256": "740f9ff400648f55926f93c582ca65b69c280aef78beaa7e70dc7ac92e6d54c4"
},
"downloads": -1,
"filename": "Encryptionsuite-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d64244758933c65a275c5c29663474e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 30424,
"upload_time": "2024-04-21T20:27:26",
"upload_time_iso_8601": "2024-04-21T20:27:26.398679Z",
"url": "https://files.pythonhosted.org/packages/3f/9e/b861864af96a08286da3bcf9233c2b9c254a35dcfc6ac59e319a2a6e1e0c/Encryptionsuite-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76225a3f15aeaa245f7b97d66f8e24b7437d1663d57d536cb74311287641a47b",
"md5": "9915a367e3a5b3938d33a1a33a19f79f",
"sha256": "751de3b6df89c6054dd620ac8d346ec2686595bd2de25e50827dea85591445d6"
},
"downloads": -1,
"filename": "Encryptionsuite-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9915a367e3a5b3938d33a1a33a19f79f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 60092,
"upload_time": "2024-04-21T20:27:29",
"upload_time_iso_8601": "2024-04-21T20:27:29.900835Z",
"url": "https://files.pythonhosted.org/packages/76/22/5a3f15aeaa245f7b97d66f8e24b7437d1663d57d536cb74311287641a47b/Encryptionsuite-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 20:27:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "encryptionsuite"
}
JSON