# EnigmaCipher
A Python package that simulates the encryption and decryption mechanisms of an Enigma machine with PIN protection.
## Capabilities
* Utilize the shuffle command to introduce new rotors
* Securely encrypt and decrypt messages with a PIN-based system
## Installation
To install EnigmaCipher, simply run:
```bash
pip install enigmacifra
```
Verify the installation by checking the version:
```bash
$ enigma --version
```
## Usage
The EnigmaCipher package can be used via the command line.
### Command Line
To shuffle rotors:
```bash
$ enigma shuffle
```
To encrypt a message:
```bash
$ enigma encrypt
```
To decrypt a message:
```bash
$ enigma decrypt
```
## Development
To contribute to EnigmaCipher, clone the repository and make sure to install the development dependencies.
```bash
git clone https://github.com/1darshanpatil/enigmacipher
cd enigmacipher
pip install -e .
```
## Support
If you encounter any problems or have suggestions, please file an issue on the [GitHub issue tracker](https://github.com/1darshanpatil/enigmacipher/issues).
## License
The project is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/1darshanpatil/enigmacipher",
"name": "enigmacifra",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "enigma,cipher,encryption",
"author": "Darshan P.",
"author_email": "drshnp@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/a8/bc/0ce5659d8c6a9c0ab94830bfcb60bd8460a47a3590b9b00b7e727f1b9113/enigmacifra-0.2.0.tar.gz",
"platform": null,
"description": "\r\n\r\n\r\n# EnigmaCipher\r\n\r\nA Python package that simulates the encryption and decryption mechanisms of an Enigma machine with PIN protection.\r\n\r\n## Capabilities\r\n * Utilize the shuffle command to introduce new rotors\r\n * Securely encrypt and decrypt messages with a PIN-based system\r\n\r\n## Installation\r\n\r\nTo install EnigmaCipher, simply run:\r\n\r\n```bash\r\npip install enigmacifra\r\n```\r\n\r\nVerify the installation by checking the version: \r\n\r\n```bash\r\n$ enigma --version\r\n```\r\n\r\n## Usage\r\n\r\nThe EnigmaCipher package can be used via the command line.\r\n\r\n### Command Line\r\n\r\nTo shuffle rotors:\r\n\r\n```bash\r\n$ enigma shuffle\r\n```\r\n\r\nTo encrypt a message:\r\n\r\n```bash\r\n$ enigma encrypt\r\n```\r\n\r\nTo decrypt a message:\r\n \r\n```bash\r\n$ enigma decrypt\r\n```\r\n\r\n\r\n\r\n## Development\r\n\r\nTo contribute to EnigmaCipher, clone the repository and make sure to install the development dependencies.\r\n\r\n```bash\r\ngit clone https://github.com/1darshanpatil/enigmacipher\r\ncd enigmacipher\r\npip install -e .\r\n```\r\n\r\n## Support\r\n\r\nIf you encounter any problems or have suggestions, please file an issue on the [GitHub issue tracker](https://github.com/1darshanpatil/enigmacipher/issues).\r\n\r\n## License\r\n\r\nThe project is licensed under the MIT license.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PIN encrypted enigma machine cipher texts",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/1darshanpatil/enigmacipher#readme",
"Homepage": "https://github.com/1darshanpatil/enigmacipher",
"Source": "https://github.com/1darshanpatil/enigmacipher",
"Tracker": "https://github.com/1darshanpatil/enigmacipher/issues"
},
"split_keywords": [
"enigma",
"cipher",
"encryption"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51cad283e3e43f11c8c1619e0fa87cc7182ce6d5929cb666e0296a42f1c81c01",
"md5": "1566b2bfacd3f055fd9483567a6446e8",
"sha256": "9ecd36aedbc2eef543f39d49a9374b3325187dce6bc59d63914ffc071abba969"
},
"downloads": -1,
"filename": "enigmacifra-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1566b2bfacd3f055fd9483567a6446e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9309,
"upload_time": "2023-12-06T19:35:32",
"upload_time_iso_8601": "2023-12-06T19:35:32.835967Z",
"url": "https://files.pythonhosted.org/packages/51/ca/d283e3e43f11c8c1619e0fa87cc7182ce6d5929cb666e0296a42f1c81c01/enigmacifra-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8bc0ce5659d8c6a9c0ab94830bfcb60bd8460a47a3590b9b00b7e727f1b9113",
"md5": "9b0fb38dfdee4de3c3c93fa51867fffa",
"sha256": "de86607d2db71428d3d470f81dd9dde1ad2e98b6edefc455b57849212b449819"
},
"downloads": -1,
"filename": "enigmacifra-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9b0fb38dfdee4de3c3c93fa51867fffa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9234,
"upload_time": "2023-12-06T19:35:35",
"upload_time_iso_8601": "2023-12-06T19:35:35.405807Z",
"url": "https://files.pythonhosted.org/packages/a8/bc/0ce5659d8c6a9c0ab94830bfcb60bd8460a47a3590b9b00b7e727f1b9113/enigmacifra-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 19:35:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "1darshanpatil",
"github_project": "enigmacipher",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "enigmacifra"
}
JSON
