Metadata-Version: 2.1
Name: simplecipher
Version: 0.2.2
Summary: A simple cipher
Home-page: https://github.com/nightowlish/simplecipher
Author: nightowlish
Author-email: oanaolf@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# SimpleCipher
A simple cipher.

## Install

```
python3 -m pip install simplecipher
```

## Dependencies

In terms of dependencies, there are no dependencies.

## Usage

Supported ciphers:
* Caesar cipher
* Vigenere cipher
* Custom cipher

Example:

```python
from simplecipher import simplecipher as sc

message = 'Hello, World!'

offset = 10
encrypted_message = sc.CaesarCipher.encrypt(message, offset=offset)
decrypted_message = sc.CaesarCipher.decrypt(encrypted_message, offset=offset)

key = 'vigenere_key'
encrypted_message = sc.VigenereCipher.encrypt(message, key=key)
decrypted_message = sc.VigenereCipher.decrypt(encrypted_message, key=key)

cipher = sc.SimpleCipher()
replacement = '?' # replacement for unsupported characters
encrypted_message = cipher.encrypt(message, replacement=replacement)
decrypted_message = cipher.decrypt(encrypted_message)
```

