WhyHow知识图谱工作室开源项目教程

WhyHow知识图谱工作室开源项目教程

knowledge-graph-studio WhyHow Knowledge Graph Studio 项目地址: https://gitcode.com/gh_mirrors/kn/knowledge-graph-studio

1. 项目目录结构及介绍

WhyHow知识图谱工作室（Knowledge Graph Studio）的目录结构如下：

knowledge-graph-studio/  # 项目根目录
├── .github/             # GitHub相关配置
├── src/                 # 源代码目录
│   ├── whyhow_api/      # whyhow_api模块
│   │   ├── cli/         # 命令行工具
│   │   ├── main/        # API服务器主程序
│   │   └── ...          # 其他模块和文件
│   └── ...              # 其他源代码文件
├── tests/               # 测试代码目录
├── .dockerignore        # Docker构建忽略文件
├── .env.sample          # 环境变量示例文件
├── .flake8              # flake8代码风格检查配置
├── .gitignore           # Git忽略文件
├── CHANGELOG.md         # 更改日志
├── Dockerfile           # Docker构建文件
├── LICENSE              # 许可证文件
├── README.md            # 项目说明文件
├── mkdocs.yml           # MkDocs文档配置
├── pyproject.toml       # Python项目配置
├── pytest.ini           # pytest测试配置
└── ...                  # 其他文件和目录

主要目录和文件说明：

• src/: 存放项目的核心源代码。
• tests/: 包含单元测试和集成测试的代码。
• .dockerignore: 指定不被Docker构建包含的文件和目录。
• .env.sample: 提供了环境变量配置的示例。
• CHANGELOG.md: 记录了项目的版本更新和修改历史。
• Dockerfile: 用于构建Docker镜像的文件。
• LICENSE: 项目的开源许可证信息。
• README.md: 项目的基本介绍和说明。

2. 项目的启动文件介绍

项目的启动文件位于src/whyhow_api/main.py。这个文件定义了API服务器的入口点。以下是启动API服务器的基本命令：

$ uvicorn src.whyhow_api.main:app

你可以通过浏览器访问http://localhost:8000/docs来查看Swagger UI，这是自动生成的API文档。

3. 项目的配置文件介绍

项目的配置文件是.env.sample，你需要将其复制为.env文件，并根据你的环境进行编辑。以下是配置文件中可能需要修改的部分：

WHYHOW__EMBEDDING__OPENAI__API_KEY=<your openai api key>
WHYHOW__GENERATIVE__OPENAI__API_KEY=<your openai api key - can be the same>
WHYHOW__MONGODB__USERNAME=<your altas database username>
WHYHOW__MONGODB__PASSWORD=<your altas database password>
WHYHOW__MONGODB__DATABASE_NAME=main
WHYHOW__MONGODB__HOST=<your altas host i.e. 'xxx.xxx.mongodb.net'>

确保提供正确的OpenAI API密钥和MongoDB数据库凭证，以便项目可以正确连接到服务。

knowledge-graph-studio WhyHow Knowledge Graph Studio 项目地址: https://gitcode.com/gh_mirrors/kn/knowledge-graph-studio