Merge pull request #2 from Siddhesh-Agarwal/cli

added CLI Tool

README.md

@@ -7,13 +7,19 @@ _______________________
 
 ## 📥 Installation
 
-pip install the library:
+You can use the [pip](https://pypi.org/project/pip/) package manager to install the library.
 
 ```sh
 pip install cryptmoji
 ```
 
-Check the [Documentation](https://siddhesh-agarwal.github.io/cryptmoji/)
+or use [poetry](https://python-poetry.org/):
+
+```sh
+poetry add cryptmoji
+```
+
+> Check the [Documentation](https://siddhesh-agarwal.github.io/cryptmoji/)
 
 ## 📝 Usage
 
@@ -34,3 +40,22 @@ print(decrypted)
 # 'Hello, world!'
 ```
 
+## Command line tool
+
+### Installation
+
+```sh
+pip install cryptmoji[cli]
+```
+
+### Usage
+
+```sh
+$ cryptmoji encrypt "Hello World"
+Key (optional):
+🎿🏑🏸🏹🐁🍻🏑🐁🐄🏤🏪
+
+$ cryptmoji decrypt "🎿🏑🏸🏹🐁🍻🏑🐁🐄🏤🏪"
+Key (optional):
+Hello World
+```

cryptmoji/cli.py

@@ -0,0 +1,32 @@
+from rich.console import Console
+from typer import Typer
+
+from cryptmoji.main import decrypt, encrypt
+
+app = Typer()
+console = Console()
+
+
+@app.command("encrypt")
+def cli_encrypt(text: str):
+    """Encrypts a string as a string of emojis."""
+    key = console.input(
+        "Key (optional): ",
+        markup=False,
+        emoji=False,
+        password=True,
+    )
+
+    console.print(encrypt(text, key=key if key else None))
+
+
+@app.command("decrypt")
+def cli_decrypt(text: str):
+    """Decrypts a string of emojis."""
+    key = console.input(
+        "Key (optional): ",
+        markup=False,
+        emoji=False,
+        password=True,
+    )
+    console.print(decrypt(text, key=key if key else None))

docs/index.md

@@ -6,12 +6,18 @@ _______________________
 
 ## 📥 Installation
 
-pip install the library:
+You can use the [pip](https://pypi.org/project/pip/) package manager to install the library.
 
-```bash
+```sh
 pip install cryptmoji
 ```
 
+or use [poetry](https://python-poetry.org/):
+
+```sh
+poetry add cryptmoji
+```
+
 _______________________
 
 ## 📝 Usage
@@ -86,3 +92,31 @@ decrypted = decrypt(encrypted, key=key)
 print(decrypted)
 # Hello, world!
 ```
+
+_______________________
+
+## Command line tool
+
+### Installation
+
+```sh
+pip install cryptmoji[cli]
+```
+
+### Usage
+
+To encrypt:
+
+```sh
+$ cryptmoji encrypt "Hello World"
+Key (optional):
+🌾🍛🍢🍢🍥🌕🌉🍭🍥🍨🍢🍚🌊
+```
+
+To decrypt:
+
+```sh
+$ cryptmoji decrypt "🌾🍛🍢🍢🍥🌕🌉🍭🍥🍨🍢🍚🌊"
+Key (optional):
+Hello World
+```

pyproject.toml

@@ -16,7 +16,6 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
@@ -31,8 +30,15 @@ classifiers = [
     "Typing :: Typed",
 ]
 
+[tool.poetry.scripts]
+cryptmoji = "cryptmoji.cli:app"
+
 [tool.poetry.dependencies]
-python = "^3.6"
+python = ">=3.7.0,<4.0"
+
+[tool.poetry.group.cli.dependencies]
+typer = {extras = ["all"], version = "^0.12.3"}
+rich = "^13.7.1"
 
 [build-system]
 requires = ["poetry-core>=2.0.0"]