[feat] add basic template

hopre/__init__.py

@@ -0,0 +1 @@
+"""HoPRe is a software for detecting puns that utilize homophones."""

hopre/core.py

@@ -0,0 +1,22 @@
+"""User interface for HoPRe"""
+
+
+import sys
+import os
+
+
+def hopre() -> None:
+    """The main HoPRe (Homophone-based Pun Recognition) function."""
+    while True:
+        user_input: str = input("Please enter a sentence:\n")
+        if user_input == "Goodbye.":
+            print("It was a good run! Goodbye.")
+            sys.exit()
+
+        print(f"\nHere's the sentence you provided:\n{user_input}")
+        input("Press enter to continue...")
+        os.system("clear")
+
+
+if __name__ == "__main__":
+    hopre()

setup.py

@@ -0,0 +1,14 @@
+"""Installation procedure for HoPRe"""
+
+
+from setuptools import setup, find_packages
+
+
+setup(
+    name="hopre-requirements",
+    version="0.1.0",
+    description="Required Python packages for HoPRe",
+    author="Heewon Lee",
+    author_email="pingpingy@kaist.ac.kr",
+    packages=find_packages(include=["hopre"]),
+)