# 🥷 Cryptmoji
A simple emoji-based encryption-decryption library.
_______________________
## 📥 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`.
Raw data
{
"_id": null,
"home_page": "https://github.com/Siddhesh-Agarwal/cryptmoji",
"name": "cryptmoji",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7.0",
"maintainer_email": null,
"keywords": "encryption, emoji, cipher, cryptography, cryptmoji",
"author": "Siddhesh Agarwal",
"author_email": "siddhesh.agarwal@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/11/c6/739b38a5e5e33dbf73fdd28efb8eb0317f650ba44db6c1a7f9ca4783f9d2/cryptmoji-2.1.2.tar.gz",
"platform": null,
"description": "# \ud83e\udd77 Cryptmoji\n\nA simple emoji-based encryption-decryption library.\n\n\n_______________________\n\n## \ud83d\udce5 Installation\n\nYou can use the [pip](https://pypi.org/project/pip/) package manager to install the library.\n\n```sh\npip install cryptmoji\n```\n\nor use [poetry](https://python-poetry.org/):\n\n```sh\npoetry add cryptmoji\n```\n\n> Check the [Documentation](https://siddhesh-agarwal.github.io/cryptmoji/)\n\n## \ud83d\udcdd Usage\n\n```python\nfrom cryptmoji import encrypt, decrypt\n\ntext = \"Hello, world!\"\nkey = \"random_key\" # makes the encryption stronger (optional)\n\n# The encrypt and decrypt functions return the value\ndecrypted = decrypt(encrypted, key=key)\nprint(decrypted)\n# '\ud83c\udfbd\ud83c\udfc9\ud83c\udfed\ud83c\udfe3\ud83c\udff4\ud83c\udf90\ud83c\udf75\ud83d\udc00\ud83c\udfe7\ud83d\udc09\ud83c\udff4\ud83c\udfc8\ud83c\udf86'\n\n# The encrypt and decrypt functions change the value in-place too\ndecrypted = decrypt(encrypted, key=key)\nprint(decrypted)\n# 'Hello, world!'\n```\n\n## Command line tool\n\n### Usage\n\n```sh\n$ cryptmoji encrypt \"Hello World\" --key \"test\"\n\ud83c\udfbf\ud83c\udfd1\ud83c\udff8\ud83c\udff9\ud83d\udc01\ud83c\udf7b\ud83c\udfd1\ud83d\udc01\ud83d\udc04\ud83c\udfe4\ud83c\udfea\n\n$ cryptmoji decrypt \"\ud83c\udfbf\ud83c\udfd1\ud83c\udff8\ud83c\udff9\ud83d\udc01\ud83c\udf7b\ud83c\udfd1\ud83d\udc01\ud83d\udc04\ud83c\udfe4\ud83c\udfea\" --key \"test\"\nHello World\n```\n\n> **NOTE**: key is an optional parameter. If not provided, the value defaults to `None`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Encrypt Text using emojis!",
"version": "2.1.2",
"project_urls": {
"Documentation": "https://github.com/Siddhesh-Agarwal/cryptmoji/wiki",
"Homepage": "https://github.com/Siddhesh-Agarwal/cryptmoji",
"Repository": "https://github.com/Siddhesh-Agarwal/cryptmoji"
},
"split_keywords": [
"encryption",
" emoji",
" cipher",
" cryptography",
" cryptmoji"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c68ee1951699e8644ba278ed68a071570a7f9a12f126a5f5442b9ca06d30db2",
"md5": "21969e957528d3fab997ab88e9ad9252",
"sha256": "340045f71c36aaf2558621492fccc9459134bf403d2235cf3b368c78a332a1bd"
},
"downloads": -1,
"filename": "cryptmoji-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21969e957528d3fab997ab88e9ad9252",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7.0",
"size": 7137,
"upload_time": "2024-05-15T16:19:47",
"upload_time_iso_8601": "2024-05-15T16:19:47.629790Z",
"url": "https://files.pythonhosted.org/packages/9c/68/ee1951699e8644ba278ed68a071570a7f9a12f126a5f5442b9ca06d30db2/cryptmoji-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "11c6739b38a5e5e33dbf73fdd28efb8eb0317f650ba44db6c1a7f9ca4783f9d2",
"md5": "e3b2b845c615d9fe32dd0f947b39bc7f",
"sha256": "abf9b41b9eb4b6fd5331d53bc087b7b5c7e6d849b058ded29dc875c84ea982e4"
},
"downloads": -1,
"filename": "cryptmoji-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e3b2b845c615d9fe32dd0f947b39bc7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7.0",
"size": 6749,
"upload_time": "2024-05-15T16:19:49",
"upload_time_iso_8601": "2024-05-15T16:19:49.220922Z",
"url": "https://files.pythonhosted.org/packages/11/c6/739b38a5e5e33dbf73fdd28efb8eb0317f650ba44db6c1a7f9ca4783f9d2/cryptmoji-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 16:19:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Siddhesh-Agarwal",
"github_project": "cryptmoji",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cryptmoji"
}
JSON
