xhs-note-extractor 0.1.2__tar.gz

xhs_note_extractor-0.1.2/.gitignore

@@ -0,0 +1,151 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs
+logs/
+*.log
+
+# Local development
+local/
+tmp/
+temp/last_extracted_note.txt

xhs_note_extractor-0.1.2/.joycode/prompt.json

@@ -0,0 +1 @@
+[{"label":"一键安装环境","name":"Install","description":"专注于解决工作空间环境问题","prompt":"你是一位专门从事解决工作空间环境问题的全栈工程师和DevOps专家，你的主要任务是帮助用户诊断、修复和配置当前工作空间`/Users/yehao20/android_scrawl_v3/xhs-note-extractor/`的开发环境。\n\n## 核心职责\n\n### 1. 环境检测与诊断\n- 自动扫描工作空间中的项目文件（package.json, requirements.txt, pom.xml, Gemfile, go.mod等）\n- 识别项目所需的运行环境和依赖\n- 检测当前系统已安装的环境版本\n- 分析环境配置冲突和兼容性问题\n\n### 2. 主流环境支持\n**Node.js生态系统：**\n- 检测和安装Node.js（如果用户没要求推荐LTS版本）\n- 配置npm/yarn/pnpm包管理器\n- 处理node_modules依赖问题\n- 解决版本冲突和权限问题\n\n**Python生态系统：**\n- 安装Python（2.x/3.x版本管理）\n- 配置pip包管理器和虚拟环境（venv/conda）\n- 处理requirements.txt依赖安装\n- 解决Python路径和模块导入问题\n\n**Java生态系统：**\n- 安装和配置JDK/JRE（版本选择和JAVA_HOME设置）\n- 配置Maven/Gradle构建工具\n- 处理依赖下载和仓库配置\n- 解决类路径和编译问题\n\n**其他主流环境：**\n- Go语言环境配置\n- Ruby和Rails环境\n- PHP和Composer\n- .NET Core环境\n- Docker容器化环境\n\n### 3. 项目启动与运行\n- 分析项目启动脚本和配置文件\n- 提供标准化的启动命令\n- 配置开发服务器和热重载\n- 设置环境变量和配置文件\n- 处理端口冲突和服务依赖\n\n### 4. 问题解决策略\n- 提供跨平台解决方案（Windows/macOS/Linux）\n- 给出详细的安装步骤和命令\n- 提供多种安装方式选择（官方安装器/包管理器/容器化）\n- 预防常见错误和最佳实践建议\n- 提供环境验证和测试方法\n\n### 5. 交互方式\n- 首先询问用户的操作系统和项目类型\n- 逐步引导用户完成环境配置\n- 提供可复制的命令和脚本\n- 在每个步骤后确认执行结果\n- 遇到问题时提供多种备选方案\n\n## 工作流程\n1. **环境扫描**：分析工作空间文件结构，识别项目类型\n2. **需求评估**：确定所需的运行环境和版本要求\n3. **现状检查**：检测当前已安装的环境和工具\n4. **差距分析**：对比需求与现状，列出缺失项\n5. **安装指导**：提供详细的安装和配置步骤\n6. **验证测试**：确保环境配置正确可用\n7. **项目启动**：协助用户成功启动项目\n\n请始终保持耐心和专业，用通俗易懂的语言解释技术概念，并在每个关键步骤提供清晰的指导。现在请开始分析当前工作空间的环境需求。\n"},{"label":"一键生成JoyCode Rules","name":"generateRules","description":"专注于生成JoyCode规则","prompt":"\n    # 你是一位资深的代码架构分析专家，专门负责分析项目结构并生成 JoyCode Rules 配置文件。\n\n## 任务目标\n基于当前工作空间`/Users/yehao20/android_scrawl_v3/xhs-note-extractor/`的代码结构，生成一份完整结构清晰、可操作性强的 `[object Promise].md` Rules文件，Rules文件存放在`/Users/yehao20/android_scrawl_v3/xhs-note-extractor/`工作空间下.joycode文件夹下rules文件夹中，用于指导 AI 助手更好地理解和协助开发工作。\n\n## 分析维度\n请按以下维度深入分析当前项目：\n\n### 1. 项目概览\n- 项目类型（前端/后端/全栈/移动端等）\n- 主要技术栈和框架\n- 项目规模和复杂度\n\n### 2. 调用关系分析\n- 模块间依赖关系\n- API 调用链路\n- 数据流向\n- 关键组件交互模式\n\n### 3. 仓库结构总结\n- 目录组织架构\n- 文件命名规范\n- 配置文件分布\n- 资源文件管理\n\n### 4. 代码特征总结\n- 编程语言和版本\n- 代码风格和规范\n- 设计模式使用\n- 第三方库依赖\n\n## 输出要求\n生成的 `[object Promise].md` 文件必须包含：\n- 项目背景和技术栈说明\n- 代码风格和命名约定\n- 架构模式和最佳实践\n- 开发约束和注意事项\n- 常用命令和工作流程\n- 格式如下:\n`\n---\nglobs: *\nalwaysApply: true\n---\n\n# 项目规则要求如下\n\n规则(Rules)内容放在这里\n`\n\n## 约束条件\n- 仅分析当前工作空间内的文件\n- 不要包含敏感信息（如密钥、密码等）\n- 确保规则具体可执行，避免模糊描述\n- 生成的规则要便于 AI 助手理解和遵循\n\n\n请开始分析当前工作空间并生成对应的 JoyCode Rules 配置。\n"}]

xhs_note_extractor-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JoyCode Agent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xhs_note_extractor-0.1.2/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include xhs_note_extractor *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

xhs_note_extractor-0.1.2/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: xhs-note-extractor
+Version: 0.1.2
+Summary: A Python package for extracting Xiaohongshu (Little Red Book) note data from URLs
+Author-email: JoyCode Agent <agent@joycode.com>
+License: MIT
+Project-URL: Homepage, https://github.com/yehao20/xhs-note-extractor
+Project-URL: Repository, https://github.com/yehao20/xhs-note-extractor
+Project-URL: Documentation, https://github.com/yehao20/xhs-note-extractor/blob/main/README.md
+Project-URL: Issues, https://github.com/yehao20/xhs-note-extractor/issues
+Keywords: xiaohongshu,little-red-book,web-scraping,automation,uiautomator
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: uiautomator2>=2.16.17
+Requires-Dist: requests>=2.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: flake8>=3.8; extra == "dev"
+Dynamic: license-file
+
+# 小红书笔记提取器 (Xiaohongshu Note Extractor)
+
+一个用于从小红书提取笔记数据的Python工具，支持命令行界面和编程接口。
+
+## 功能特性
+
+- 🔍 从小红书笔记URL提取详细数据
+- 📊 支持JSON和CSV输出格式
+- 🖥️ 命令行界面支持
+- 🔧 可配置的设备连接选项
+- 📱 Android设备集成（通过uiautomator2）
+- 🛡️ 优雅的错误处理和设备状态检查
+
+## 安装
+
+### 从源码安装
+
+```bash
+# 克隆仓库
+git clone <repository-url>
+cd xhs-note-extractor
+
+# 安装依赖
+pip install -r requirements.txt
+
+# 安装包（开发模式）
+pip install -e .
+```
+
+### 依赖要求
+
+- Python 3.7+
+- Android设备（用于完整功能）
+- ADB工具
+
+## 使用方法
+
+### 命令行界面（CLI）
+
+安装完成后，可以直接使用 `xhs-extract` 命令：
+
+```bash
+# 提取笔记并输出到控制台（JSON格式）
+xhs-extract https://www.xiaohongshu.com/explore/note_id
+
+# 保存到文件
+xhs-extract https://www.xiaohongshu.com/explore/note_id -o note_data.json
+
+# 输出CSV格式
+xhs-extract https://www.xiaohongshu.com/explore/note_id -f csv -o note_data.csv
+
+# 启用详细输出模式
+xhs-extract https://www.xiaohongshu.com/explore/note_id -v
+
+# 查看帮助
+xhs-extract --help
+```
+
+### 编程接口
+
+```python
+from xhs_note_extractor import XHSNoteExtractor
+import json
+
+# 创建提取器实例
+extractor = XHSNoteExtractor()
+
+# 检查设备连接状态
+if extractor.is_device_connected():
+    # 提取笔记数据
+    note_data = extractor.extract_note_data("https://www.xiaohongshu.com/explore/note_id")
+    print(json.dumps(note_data, ensure_ascii=False, indent=2))
+else:
+    print("请连接Android设备并启用USB调试")
+```
+
+## 输出数据结构
+
+提取的数据包含以下字段：
+
+```json
+{
+  "title": "笔记标题",
+  "content": "笔记完整内容",
+  "author": {
+    "nickname": "作者昵称",
+    "user_id": "用户ID"
+  },
+  "likes": 100,
+  "collects": 50,
+  "comments": 25,
+  "shares": 10,
+  "image_urls": [
+    "图片URL1",
+    "图片URL2"
+  ],
+  "video_url": "视频URL（如果有）",
+  "tags": ["标签1", "标签2"],
+  "publish_time": "发布时间",
+  "note_id": "笔记ID"
+}
+```
+
+## 设备连接
+
+### 连接Android设备
+
+1. 在Android设备上启用**开发者选项**和**USB调试**
+2. 通过USB连接设备到电脑
+3. 授权USB调试权限（设备上会弹出提示）
+
+### 检查设备状态
+
+```bash
+# 使用ADB检查设备
+adb devices
+
+# 使用CLI工具检查
+xhs-extract --help  # 会显示设备连接状态
+```
+
+## 故障排除
+
+### 设备连接问题
+
+如果CLI工具提示设备未连接：
+
+1. 检查USB连接是否正常
+2. 确认已在设备上启用USB调试
+3. 确认已授权USB调试权限
+4. 尝试重新插拔USB线缆
+5. 重启ADB服务：
+   ```bash
+   adb kill-server
+   adb start-server
+   ```
+
+### 权限问题
+
+在Linux/Mac上，可能需要为ADB添加权限：
+
+```bash
+sudo adb kill-server
+sudo adb start-server
+```
+
+## 示例
+
+查看 `examples/basic_usage.py` 文件获取更多使用示例：
+
+```bash
+# 运行示例
+python examples/basic_usage.py
+```
+
+## 开发
+
+### 项目结构
+
+```
+xhs-note-extractor/
+├── xhs_note_extractor/
+│   ├── __init__.py
+│   ├── cli.py          # 命令行界面
+│   ├── extractor.py    # 核心提取器
+│   └── utils.py        # 工具函数
+├── examples/
+│   └── basic_usage.py  # 使用示例
+├── tests/
+├── requirements.txt
+├── setup.py
+└── README.md
+```
+
+### 运行测试
+
+```bash
+# 运行示例
+python examples/basic_usage.py
+
+# 使用CLI工具
+xhs-extract --help
+```
+
+## 注意事项
+
+- 本工具仅供学习和研究使用
+- 请遵守小红书的使用条款和API限制
+- 过度频繁的请求可能导致IP被封禁
+- 建议在合理范围内使用，避免对平台造成负担
+
+## 许可证
+
+MIT License
+
+## 贡献
+
+欢迎提交Issue和Pull Request！

xhs_note_extractor-0.1.2/QUICK_START.md

@@ -0,0 +1,98 @@
+# 小红书笔记提取器 - 快速开始指南
+
+## 1. 安装
+
+```bash
+# 克隆仓库（如果需要）
+# git clone <repository-url>
+# cd xhs-note-extractor
+
+# 安装依赖
+pip install -r requirements.txt
+
+# 安装包（开发模式）
+pip install -e .
+```
+
+## 2. 连接Android设备
+
+1. 在Android设备上启用**开发者选项**和**USB调试**
+2. 通过USB连接设备到电脑
+3. 在设备上授权USB调试权限
+
+## 3. 使用CLI工具
+
+### 基本用法
+
+```bash
+# 提取笔记并输出到控制台
+xhs-extract https://www.xiaohongshu.com/explore/note_id
+
+# 保存到文件
+xhs-extract https://www.xiaohongshu.com/explore/note_id -o note_data.json
+
+# 输出CSV格式
+xhs-extract https://www.xiaohongshu.com/explore/note_id -f csv -o note_data.csv
+
+# 启用详细输出
+xhs-extract https://www.xiaohongshu.com/explore/note_id -v
+```
+
+### 查看帮助
+
+```bash
+xhs-extract --help
+```
+
+## 4. 编程接口使用
+
+```python
+from xhs_note_extractor import XHSNoteExtractor
+import json
+
+# 创建提取器实例
+extractor = XHSNoteExtractor()
+
+# 检查设备连接
+if extractor.is_device_connected():
+    # 提取笔记数据
+    note_data = extractor.extract_note_data("https://www.xiaohongshu.com/explore/note_id")
+    print(json.dumps(note_data, ensure_ascii=False, indent=2))
+else:
+    print("请连接Android设备")
+```
+
+## 5. 故障排除
+
+### 设备未连接
+
+如果看到"未检测到Android设备连接"：
+
+1. 检查USB连接
+2. 确认已启用USB调试
+3. 确认已授权USB调试权限
+4. 运行 `adb devices` 检查设备是否被识别
+
+### 无设备模式
+
+CLI工具现在可以优雅处理无设备情况，会显示清晰的错误信息而不是抛出异常。
+
+## 6. 测试
+
+运行测试脚本验证安装：
+
+```bash
+python test_cli.py
+```
+
+## 7. 示例
+
+运行示例脚本查看使用方法：
+
+```bash
+python examples/basic_usage.py
+```
+
+## 8. 完成！
+
+现在您可以开始使用小红书笔记提取器了。CLI工具已完全可用，支持JSON和CSV输出格式，并能优雅处理设备连接错误。

xhs_note_extractor-0.1.2/README.md

@@ -0,0 +1,198 @@
+# 小红书笔记提取器 (Xiaohongshu Note Extractor)
+
+一个用于从小红书提取笔记数据的Python工具，支持命令行界面和编程接口。
+
+## 功能特性
+
+- 🔍 从小红书笔记URL提取详细数据
+- 📊 支持JSON和CSV输出格式
+- 🖥️ 命令行界面支持
+- 🔧 可配置的设备连接选项
+- 📱 Android设备集成（通过uiautomator2）
+- 🛡️ 优雅的错误处理和设备状态检查
+
+## 安装
+
+### 从源码安装
+
+```bash
+# 克隆仓库
+git clone <repository-url>
+cd xhs-note-extractor
+
+# 安装依赖
+pip install -r requirements.txt
+
+# 安装包（开发模式）
+pip install -e .
+```
+
+### 依赖要求
+
+- Python 3.7+
+- Android设备（用于完整功能）
+- ADB工具
+
+## 使用方法
+
+### 命令行界面（CLI）
+
+安装完成后，可以直接使用 `xhs-extract` 命令：
+
+```bash
+# 提取笔记并输出到控制台（JSON格式）
+xhs-extract https://www.xiaohongshu.com/explore/note_id
+
+# 保存到文件
+xhs-extract https://www.xiaohongshu.com/explore/note_id -o note_data.json
+
+# 输出CSV格式
+xhs-extract https://www.xiaohongshu.com/explore/note_id -f csv -o note_data.csv
+
+# 启用详细输出模式
+xhs-extract https://www.xiaohongshu.com/explore/note_id -v
+
+# 查看帮助
+xhs-extract --help
+```
+
+### 编程接口
+
+```python
+from xhs_note_extractor import XHSNoteExtractor
+import json
+
+# 创建提取器实例
+extractor = XHSNoteExtractor()
+
+# 检查设备连接状态
+if extractor.is_device_connected():
+    # 提取笔记数据
+    note_data = extractor.extract_note_data("https://www.xiaohongshu.com/explore/note_id")
+    print(json.dumps(note_data, ensure_ascii=False, indent=2))
+else:
+    print("请连接Android设备并启用USB调试")
+```
+
+## 输出数据结构
+
+提取的数据包含以下字段：
+
+```json
+{
+  "title": "笔记标题",
+  "content": "笔记完整内容",
+  "author": {
+    "nickname": "作者昵称",
+    "user_id": "用户ID"
+  },
+  "likes": 100,
+  "collects": 50,
+  "comments": 25,
+  "shares": 10,
+  "image_urls": [
+    "图片URL1",
+    "图片URL2"
+  ],
+  "video_url": "视频URL（如果有）",
+  "tags": ["标签1", "标签2"],
+  "publish_time": "发布时间",
+  "note_id": "笔记ID"
+}
+```
+
+## 设备连接
+
+### 连接Android设备
+
+1. 在Android设备上启用**开发者选项**和**USB调试**
+2. 通过USB连接设备到电脑
+3. 授权USB调试权限（设备上会弹出提示）
+
+### 检查设备状态
+
+```bash
+# 使用ADB检查设备
+adb devices
+
+# 使用CLI工具检查
+xhs-extract --help  # 会显示设备连接状态
+```
+
+## 故障排除
+
+### 设备连接问题
+
+如果CLI工具提示设备未连接：
+
+1. 检查USB连接是否正常
+2. 确认已在设备上启用USB调试
+3. 确认已授权USB调试权限
+4. 尝试重新插拔USB线缆
+5. 重启ADB服务：
+   ```bash
+   adb kill-server
+   adb start-server
+   ```
+
+### 权限问题
+
+在Linux/Mac上，可能需要为ADB添加权限：
+
+```bash
+sudo adb kill-server
+sudo adb start-server
+```
+
+## 示例
+
+查看 `examples/basic_usage.py` 文件获取更多使用示例：
+
+```bash
+# 运行示例
+python examples/basic_usage.py
+```
+
+## 开发
+
+### 项目结构
+
+```
+xhs-note-extractor/
+├── xhs_note_extractor/
+│   ├── __init__.py
+│   ├── cli.py          # 命令行界面
+│   ├── extractor.py    # 核心提取器
+│   └── utils.py        # 工具函数
+├── examples/
+│   └── basic_usage.py  # 使用示例
+├── tests/
+├── requirements.txt
+├── setup.py
+└── README.md
+```
+
+### 运行测试
+
+```bash
+# 运行示例
+python examples/basic_usage.py
+
+# 使用CLI工具
+xhs-extract --help
+```
+
+## 注意事项
+
+- 本工具仅供学习和研究使用
+- 请遵守小红书的使用条款和API限制
+- 过度频繁的请求可能导致IP被封禁
+- 建议在合理范围内使用，避免对平台造成负担
+
+## 许可证
+
+MIT License
+
+## 贡献
+
+欢迎提交Issue和Pull Request！