nano-graphrag

环境要求

• Python 环境，且 pip 可用（README 未注明具体版本）
• OpenAI API Key（若没有，可改用 transformers + ollama 示例）
• 能访问 GitHub 与 PyPI 的网络环境
• （可选）如需用 Azure OpenAI 或 Amazon Bedrock，需准备对应凭证

安装与启动步骤

1. 1克隆仓库

   README 提示先克隆本仓库，代码结构极简，约 1100 行（不含测试与提示词）。

   git clone https://github.com/gusye1234/nano-graphrag.git

   复制

2. 2源码方式安装

   README 推荐从源码安装，-e 为可编辑安装，便于后续修改代码做实验。

   cd nano-graphrag
   pip install -e .

   复制

3. 3设置 API Key

   README 明确要求把 OpenAI API Key 写入环境变量，否则调用模型会失败。

   export OPENAI_API_KEY="sk-..."

   复制

4. 4下载示例文本

   README 提供的示例数据：查尔斯·狄更斯的《A Christmas Carol》，存为本地 book.txt。

   curl https://raw.githubusercontent.com/gusye1234/nano-graphrag/main/tests/mock_data.txt > ./book.txt

   复制

5. 5运行快速上手代码

   用 README 给出的 Python 片段：指定工作目录 ./dickens，读入 book.txt 并执行 insert 建库。

   from nano_graphrag import GraphRAG, QueryParam
   
   graph_func = GraphRAG(working_dir="./dickens")
   
   with open("./book.txt") as f:
       graph_func.insert(f.read())

   复制

关键配置

如何确认成功

执行 insert 无报错，并在 ./dickens 工作目录下生成索引相关数据文件即视为成功（README 未列出具体文件名）。

常见问题

注意事项

• README 推荐使用源码安装方式（pip install -e .）。
• 除 OpenAI 外还支持 Azure OpenAI、Amazon Bedrock，以及基于 transformers + ollama 的无 Key 方案。
• README 未说明 Python 最低版本与具体依赖版本，遇到问题请以仓库当前说明为准。
• 项目不含测试与提示词时约 1100 行代码，适合直接阅读与二次修改。