FloorManager / README.md
BladeSzaSza's picture
Update README.md
d2ebcdc verified
---
title: FloorManager
emoji: πŸ“š
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: 6.2.0
app_file: test_app.py
pinned: false
license: apache-2.0
short_description: Minimal functional floor manager
---
# OpenFloor Protocol (OFP) Floor Manager
A Python implementation of the OpenFloor Protocol Floor Manager with Gradio UI for managing multi-agent conversations.
## Project Status
### βœ… Completed
- Project structure created
- Configuration management (`settings.py`)
- Logging infrastructure
- Helper utilities
- Basic protocol envelope handling
- Requirements file with all dependencies
### 🚧 In Progress
- Protocol events module (has syntax errors that need manual fixing)
- Protocol handler
- Core business logic (FloorManager, FloorSession, Agent, Convener)
### πŸ“‹ Todo
- FastAPI backend endpoints
- Gradio UI implementation
- Example agents
- Integration testing
- Documentation
## Installation
```bash
# Create virtual environment
python3 -m venv venv
source venv/bin/activate # On macOS/Linux
# or
venv\Scripts\activate # On Windows
# Install dependencies
pip install -r requirements.txt
# Install OpenFloor SDK from test PyPI
pip install -i https://test.pypi.org/simple/ openfloor
```
## Architecture
The project follows a modular architecture:
```
ofpFloor/
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ utils/ # Configuration, logging, helpers
β”‚ β”œβ”€β”€ protocol/ # OFP protocol implementation
β”‚ β”œβ”€β”€ core/ # Business logic (Floor Manager, Sessions, Agents)
β”‚ β”œβ”€β”€ api/ # FastAPI endpoints
β”‚ └── ui/ # Gradio interface
β”œβ”€β”€ tests/ # Unit and integration tests
└── examples/ # Example agents and scenarios
```
## Known Issues
### Syntax Errors in `src/protocol/events.py`
The file has Python syntax errors that need to be manually fixed:
1. Line 9: `event_ Dict[str, Any]` should be `event_ Dict[str, Any]`
2. Line 10: `meta Optional[Dict[str, Any]]` should be `meta Optional[Dict[str, Any]]`
3. Line 30: `if meta` should be `if meta`
These need to be fixed before the project can run.
## Next Steps
1. Fix syntax errors in `src/protocol/events.py`
2. Complete protocol handler implementation
3. Implement core Floor Manager logic
4. Create FastAPI endpoints
5. Build Gradio UI
6. Test with example agents
## References
- [OpenFloor Protocol Specifications](https://openfloor.dev/protocol/specifications/)
- [OFP Assistant Manifest](https://openfloor.dev/protocol/specifications/assistant-manifest.md)
- [OFP Inter-Agent Message](https://openfloor.dev/protocol/specifications/inter-agent-message.md)
- [OFP Dialog Event Object](https://openfloor.dev/protocol/specifications/dialog-event-object.md)
- [Gradio Documentation](https://www.gradio.app/)
## License
MIT License