使用说明
🏠 房地产租金分析器
一款利用Playwright MCP的AI驱动工具,用于抓取、解析和分析特定区域的房地产租赁数据。
这个仓库包含一个自动化房地产租金分析工具,它能帮助您根据用户设定的标准,在特定区域收集租赁房源信息。(目前仅支持Redfin平台)
✨ 特点
- 自动化网页抓取: 使用Playwright从网页中提取房地产列表信息。
- 智能内容解析: 将抓取的数据结构化,直接在终端进行分析或将其保存为CSV文件。
- 基于人工智能的过滤: 利用人工智能和Playwright MCP根据用户标准应用过滤器。
- 双接口: 可以作为命令行工具直接运行进行分析,或者作为FastAPI服务器以供API访问。
🚀 开始使用
这些说明将帮助您在本地机器上获取项目副本,并使其能够正常运行,以便进行开发和测试。
先决条件
- Python 3.10+(建议使用3.11版本)
- Node.js 和 npm(用于运行 Playwright MCP)
npx)
这些安装步骤适用于Windows系统,提供的命令适用于PowerShell。
💻 安装
-
克隆仓库:
git clone https://github.com/eren123danyel/real-estate-analyzer.git cd real-estate-analyzer -
创建并激活虚拟环境:
python -m venv .venv .\.venv\Scripts\activate -
安装Python依赖项:
pip install --upgrade pip pip install -r requirements.txt -
安装spaCy的英语模型:
python -m spacy download en_core_web_sm -
安装 Playwright 浏览器:
python -m playwright install # Or, if you encounter issues, you can use the Node tooling: # npx playwright install
⚙️ 配置
这个项目使用 python-dotenv 管理环境变量。
-
创建一个
.env项目根目录下的文件。 -
将您的OpenAI API密钥添加到
.env文件:OPENAI_API_KEY="YOUR-API-KEY" # Your OpenAI key
🏃♀️ 运行应用程序
你可以将此工具作为命令行应用程序运行,或者作为带有API的网络服务器运行。
作为命令行界面工具
直接从您的终端开始操作:
python rentanalyzer.py --help
示例命令
查找洛杉矶的租赁信息并打印到终端:
python rentanalyzer.py -l "Los Angeles"
在纽约市查找租金低于3k的房源,并保存为CSV格式:
python rentanalyzer.py -l "NYC" -m 3000 -o "output.csv"
在西雅图查找租金低于3000美元、有2张及以上床位且允许养狗的公寓,并保存为CSV文件:
python rentanalyzer.py -g "Find apartments in Seattle that have 2+ beds and that are dog friendly and under $3k" -o "output.csv"
作为API服务器
启动FastAPI服务器:
python rentanalyzer.py -api
该API随后将可用 http://127.0.0.1:8080。
当作为服务器运行时,将提供两个端点:
- 使用AI搜索Redfin(房地产数据平台)
- 接受参数 目标 用自然语言(来描述),让AI知道要抓取什么。
- /search_redfin 翻译为中文是:“搜索Redfin(房地产平台)”
- “Takes”可以翻译为“接受”或“拿取”,具体取决于上下文 位置 以及可选地 最高价格。
🎬 演示
以下是使用房地产租金分析工具的一些示例。
🖥️ 无AI的CLI演示
🤖 带AI的CLI演示
🔌 API 示例
服务器运行后,您可以通过访问:(http://127.0.0.1:8080/docs/) 使用Swagger UI与API进行交互。
你也可以使用curl来发送请求,例如:
curl.exe -X GET "http://127.0.0.1:8080/search_redfin?location=Seattle" -H "accept: application/json"
或者
curl.exe -X GET "http://127.0.0.1:8080/search_redfin_with_ai?goal=Find%20rental%20listings%20under%203000%20in%20Los%20Angeles" -H "accept: application/json"
📄 许可证
这个项目遵循MIT许可证授权——详见 许可证 详情请查阅文件。