Skip to content

Add config requirements and environment variables (and fix broken links!) #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 26, 2025

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jun 25, 2025

  • Sync all config requirements with updated requirements.txt
  • Add environment variable placeholders to all config files for cloud orchestrator compatibility
  • Update README with cloud deployment guidance
  • Fix broken links

Changes

  • Requirements sync: Updated all 6 config files to match requirements.txt (removed openai, added zenml, exa-py, requests, anthropic, litellm, langfuse)
  • Environment variables: Added docker environment settings to all configs with placeholders for API keys (OPENROUTER_API_KEY, TAVILY_API_KEY, EXA_API_KEY, ANTHROPIC_API_KEY, Langfuse credentials)
  • Documentation: Added cloud orchestrator configuration section to README explaining how to replace placeholder values and security recommendations

strickvl and others added 2 commits June 25, 2025 16:57
Remove openai dependency and add missing dependencies (zenml, exa-py, requests, anthropic) to match the updated requirements.txt file across all config files.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Add docker environment variable placeholders to all config files for OPENROUTER_API_KEY, TAVILY_API_KEY, EXA_API_KEY, ANTHROPIC_API_KEY, and Langfuse credentials
- Add cloud orchestrator configuration section to README explaining how to replace placeholder values with actual API keys for cloud deployments
- Include security recommendation to use cloud provider secret management services

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link

dagshub bot commented Jun 25, 2025

@strickvl strickvl requested a review from Copilot June 25, 2025 15:06
@strickvl strickvl added enhancement New feature or request internal labels Jun 25, 2025
@strickvl strickvl requested a review from htahir1 June 25, 2025 15:06
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR synchronizes the configuration files with the updated requirements.txt and adds environment variable placeholders to support cloud orchestrator deployments, while updating the README documentation accordingly.

  • Updated dependency lists in all config files by removing openai and adding zenml, exa-py, requests, anthropic, litellm, and langfuse.
  • Introduced environment variable placeholders in each config file for API keys relevant to cloud deployments.
  • Expanded the README with a new cloud orchestrator configuration section and security recommendations.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
deep_research/configs/rapid_research.yaml Updated dependency list and added environment variables.
deep_research/configs/quick_research.yaml Updated dependency list and added environment variables.
deep_research/configs/enhanced_research_with_approval.yaml Updated dependency list and added environment variables.
deep_research/configs/enhanced_research.yaml Updated dependency list and added environment variables.
deep_research/configs/deep_research.yaml Updated dependency list and added environment variables.
deep_research/configs/balanced_research.yaml Updated dependency list (including formatting change) and added environment variables.
deep_research/README.md Added cloud orchestrator configuration documentation.

@strickvl strickvl changed the title Add config requirements and environment variables Add config requirements and environment variables (and fix broken links!) Jun 25, 2025
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love that u took the time to update the links

strickvl and others added 2 commits June 26, 2025 09:25
…titution

- Update all config files to use ${VARIABLE_NAME} syntax instead of "YOUR_VARIABLE_NAME" placeholders
- Update README to reflect automatic environment variable pickup
- Users no longer need to manually edit config files for cloud deployment

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
ZenML is the orchestration framework already running the pipeline,
so it doesn't need to be installed as a dependency inside Docker containers.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@strickvl strickvl requested a review from htahir1 June 26, 2025 07:28
@strickvl strickvl merged commit 7d827b9 into main Jun 26, 2025
5 checks passed
@strickvl strickvl deleted the misc/add-config-requirements-env-vars branch June 26, 2025 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants