Perplexity Search 项目使用教程

1. 项目的目录结构及介绍

Perplexity Search 是一个使用 Perplexity API 进行技术搜索的强大 Python 工具。以下是项目的目录结构及其介绍：

• assets/: 存放项目所需的静态资源，如图片等。
• images/: 存放项目文档中使用的图片。
• plexsearch/: 项目的主要模块，包含执行搜索功能的 Python 代码。
• src/: 源代码目录，包含主要的 Python 脚本。
• tests/: 测试目录，包含项目的单元测试。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的更新和修改历史。
• LICENSE: 项目的 MIT 许可证。
• LLM_DEV_NOTES.md: 开发者笔记，可能包含一些重要的开发信息。
• README.md: 项目说明文件，提供项目的简介和使用说明。
• get_changes.py: 可能是用于获取项目变更的脚本。
• pyproject.toml: 项目配置文件，定义了项目的元数据和依赖。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。

2. 项目的启动文件介绍

项目的启动文件是 plexsearch.py，它是项目的命令行界面入口点。通过这个脚本，用户可以直接从命令行执行搜索操作。以下是一些启动文件的基本使用方法：

• 进入交互模式：直接运行 plexsearch 命令，可以输入查询并获取结果。
• 执行基本搜索：plexsearch "查询内容"，例如 plexsearch "Python 列表操作的时间复杂度是什么?"。
• 指定模型：plexsearch --model 模型名称 "查询内容"，例如 plexsearch --model llama-3.1-sonar-huge-128k-online "Python 3.11 和 3.12 的区别是什么?"。
• 使用特定 API 密钥：plexsearch --api-key 你的-api-密钥 "查询内容"。

3. 项目的配置文件介绍

项目的配置文件主要是 pyproject.toml，它包含了项目的元数据和依赖信息。下面是配置文件的一些基本内容：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "plexsearch"
version = "0.1.0"
description = "A powerful Python tool for performing technical searches using the Perplexity API."
requires-python = ">=3.7"
dependencies = [
    "requests",
    "rich",
    "feedparser"
]

在这个配置文件中，定义了项目的名称、版本、描述以及所需的 Python 版本和依赖项。这些信息在打包和分发项目时是非常重要的。