# Cryptodo
Cryptodo is a Python library for text encryption and decryption. It provides various encryption methods such as Caesar cipher, substitution cipher, rail fence cipher, and more. This library is designed to be easy to use and can be integrated into your Python projects for secure data handling.
## Installation
You can install Cryptodo using pip:
```bash
pip install cryptodo
```
## Usage
### Crypto Class
The `Crypto` class provides methods for basic text encryption and decryption.
```python
from cryptodo import Crypto
# Encryption
cipher = Crypto("Hello World!", 3)
encrypted_text = cipher.encrypt() # Returns encrypted text
# Decryption
decipher = Crypto(encrypted_text, 3)
decrypted_text = decipher.decrypt() # Returns decrypted text
```
### KeyGenerator Class
The `KeyGenerator` class offers methods to generate cryptographic keys.
```python
from cryptodo import KeyGenerator
# Generate a key (Example)
key = KeyGenerator.key_generator_num_v1(1, 10) # Returns a random key
```
### CryptoV2 Class
The `CryptoV2` class introduces more advanced encryption techniques.
```python
from cryptodo import CryptoV2
# Encryption
cipher = CryptoV2("Hello World!", "key")
encrypted_text = cipher.encrypt() # Returns encrypted text
# Decryption
decipher = CryptoV2(encrypted_text, "key")
decrypted_text = decipher.decrypt() # Returns decrypted text
```
### CryptoV3Num Class
The `CryptoV3Num` class specializes in numeric encryption and decryption.
```python
from cryptodo import CryptoV3Num
# Encryption
cipher = CryptoV3Num(123456, 5)
encrypted_number = cipher.encrypt() # Returns encrypted number
# Decryption
decipher = CryptoV3Num(encrypted_number, 5)
decrypted_number = decipher.decrypt() # Returns decrypted number
```
### KeyVariable Class
The `KeyVariable` class provides predefined character sets for key generation.
```python
from cryptodo import KeyVariable
all_characters = KeyVariable.key_var_all # Contains all alphanumeric and special characters
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ishanoshada/cryptodo",
"name": "cryptodo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "text encryption,text decryption,Caesar cipher,substitution cipher,rail fence cipher",
"author": "k.a.ishan oshada",
"author_email": "ic31908@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fa/b8/bf5cf1ac4149c9b1f3c065ad0d8e89a8f2f7cb321a46935a3586f602511b/cryptodo-3.3.tar.gz",
"platform": null,
"description": "# Cryptodo\n\nCryptodo is a Python library for text encryption and decryption. It provides various encryption methods such as Caesar cipher, substitution cipher, rail fence cipher, and more. This library is designed to be easy to use and can be integrated into your Python projects for secure data handling.\n\n## Installation\n\nYou can install Cryptodo using pip:\n\n```bash\npip install cryptodo\n```\n\n## Usage\n\n### Crypto Class\n\nThe `Crypto` class provides methods for basic text encryption and decryption.\n\n```python\nfrom cryptodo import Crypto\n\n# Encryption\ncipher = Crypto(\"Hello World!\", 3)\nencrypted_text = cipher.encrypt() # Returns encrypted text\n\n# Decryption\ndecipher = Crypto(encrypted_text, 3)\ndecrypted_text = decipher.decrypt() # Returns decrypted text\n```\n\n### KeyGenerator Class\n\nThe `KeyGenerator` class offers methods to generate cryptographic keys.\n\n```python\nfrom cryptodo import KeyGenerator\n\n# Generate a key (Example)\nkey = KeyGenerator.key_generator_num_v1(1, 10) # Returns a random key\n```\n\n### CryptoV2 Class\n\nThe `CryptoV2` class introduces more advanced encryption techniques.\n\n```python\nfrom cryptodo import CryptoV2\n\n# Encryption\ncipher = CryptoV2(\"Hello World!\", \"key\")\nencrypted_text = cipher.encrypt() # Returns encrypted text\n\n# Decryption\ndecipher = CryptoV2(encrypted_text, \"key\")\ndecrypted_text = decipher.decrypt() # Returns decrypted text\n```\n\n### CryptoV3Num Class\n\nThe `CryptoV3Num` class specializes in numeric encryption and decryption.\n\n```python\nfrom cryptodo import CryptoV3Num\n\n# Encryption\ncipher = CryptoV3Num(123456, 5)\nencrypted_number = cipher.encrypt() # Returns encrypted number\n\n# Decryption\ndecipher = CryptoV3Num(encrypted_number, 5)\ndecrypted_number = decipher.decrypt() # Returns decrypted number\n```\n\n### KeyVariable Class\n\nThe `KeyVariable` class provides predefined character sets for key generation.\n\n```python\nfrom cryptodo import KeyVariable\n\nall_characters = KeyVariable.key_var_all # Contains all alphanumeric and special characters\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.",
"bugtrack_url": null,
"license": "",
"summary": "A Python library for text encryption and decryption",
"version": "3.3",
"project_urls": {
"Homepage": "https://github.com/ishanoshada/cryptodo"
},
"split_keywords": [
"text encryption",
"text decryption",
"caesar cipher",
"substitution cipher",
"rail fence cipher"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fab8bf5cf1ac4149c9b1f3c065ad0d8e89a8f2f7cb321a46935a3586f602511b",
"md5": "bc89daf2dc77747acaf9baaf5bae2078",
"sha256": "a2f2ddcb1feb35d9bea264e79629e7c7c080b50627139e9b54b8496a8e8f5c2f"
},
"downloads": -1,
"filename": "cryptodo-3.3.tar.gz",
"has_sig": false,
"md5_digest": "bc89daf2dc77747acaf9baaf5bae2078",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4835,
"upload_time": "2023-10-22T16:39:35",
"upload_time_iso_8601": "2023-10-22T16:39:35.178363Z",
"url": "https://files.pythonhosted.org/packages/fa/b8/bf5cf1ac4149c9b1f3c065ad0d8e89a8f2f7cb321a46935a3586f602511b/cryptodo-3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-22 16:39:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ishanoshada",
"github_project": "cryptodo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cryptodo"
}
JSON
