x-crawlfox 0.1.0__tar.gz

x_crawlfox-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

x_crawlfox-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: x-crawlfox
+Version: 0.1.0
+Summary: Implementing X (Twitter) data crawling based on Camoufox, for personal use.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: camoufox>=0.4.11
+Requires-Dist: typer>=0.15.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pydantic>=2.10.6
+Dynamic: license-file
+
+# X-CrawlFox 🦊
+
+基于 Camoufox 的 X (Twitter) 拟人化爬虫命令行工具。
+
+**特点**：免费、支持高度定制、增量爬取、内置拟人化行为防风控。
+
+---
+
+## 🚀 主要功能特性
+
+- **拟人化交互**：集成 Camoufox 指纹混淆，模拟真人滚动、随机延迟、键入交互，大幅降低风控风险。
+- **时间线抓取**：支持爬取“正在关注 (Following)”和“为您推荐 (For you)”的内容，支持指定抓取数量。
+- **深度新闻爬取**：自动抓取“今日新闻 (Today's News)”侧边栏，支持点击进入详情页获取 Grok 摘要及相关热门帖子。
+- **增量账号监控**：支持多账号监控，自动追踪上次爬取位置，仅抓取新发布的推文。
+- **一键全量任务**：通过 JSON 配置文件，一键启动包含时间线、新闻、多账号监控在内的复合爬取任务。
+- **自动状态管理**：自动保存登录会话 (Storage State) 和爬取进度 (Crawler State)。
+
+---
+
+## 📦 安装与准备
+
+本项目使用 `uv` 进行包管理。
+
+1. **克隆项目并安装依赖**：
+   ```bash
+   git clone <repository-url>
+   cd x-crawlfox
+   uv sync
+   ```
+
+2. **安装浏览器驱动（首次启动会自动下载）**：
+   ```bash
+   uv run playwright install firefox
+   ```
+
+---
+
+## 📂 存储与配置 (.x-crawlfox)
+
+为了保护隐私并支持持久化，X-CrawlFox 使用 `.x-crawlfox` 文件夹存储敏感数据（登录 Session 和爬取进度）：
+
+1. **存储位置**：
+   - **局部模式**：程序优先检查当前运行目录下是否存在 `.x-crawlfox` 文件夹。如果存在，则所有数据存放在此处（适合多账号隔离）。
+   - **全局模式**：如果当前目录没有该文件夹，程序会自动使用用户主目录下的 `~/.x-crawlfox`（Windows 为 `%USERPROFILE%\.x-crawlfox`）。
+
+2. **存储内容**：
+   - `storage_state.json`：存储 X 的登录 Cookie 和认证令牌。**请勿泄露此文件**。
+   - `crawler_state.json`：存储每个监控账号已爬取的最后一条推文 ID，用于实现增量抓取。
+
+---
+
+## 🛠️ 使用说明
+
+### 1. 账号登录或cookie导出（必备）
+在进行任何爬取前，需先完成手动登录以保存会话：
+```bash
+uv run x-crawlfox x login --no-headless
+```
+在弹出的窗口中登录 X，完成后回到终端按回车保存状态。
+
+**注意**：如果使用刚注册的账号登录，很容易免被 X 封禁。
+
+如果登陆的过程中被x拦截（识别为可疑的登陆），无法完成登陆，可通过浏览器插件Cookie Editor导出真实使用浏览器的Cookie为json，并保存至storage_state.json文件中。
+![Cookie Editor](./docs/images/cookie-editor-export.jpg)
+### 2. 爬取个人时间线
+```bash
+# 爬取“关注”页前 20 条
+uv run x-crawlfox x timeline --type Following --max-items 20
+
+# 爬取“推荐”页
+uv run x-crawlfox x timeline --type "For you" --max-items 50
+```
+
+### 3. 爬取今日新闻
+```bash
+# 仅爬取侧边栏列表
+uv run x-crawlfox x news
+
+# 深度爬取：进入详情页抓取摘要和相关帖子
+uv run x-crawlfox x news --detail --max-items 3
+```
+
+### 4. 抓取/监控指定用户
+```bash
+# 抓取指定用户最新的 20 条推文
+uv run x-crawlfox x user elonmusk --max-tweets 20
+
+# 增量抓取：仅抓取该用户自上次运行以来发布的新内容
+uv run x-crawlfox x user elonmusk --only-new
+```
+
+### 5. 一键执行复合任务
+编辑 `crawl_config.json`（见下文），然后运行：
+```bash
+uv run x-crawlfox x all --config crawl_config.json
+```
+
+---
+
+## ⚙️ 配置文件示例 (`crawl_config.json`)
+
+```json
+{
+    "timeline": [
+        { "type": "Following", "max_items": 10 },
+        { "type": "For you", "max_items": 10 }
+    ],
+    "news": {
+        "enabled": true,
+        "detail": true,
+        "max_items": 5
+    },
+    "monitor": [
+        { "username": "elonmusk", "only_new": true, "max_tweets": 10 },
+        { "username": "OpenAI", "only_new": true, "max_tweets": 5 }
+    ]
+}
+```
+
+---
+
+## 🛡️ 防风控与鲁棒性优化
+
+- **内存释放**：在多账号监控间隙自动跳转 `about:blank`，强制释放 X 平台庞大的 React 内存堆，防止长时间运行崩溃。
+- **自动恢复**：检测到 `Target page closed` 或页面报错时，系统会自动尝试重建页面或点击 `Retry` 按钮。
+- **异步等待**：全量使用 Playwright 的非阻塞 `wait_for_timeout` 机制，提升自动化执行的稳定性。
+- **随机行为**：内置随机滚动距离、随机停顿时间以及拟人化的鼠标移动。
+
+---
+
+## 📁 数据输出
+所有抓取结果均以 `.jsonl` 格式保存于 `output/` 目录下，方便进行后续的数据分析或入库。
+
+---
+
+## 🙏 感谢
+
+This project integrates and references these excellent open-source projects:
+
+- [Camoufox](https://github.com/daijro/camoufox): Powerful browser fingerprint obfuscation and human-like interaction.
+- [Playwright](https://playwright.dev/): Fast and robust automation and scraping framework.
+- [uv](https://github.com/astral-sh/uv): Extremely efficient Python package manager.
+- [Loguru](https://github.com/Delgan/loguru) & [Typer](https://typer.tiangolo.com/): For elegant logging and CLI interactions.
+
+---
+
+## ⚠️ 免责声明
+本工具仅供学习和研究目的使用。请遵守 X (Twitter) 的服务条款。因使用本工具导致的账号限制或法律纠纷，由使用者自行承担。

x_crawlfox-0.1.0/README.md

@@ -0,0 +1,148 @@
+# X-CrawlFox 🦊
+
+基于 Camoufox 的 X (Twitter) 拟人化爬虫命令行工具。
+
+**特点**：免费、支持高度定制、增量爬取、内置拟人化行为防风控。
+
+---
+
+## 🚀 主要功能特性
+
+- **拟人化交互**：集成 Camoufox 指纹混淆，模拟真人滚动、随机延迟、键入交互，大幅降低风控风险。
+- **时间线抓取**：支持爬取“正在关注 (Following)”和“为您推荐 (For you)”的内容，支持指定抓取数量。
+- **深度新闻爬取**：自动抓取“今日新闻 (Today's News)”侧边栏，支持点击进入详情页获取 Grok 摘要及相关热门帖子。
+- **增量账号监控**：支持多账号监控，自动追踪上次爬取位置，仅抓取新发布的推文。
+- **一键全量任务**：通过 JSON 配置文件，一键启动包含时间线、新闻、多账号监控在内的复合爬取任务。
+- **自动状态管理**：自动保存登录会话 (Storage State) 和爬取进度 (Crawler State)。
+
+---
+
+## 📦 安装与准备
+
+本项目使用 `uv` 进行包管理。
+
+1. **克隆项目并安装依赖**：
+   ```bash
+   git clone <repository-url>
+   cd x-crawlfox
+   uv sync
+   ```
+
+2. **安装浏览器驱动（首次启动会自动下载）**：
+   ```bash
+   uv run playwright install firefox
+   ```
+
+---
+
+## 📂 存储与配置 (.x-crawlfox)
+
+为了保护隐私并支持持久化，X-CrawlFox 使用 `.x-crawlfox` 文件夹存储敏感数据（登录 Session 和爬取进度）：
+
+1. **存储位置**：
+   - **局部模式**：程序优先检查当前运行目录下是否存在 `.x-crawlfox` 文件夹。如果存在，则所有数据存放在此处（适合多账号隔离）。
+   - **全局模式**：如果当前目录没有该文件夹，程序会自动使用用户主目录下的 `~/.x-crawlfox`（Windows 为 `%USERPROFILE%\.x-crawlfox`）。
+
+2. **存储内容**：
+   - `storage_state.json`：存储 X 的登录 Cookie 和认证令牌。**请勿泄露此文件**。
+   - `crawler_state.json`：存储每个监控账号已爬取的最后一条推文 ID，用于实现增量抓取。
+
+---
+
+## 🛠️ 使用说明
+
+### 1. 账号登录或cookie导出（必备）
+在进行任何爬取前，需先完成手动登录以保存会话：
+```bash
+uv run x-crawlfox x login --no-headless
+```
+在弹出的窗口中登录 X，完成后回到终端按回车保存状态。
+
+**注意**：如果使用刚注册的账号登录，很容易免被 X 封禁。
+
+如果登陆的过程中被x拦截（识别为可疑的登陆），无法完成登陆，可通过浏览器插件Cookie Editor导出真实使用浏览器的Cookie为json，并保存至storage_state.json文件中。
+![Cookie Editor](./docs/images/cookie-editor-export.jpg)
+### 2. 爬取个人时间线
+```bash
+# 爬取“关注”页前 20 条
+uv run x-crawlfox x timeline --type Following --max-items 20
+
+# 爬取“推荐”页
+uv run x-crawlfox x timeline --type "For you" --max-items 50
+```
+
+### 3. 爬取今日新闻
+```bash
+# 仅爬取侧边栏列表
+uv run x-crawlfox x news
+
+# 深度爬取：进入详情页抓取摘要和相关帖子
+uv run x-crawlfox x news --detail --max-items 3
+```
+
+### 4. 抓取/监控指定用户
+```bash
+# 抓取指定用户最新的 20 条推文
+uv run x-crawlfox x user elonmusk --max-tweets 20
+
+# 增量抓取：仅抓取该用户自上次运行以来发布的新内容
+uv run x-crawlfox x user elonmusk --only-new
+```
+
+### 5. 一键执行复合任务
+编辑 `crawl_config.json`（见下文），然后运行：
+```bash
+uv run x-crawlfox x all --config crawl_config.json
+```
+
+---
+
+## ⚙️ 配置文件示例 (`crawl_config.json`)
+
+```json
+{
+    "timeline": [
+        { "type": "Following", "max_items": 10 },
+        { "type": "For you", "max_items": 10 }
+    ],
+    "news": {
+        "enabled": true,
+        "detail": true,
+        "max_items": 5
+    },
+    "monitor": [
+        { "username": "elonmusk", "only_new": true, "max_tweets": 10 },
+        { "username": "OpenAI", "only_new": true, "max_tweets": 5 }
+    ]
+}
+```
+
+---
+
+## 🛡️ 防风控与鲁棒性优化
+
+- **内存释放**：在多账号监控间隙自动跳转 `about:blank`，强制释放 X 平台庞大的 React 内存堆，防止长时间运行崩溃。
+- **自动恢复**：检测到 `Target page closed` 或页面报错时，系统会自动尝试重建页面或点击 `Retry` 按钮。
+- **异步等待**：全量使用 Playwright 的非阻塞 `wait_for_timeout` 机制，提升自动化执行的稳定性。
+- **随机行为**：内置随机滚动距离、随机停顿时间以及拟人化的鼠标移动。
+
+---
+
+## 📁 数据输出
+所有抓取结果均以 `.jsonl` 格式保存于 `output/` 目录下，方便进行后续的数据分析或入库。
+
+---
+
+## 🙏 感谢
+
+This project integrates and references these excellent open-source projects:
+
+- [Camoufox](https://github.com/daijro/camoufox): Powerful browser fingerprint obfuscation and human-like interaction.
+- [Playwright](https://playwright.dev/): Fast and robust automation and scraping framework.
+- [uv](https://github.com/astral-sh/uv): Extremely efficient Python package manager.
+- [Loguru](https://github.com/Delgan/loguru) & [Typer](https://typer.tiangolo.com/): For elegant logging and CLI interactions.
+
+---
+
+## ⚠️ 免责声明
+本工具仅供学习和研究目的使用。请遵守 X (Twitter) 的服务条款。因使用本工具导致的账号限制或法律纠纷，由使用者自行承担。

x_crawlfox-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "x-crawlfox"
+version = "0.1.0"
+description = "Implementing X (Twitter) data crawling based on Camoufox, for personal use."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "beautifulsoup4>=4.14.3",
+    "camoufox>=0.4.11",
+    "typer>=0.15.1",
+    "loguru>=0.7.3",
+    "pydantic>=2.10.6",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[project.scripts]
+x-crawlfox = "x_crawlfox.cli.main:app"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]

x_crawlfox-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+