https://github.com/siddhesh-agarwal/cryptmoji

A simple emoji-based encryption-decryption library.
https://github.com/siddhesh-agarwal/cryptmoji

caesar-cipher emoji encryption encryption-decryption python python-library python3

Last synced: about 18 hours ago
JSON representation

A simple emoji-based encryption-decryption library.

• Host: GitHub
• URL: https://github.com/siddhesh-agarwal/cryptmoji
• Owner: Siddhesh-Agarwal
• License: mit
• Created: 2022-09-04T12:10:25.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-15T16:25:05.000Z (8 months ago)
• Last Synced: 2024-12-06T15:18:09.295Z (about 1 month ago)
• Topics: caesar-cipher, emoji, encryption, encryption-decryption, python, python-library, python3
• Language: Python
• Homepage: https://github.com/Siddhesh-Agarwal/cryptmoji/wiki/
• Size: 65.4 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🥷 Cryptmoji

A simple emoji-based encryption-decryption library.

![Downloads](https://static.pepy.tech/personalized-badge/cryptmoji?period=total&units=international_system&left_color=grey&right_color=green&left_text=Downloads)

_______________________

## 📥 Installation

You can use the [pip](https://pypi.org/project/pip/) package manager to install the library.

```sh

pip install cryptmoji

```

or use [poetry](https://python-poetry.org/):

```sh

poetry add cryptmoji

```

> Check the [Documentation](https://siddhesh-agarwal.github.io/cryptmoji/)

## 📝 Usage

```python

from cryptmoji import encrypt, decrypt

text = "Hello, world!"

key = "random_key" # makes the encryption stronger (optional)

# The encrypt and decrypt functions return the value

decrypted = decrypt(encrypted, key=key)

print(decrypted)

# '🎽🏉🏭🏣🏴🎐🍵🐀🏧🐉🏴🏈🎆'

# The encrypt and decrypt functions change the value in-place too

decrypted = decrypt(encrypted, key=key)

print(decrypted)

# 'Hello, world!'

```

## Command line tool

### Usage

```sh

$ cryptmoji encrypt "Hello World" --key "test"

🎿🏑🏸🏹🐁🍻🏑🐁🐄🏤🏪

$ cryptmoji decrypt "🎿🏑🏸🏹🐁🍻🏑🐁🐄🏤🏪" --key "test"

Hello World

```

> **NOTE**: key is an optional parameter. If not provided, the value defaults to `None`.