Metadata-Version: 2.1
Name: encipherpy
Version: 2.2.0
Summary: A package containing the implementation of multiple ciphers.
Project-URL: Homepage, https://github.com/lightman210567/Encipher-python
Project-URL: Bug tracker, https://github.com/lightman210567/Encipher-python/issues
Author-email: lightman210567 <81330314+lightman210567@users.noreply.github.com>
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# Encipherpy

Encipherpy is a python package that contains the implementations of multiple ciphers.

## Supported ciphers

| Cipher              | Import code                                                     | Arguments                                          |
| ------------------- | --------------------------------------------------------------- | -------------------------------------------------- |
| Caesar              | `from encipherpy.caesar_cipher import caesarCipher`             | str`plainText`, int`key`, bool`encrypt`            |
| Vigènere            | `from encipherpy.vigenere_cipher import vigenereCipher`         | str`plainText`, str`key`, bool`encrypt`            |
| Rot47               | `from encipherpy.rot47_cipher import rot47`                     | str`plainText`                                     |
| Atbash              | `from encipherpy.atbash_cipher import atbashCipher`             | str`plainText`                                     |
| Simple substitution | `from encipherpy.substitution_cipher import substitutionCipher` | str`plainText`, str`cipherAlphabet`, bool`encrypt` |
| Polybus square      | `from encipherpy.polybus_square_cipher import polybusSquare`    | str`plainText`, bool`encrypt`                      |
