Skip to content

Restructuring the examples directory #144

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

andrew-lastmile
Copy link
Contributor

Proposed structure change:

 root/
  └── examples/
      ├── agent_patterns/
      │   ├── functions/
      │   ├── mcp_model_selector/
      │   └── mcp_server_aggregator/
      │
      ├── basic/
      │   ├── mcp_agent_server/
      │   ├── mcp_basic_agent/
      │   ├── mcp_hello_world/
      │   └── mcp_researcher/
      │
      ├── experimental/
      │   ├── decorator/
      │   └── mcp_root_test/
      │
      ├── interactive_demos/
      │   ├── marimo_mcp_basic_agent/
      │   ├── streamlit_mcp_basic_agent/
      │   └── streamlit_mcp_rag_agent/
      │
      ├── mcp/
      │   ├── mcp_basic_slack_agent/
      │   └── mcp_github_to_slack_agent/
      │
      ├── model_providers/
      │   ├── mcp_basic_azure_agent/
      │   ├── mcp_basic_bedrock_agent/
      │   ├── mcp_basic_google_agent/
      │   └── mcp_basic_ollama_agent/
      │
      ├── streaming/
      │   ├── mcp_sse/
      │   ├── mcp_sse_with_headers/
      │   └── mcp_websockets/
      │
      └── workflows/
          ├── workflow_evaluator_optimizer/
          ├── workflow_orchestrator_worker/
          ├── workflow_parallel/
          ├── workflow_router/
          └── workflow_swarm/

Additional changes added include:

  • fixing file path to schema in all config.yaml files
  • updating example.py script to take a directory/example in the argument
  • README updates across main README and model-provider agent READMEs

Organize examples into distinct categories:
- basic: simple agents and basic examples
- agent_patterns: function call patterns and model selection
- mcp: integrations with MCP servers
- interactive_demos: Streamlit and Marimo interfaces
- model_providers: Azure, Bedrock, Google, Ollama connections
- workflows: workflow patterns like router, swarm, etc.
- experimental: experimental features and tests
- streaming: SSE and websocket examples

TODO: Update scripts/example.py and README.md to work with new directory structure
Fix relative paths in:
- README.md: Update all example paths to point to new directory structure
- Config files: Update schema references to point to the correct location
- Test fixtures: Update README references to match new structure
- Update list command to display examples by category
- Modify run command to use path-style format (category/example_name)
- Fix path resolution to ensure script runs from any directory
- Update clean command to use path-style format as well
@andrew-lastmile andrew-lastmile requested a review from saqadri April 18, 2025 05:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant