joaomorossini commited on
Commit
c706208
Β·
1 Parent(s): c36d2b6

Update README.md to enhance project overview, features, and setup instructions for Project Management Agency Swarm demo

Browse files
Files changed (1) hide show
  1. README.md +93 -2
README.md CHANGED
@@ -1,3 +1,94 @@
1
- # Overview
 
 
 
 
 
 
 
 
 
2
 
3
- Private demo for Technical Project Manager job application @ Agency AI (creator of the Agency Swarm framework)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Project Management Agency Swarm Demo
3
+ emoji: 🐝
4
+ colorFrom: yellow
5
+ colorTo: black
6
+ sdk: gradio
7
+ sdk_version: "5.19.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
 
12
+ # Project Management Agency Swarm Demo
13
+
14
+ ## Overview
15
+
16
+ This project is a practical demonstration of a Technical Project Management system built with Agency Swarm framework for a Technical Project Manager job application at Agency AI. The demo showcases how AI agents can collaborate to manage software development projects effectively.
17
+
18
+ ## Features
19
+
20
+ - Multi-agent system with specialized roles:
21
+
22
+ - Technical Project Manager - Coordinates project management activities
23
+ - Browsing Agent - Handles web search and information gathering
24
+ - Devid - Provides development support and guidance
25
+
26
+ - Notion integration for project management
27
+ - One way WhatsApp integration for communication
28
+ - Web browsing and search
29
+ - Code execution
30
+
31
+ ## Project Structure
32
+
33
+ ```
34
+ agency_swarm_demo/
35
+ β”œβ”€β”€ app/ # Main application code
36
+ β”‚ β”œβ”€β”€ agents/ # AI agent definitions
37
+ β”‚ β”‚ β”œβ”€β”€ TechnicalProjectManager/
38
+ β”‚ β”‚ β”œβ”€β”€ BrowsingAgent/
39
+ β”‚ β”‚ └── Devid/
40
+ β”‚ β”œβ”€β”€ shared_files/ # Resources shared between agents
41
+ β”‚ β”œβ”€β”€ demo.py # Main demo application with Gradio interface
42
+ β”œβ”€β”€ requirements.txt # Python dependencies
43
+ └── .env.example # Example environment variables template
44
+ ```
45
+
46
+ ## Technology Stack
47
+
48
+ - **Python**: Base programming language
49
+ - **Agency Swarm** (>= 0.4.4): Multi-agent orchestration framework
50
+ - **OpenAI API**: Backend for agent intelligence
51
+ - **Gradio** (5.19.0): Web interface for demonstrations
52
+ - **Selenium**: For web automation capabilities
53
+
54
+ ## Getting Started
55
+
56
+ 1. Clone this repository
57
+ 2. Copy `.env.example` to `.env` and add your API keys
58
+ 3. Install dependencies:
59
+ ```
60
+ pip install -r requirements.txt
61
+ ```
62
+ or using Poetry:
63
+ ```
64
+ poetry install
65
+ poetry shell
66
+ ```
67
+ 4. Run the demo:
68
+ ```
69
+ gradio app/demo.py
70
+ ```
71
+
72
+ ## Purpose
73
+
74
+ This demo showcases how AI agents can be leveraged for technical project management tasks, including:
75
+
76
+ - Project planning and coordination
77
+ - Requirements gathering and analysis
78
+ - Technical research and information retrieval
79
+ - Team communication and updates
80
+ - Development guidance and support
81
+
82
+ The system demonstrates the potential for AI-augmented project management to streamline software development workflows and improve team collaboration.
83
+
84
+ ## License
85
+
86
+ MIT
87
+
88
+ ## Author
89
+
90
+ **JoΓ£o Morossini**
91
+
92
+ - Professional Portfolio: https://joaomorossini.github.io/
93
+ - GitHub: https://github.com/joaomorossini
94
+ - LinkedIn: https://www.linkedin.com/in/joaomorossini/