Setup basic CLI project with typer and all instructions

.gitignore

@@ -123,6 +123,8 @@ celerybeat.pid
 # SageMath parsed files
 *.sage.py
 
+.idea
+
 # Environments
 .env
 .venv

README.md

@@ -1,3 +1,18 @@
 # Yoda PA
 
 PyPi link: https://pypi.org/project/yodapa/
+
+## Development setup
+
+```bash
+# 1. Install poetry from their website: https://python-poetry.org/docs/#installation
+
+# 2. Install dependencies and this package
+poetry install
+
+# 3. Activate the virtual environment
+poetry shell
+
+# Now you should be able to communicate with yoda
+yoda --help
+```

pyproject.toml

@@ -5,6 +5,9 @@ description = "Personal Assistant on the command line"
 authors = ["Man Parvesh Singh Randhawa <[email protected]>"]
 license = "MIT"
 readme = "README.md"
+packages = [
+    { include = "yodapa", from = "src" }
+]
 
 [tool.poetry.dependencies]
 python = "^3.9"
@@ -17,3 +20,6 @@ pytest = "^8.3.3"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+yoda = "cli.yoda:app"

src/cli/yoda.py

@@ -0,0 +1,12 @@
+import typer
+from yodapa import hi
+
+app = typer.Typer()
+
+@app.command()
+def hello(name: str):
+    """Greet someone by name."""
+    typer.echo(hi.hu(name))
+
+if __name__ == "__main__":
+    app()

src/yodapa/hi.py

@@ -0,0 +1,2 @@
+def hu(s: str) -> str:
+    return f"Hellowww {s}"