Version2 april24

.env.sample

@@ -0,0 +1,84 @@
+# =============================================================================
+# Automated Options Recommendation Bot
+# Institutional Environment Configuration Template
+# Copy this file to ".env" and populate secrets before runtime.
+# =============================================================================
+
+# -----------------------------------------------------------------------------
+# I. External Data Provider Credentials
+# -----------------------------------------------------------------------------
+FRED_API_KEY=your_fred_api_key_here
+SEC_USER_AGENT=YourName YourOrg your_email@example.com
+
+# -----------------------------------------------------------------------------
+# II. Vector Infrastructure (Qdrant)
+# -----------------------------------------------------------------------------
+QDRANT_HOST=https://your-qdrant-endpoint.example.com
+QDRANT_API_KEY=your_qdrant_api_key_here
+
+# -----------------------------------------------------------------------------
+# III. Core Inference Runtime (Ollama)
+# -----------------------------------------------------------------------------
+# Use one of OLLAMA_BASE_URL or OLLAMA_HOST according to your runtime scripts.
+OLLAMA_BASE_URL=http://localhost:11434
+OLLAMA_HOST=http://localhost:11434
+OLLAMA_KEEP_ALIVE=30m
+
+# Expert and router tier model routing.
+OLLAMA_CUSTOM_MODEL_NAME=options-expert-v1:latest
+OLLAMA_ROUTER_MODEL=llama3:latest
+OLLAMA_INGESTION_MODEL=llama3:latest
+
+# Optional per-role overrides.
+OLLAMA_ANALYST_MODEL=options-expert-v1:latest
+OLLAMA_CHECKER_MODEL=options-expert-v1:latest
+OLLAMA_CRITIC_MODEL=options-expert-v1:latest
+OLLAMA_FINALIZER_MODEL=options-expert-v1:latest
+OLLAMA_FINALIZER_ENRICHMENT_MODEL=llama3:latest
+
+# -----------------------------------------------------------------------------
+# IV. Retrieval and Embedding Controls
+# -----------------------------------------------------------------------------
+EMBEDDING_PROVIDER=huggingface
+EMBEDDING_MODEL_NAME=BAAI/bge-large-en-v1.5
+EMBEDDING_DEVICE=cpu
+RETRIEVER_DEVICE=cpu
+FASTEMBED_THREADS=4
+SPARSE_MODEL_NAME=prithivida/Splade_PP_en_v1
+RERANKER_MODEL_NAME=BAAI/bge-reranker-v2-m3
+DATA_LAKE_ROOT=./Data
+
+# -----------------------------------------------------------------------------
+# V. Agent Risk and Governance Controls
+# -----------------------------------------------------------------------------
+AGENT_MAX_REVISIONS=3
+CHECKER_NUMERIC_TOLERANCE=0.02
+CHECKER_TOOL_RECOVERY=1
+CHECKER_MACRO_EXEMPT_ENABLED=1
+CHECKER_COVERAGE_CHECK_ENABLED=1
+INSIDER_SIGNAL_MIN_COUNT=3
+
+# Optional analyst/finalizer tuning.
+ANALYST_TEMPERATURE=0.1
+CRITIC_TEMPERATURE=0.0
+FINALIZER_TEMPERATURE=0.0
+FINALIZER_LLAMA3_ENRICHMENT=0
+
+# -----------------------------------------------------------------------------
+# VI. Routing and Performance Controls
+# -----------------------------------------------------------------------------
+ROUTER_TEMPERATURE=0.0
+GOLD_TIMEOUT=10.0
+SILVER_TIMEOUT=10.0
+SILVER_MAX_TICKERS=5
+HE_NOVEL_TICKERS_CAP=3
+TICKER_EXPLOSION_CAP=8
+TICKER_EXPLOSION_KEEP=5
+
+# -----------------------------------------------------------------------------
+# VII. Optional Runtime and Cache Controls
+# -----------------------------------------------------------------------------
+PYTHON_ENV=dev
+YFINANCE_CACHE_DIR=
+XDG_CACHE_HOME=
+TMPDIR=

.gitignore

@@ -1,30 +1,207 @@
-# Python cache and virtual environments
+# Byte-compiled / optimized / DLL files
 __pycache__/
-*.pyc
-.venv/
-venv/
+*.py[codz]
+*$py.class
 
-# Large model files
-# Assuming Ollama stores models in a default or custom directory
-.ollama/
-models/
-options-expert
+# C extensions
+*.so
 
-# Environment variables and secrets
-.env
-*.env
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
 
-# Data and Logs
-data/
-logs/
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
 *.log
-Youtube_channel_ID
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
 
-# IDE and OS-specific files
-.idea/
-.vscode/
-.DS_Store
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
 
-# Qdrant data and monitoring folders
-qdrant_storage/
-monitoring/
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/