Add local setup instructions for copying/pasting keys

Author: rohan436

LOCAL_SETUP.md

@@ -0,0 +1,63 @@
+# Local Setup (Copy/Paste Keys)
+
+When you `git clone` this repo, your API keys and passwords are **not** included.
+They live in:
+
+- Local runs: your local `.env` file (not committed; see `.gitignore`)
+- GitHub Actions: repo secrets (Settings -> Secrets and variables -> Actions)
+
+Important:
+
+- GitHub does **not** let you view secret values after you save them. Keep your keys in a password manager / notes so you can paste them again later.
+
+## 1) Clone
+
+```bash
+git clone https://github.com/Rohan5commit/tech_losers_bot.git
+cd tech_losers_bot
+```
+
+## 2) Create your `.env` file
+
+```bash
+cp .env.example .env
+```
+
+## 3) Paste your keys into `.env`
+
+Open `.env` in an editor:
+
+```bash
+# Terminal editor (simple)
+nano .env
+
+# OR macOS TextEdit
+open -e .env
+```
+
+Paste your values after the `=` signs. Example format (use your real values):
+
+```env
+FMP_API_KEY=PASTE_HERE
+SMTP_USER=PASTE_HERE
+SMTP_PASSWORD=PASTE_HERE
+GMAIL_SENDER=PASTE_HERE
+EMAIL_RECIPIENTS=PASTE_HERE
+```
+
+Notes:
+
+- You can paste multiple FMP keys as `FMP_API_KEY_2` ... `FMP_API_KEY_6`.
+- Optional AI summary uses `NVIDIA_API_KEY` + `NVIDIA_MODEL`.
+
+## 4) Install + run
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+
+python3 main.py --status
+python3 main.py --no-wait
+```
+

README.md

@@ -169,6 +169,7 @@ US Technology Losers <= -5% (Close-to-Close), mcap >= $1B — YYYY-MM-DD
 ### Body Contents
 - Run timestamp with timezone
 - Summary counts:
+  - Total scanned
   - Candidates from losers feed
   - After -5% filter
   - After sector + mcap filter

main.py

@@ -35,6 +35,19 @@
 from src.cache import ProfileCache
 
 
+def print_local_setup_help():
+    print("\nLocal setup (copy/paste your keys):")
+    print("  1) Create .env from template:")
+    print("     cp .env.example .env")
+    print("  2) Open .env and paste values after '=':")
+    print("     nano .env")
+    print("     # or on macOS")
+    print("     open -e .env")
+    print("  3) Re-run:")
+    print("     python3 main.py --status")
+    print("Docs: README.md and LOCAL_SETUP.md")
+
+
 def wait_for_network(check_interval: int = 300):
     """
     Wait for network connectivity, checking every 5 minutes until next day.
@@ -208,7 +221,8 @@ def main():
         print("Configuration errors:")
         for error in errors:
             print(f"  - {error}")
-        print("\nRun with --dry-run to test without email, or fix configuration.")
+        print_local_setup_help()
+        print("\nTip: use --dry-run to skip email sending (SMTP), but FMP_API_KEY is still required to scan.")
         return 1
 
     print(f"\n{'='*60}")
@@ -219,6 +233,7 @@ def main():
     if not FMP_API_KEY:
         print("\n[Error] FMP_API_KEY is required!")
         print("Get your free API key at: https://financialmodelingprep.com/developer/docs/")
+        print_local_setup_help()
         return 1
 
     # Initialize provider router

src/config.py

@@ -149,3 +149,10 @@ def print_config_status():
     if NVIDIA_MODEL:
         print(f"AI Model: {NVIDIA_MODEL}")
     print("=" * 50)
+
+    if not FMP_API_KEY:
+        print("\nNext steps (local):")
+        print("  cp .env.example .env")
+        print("  open -e .env   # or: nano .env")
+        print("  python3 main.py --status")
+        print("See: LOCAL_SETUP.md")