cheat-cli 0.1.0__tar.gz → 0.1.2__tar.gz

cheat_cli-0.1.2/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include cheat_cli/data *.csv

{cheat_cli-0.1.0 → cheat_cli-0.1.2}/PKG-INFO

@@ -1,11 +1,9 @@
 Metadata-Version: 2.4
 Name: cheat-cli
-Version: 0.1.0
-Summary: A terminal-first cheat sheet CLI for Linux developers
-Author-email: RejishJ <rejish.j.d@gmail.com>
+Version: 0.1.2
+Summary: A terminal-first personal cheat sheet for Linux developers
+Author: Rejish
 License: MIT
-Project-URL: Homepage, https://github.com/RejishJ/cheat-cli
-Project-URL: Repository, https://github.com/RejishJ/cheat-cli
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE

{cheat_cli-0.1.0 → cheat_cli-0.1.2}/cheat_cli/cli.py

@@ -1,30 +1,69 @@
 #!/usr/bin/env python3
 
 import sys
+import shutil
+from pathlib import Path
+
 import pandas as pd
 from tabulate import tabulate
 from importlib.resources import files
 
-# ---------- Helpers ----------
+# ===============================
+# Paths & Data Handling
+# ===============================
+
+def user_data_path() -> Path:
+    """
+    Location for user-modifiable data.
+    """
+    return Path.home() / ".local" / "share" / "cheat-cli" / "commands.csv"
+
 
-def csv_path():
+def packaged_csv_path():
+    """
+    Read-only CSV shipped inside the package.
+    """
     return files("cheat_cli").joinpath("data/commands.csv")
 
-def load_df():
-    return pd.read_csv(csv_path())
 
-def save_df(df):
-    df.to_csv(csv_path(), index=False)
+def ensure_user_csv_exists() -> Path:
+    """
+    Ensure user CSV exists by copying from packaged CSV on first run.
+    """
+    path = user_data_path()
+    path.parent.mkdir(parents=True, exist_ok=True)
+
+    if not path.exists():
+        shutil.copy(packaged_csv_path(), path)
+
+    return path
+
 
-def print_table(df):
+def load_df() -> pd.DataFrame:
+    return pd.read_csv(ensure_user_csv_exists())
+
+
+def save_df(df: pd.DataFrame):
+    df.to_csv(user_data_path(), index=False)
+
+
+# ===============================
+# Output Helpers
+# ===============================
+
+def print_table(df: pd.DataFrame):
     if df.empty:
         print("\033[91mNo results found.\033[0m")
         return
+
     print(tabulate(df, headers="keys", tablefmt="fancy_grid", showindex=False))
 
-# ---------- Core Features ----------
 
-def search(df, term):
+# ===============================
+# Core Features
+# ===============================
+
+def search(df: pd.DataFrame, term: str):
     term = term.lower()
     mask = (
         df["tool"].str.lower().str.contains(term) |
@@ -34,8 +73,10 @@ def search(df, term):
     )
     print_table(df[mask])
 
-def add_interactive(df):
+
+def add_interactive(df: pd.DataFrame):
     print("\033[94mInteractive add mode\033[0m")
+
     tool = input("Tool: ").strip()
     command = input("Command: ").strip()
     description = input("Description: ").strip()
@@ -49,14 +90,17 @@ def add_interactive(df):
     save_df(df)
     print("\033[92m✅ Command added.\033[0m")
 
-def delete_command(df, query):
+
+def delete_command(df: pd.DataFrame, query: str):
     matches = df[df["command"].str.contains(query, case=False)]
+
     if matches.empty:
         print("\033[91mNo match found.\033[0m")
         return
 
     print_table(matches)
     confirm = input("Delete these entries? (yes/no): ").lower()
+
     if confirm != "yes":
         print("Cancelled.")
         return
@@ -65,23 +109,35 @@ def delete_command(df, query):
     save_df(df)
     print("\033[92m✅ Deleted.\033[0m")
 
-# ---------- Entry Point ----------
+
+# ===============================
+# Entry Point
+# ===============================
 
 def main():
     df = load_df()
 
     if len(sys.argv) < 2:
-        print("Usage: cheat <search> | cheat add | cheat delete <query>")
+        print("Usage:")
+        print("  cheat <search-term>")
+        print("  cheat add")
+        print("  cheat delete <query>")
         return
 
     cmd = sys.argv[1]
 
     if cmd == "add":
         add_interactive(df)
+
     elif cmd == "delete":
         if len(sys.argv) < 3:
             print("Usage: cheat delete <query>")
             return
         delete_command(df, sys.argv[2])
+
     else:
         search(df, cmd)
+
+
+if __name__ == "__main__":
+    main()

cheat_cli-0.1.2/cheat_cli/data/commands.csv

@@ -0,0 +1,2 @@
+tool,command,description,tags
+git,git status,Show current git working tree status,repo state branch

{cheat_cli-0.1.0 → cheat_cli-0.1.2}/cheat_cli.egg-info/PKG-INFO

@@ -1,11 +1,9 @@
 Metadata-Version: 2.4
 Name: cheat-cli
-Version: 0.1.0
-Summary: A terminal-first cheat sheet CLI for Linux developers
-Author-email: RejishJ <rejish.j.d@gmail.com>
+Version: 0.1.2
+Summary: A terminal-first personal cheat sheet for Linux developers
+Author: Rejish
 License: MIT
-Project-URL: Homepage, https://github.com/RejishJ/cheat-cli
-Project-URL: Repository, https://github.com/RejishJ/cheat-cli
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE

{cheat_cli-0.1.0 → cheat_cli-0.1.2}/cheat_cli.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+MANIFEST.in
 README.md
 pyproject.toml
 cheat_cli/__init__.py
@@ -8,4 +9,5 @@ cheat_cli.egg-info/SOURCES.txt
 cheat_cli.egg-info/dependency_links.txt
 cheat_cli.egg-info/entry_points.txt
 cheat_cli.egg-info/requires.txt
-cheat_cli.egg-info/top_level.txt
+cheat_cli.egg-info/top_level.txt
+cheat_cli/data/commands.csv

cheat_cli-0.1.2/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "cheat-cli"
+version = "0.1.2"
+description = "A terminal-first personal cheat sheet for Linux developers"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Rejish"}]
+dependencies = ["pandas", "tabulate"]
+requires-python = ">=3.8"
+
+[project.scripts]
+cheat = "cheat_cli.cli:main"
+
+[tool.setuptools]
+include-package-data = true

cheat_cli-0.1.0/pyproject.toml

@@ -1,25 +0,0 @@
-[build-system]
-requires = ["setuptools>=64", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "cheat-cli"
-version = "0.1.0"
-description = "A terminal-first cheat sheet CLI for Linux developers"
-readme = "README.md"
-requires-python = ">=3.8"
-license = { text = "MIT" }
-authors = [
-  { name = "RejishJ", email = "rejish.j.d@gmail.com" }
-]
-dependencies = [
-  "pandas",
-  "tabulate"
-]
-
-[project.urls]
-Homepage = "https://github.com/RejishJ/cheat-cli"
-Repository = "https://github.com/RejishJ/cheat-cli"
-
-[project.scripts]
-cheat = "cheat_cli.cli:main"