repowiki 0.1.0__tar.gz

repowiki-0.1.0/.env.example

@@ -0,0 +1,13 @@
+# RepoWiki configuration
+# Copy to .env and fill in your values
+
+# LLM provider API keys (set at least one)
+# OPENAI_API_KEY=sk-xxx
+# DEEPSEEK_API_KEY=sk-xxx
+# ANTHROPIC_API_KEY=sk-xxx
+
+# Default model (optional, defaults to deepseek/deepseek-chat)
+# REPOWIKI_MODEL=deepseek/deepseek-chat
+
+# Output language (en, zh, ja, ko)
+# REPOWIKI_LANG=en

repowiki-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check src/
+
+      - name: Run tests
+        run: pytest tests/ -v

repowiki-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build frontend
+        working-directory: frontend
+        run: |
+          npm install
+          npm run build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

repowiki-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+
+.venv/
+venv/
+env/
+
+.env
+.env.local
+
+*.db
+*.sqlite3
+
+.idea/
+.vscode/
+*.swp
+*.swo
+
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+
+node_modules/
+frontend/dist/
+src/repowiki/server/static/
+
+.DS_Store
+Thumbs.db

repowiki-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yufeng He
+
+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.

repowiki-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: repowiki
+Version: 0.1.0
+Summary: Open-source DeepWiki alternative - generate comprehensive wiki documentation for any codebase
+Project-URL: Homepage, https://github.com/he-yufeng/RepoWiki
+Project-URL: Repository, https://github.com/he-yufeng/RepoWiki
+Project-URL: Issues, https://github.com/he-yufeng/RepoWiki/issues
+Author-email: Yufeng He <40085740+he-yufeng@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai,code-analysis,codebase,deepwiki,developer-tools,documentation,llm,repository,wiki
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: click>=8.0
+Requires-Dist: litellm>=1.40.0
+Requires-Dist: networkx>=3.0
+Requires-Dist: numpy>=1.24
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: web
+Requires-Dist: fastapi>=0.115.0; extra == 'web'
+Requires-Dist: python-multipart>=0.0.9; extra == 'web'
+Requires-Dist: uvicorn[standard]>=0.30.0; extra == 'web'
+Description-Content-Type: text/markdown
+
+# RepoWiki
+
+**Open-source DeepWiki alternative** — generate comprehensive wiki documentation for any codebase from your terminal or browser.
+
+[中文文档](README_CN.md)
+
+## Why RepoWiki?
+
+| | DeepWiki | deepwiki-open | **RepoWiki** |
+|---|---------|--------------|-------------|
+| Deploy | SaaS only | Docker Compose | **`pip install repowiki`** |
+| Local repos | No | No | **Yes** |
+| CLI | No | No | **Yes** |
+| Web UI | Yes | Yes | **Yes** |
+| Export | Web only | Web only | **Markdown / JSON / HTML** |
+| Reading guide | No | No | **PageRank + guided path** |
+| Terminal Q&A | No | No | **`repowiki chat`** |
+| Dependencies | N/A | Docker + PostgreSQL | **Python + SQLite** |
+
+## Quick Start
+
+```bash
+pip install repowiki
+
+# set your API key (DeepSeek, OpenAI, Anthropic, etc.)
+export DEEPSEEK_API_KEY=sk-xxx
+# or
+repowiki config set api_key sk-xxx
+
+# scan a local project
+repowiki scan ./my-project
+
+# scan a GitHub repo
+repowiki scan https://github.com/pallets/flask
+
+# generate self-contained HTML
+repowiki scan ./my-project --format html --open
+
+# start the web interface
+pip install repowiki[web]
+repowiki serve
+```
+
+## Features
+
+### Wiki Generation
+Automatically generates structured documentation for any codebase:
+- **Project overview** — what it does, tech stack, setup instructions
+- **Module documentation** — purpose, key files, relationships, important functions
+- **Architecture diagrams** — auto-detected architecture type with Mermaid visualizations
+- **Reading guide** — "start here" path based on PageRank file importance ranking
+
+### Multiple Output Formats
+- **Markdown** — directory of `.md` files, ready to commit to your repo
+- **JSON** — structured data for API consumption or custom rendering
+- **HTML** — self-contained single file, share with anyone (Mermaid diagrams included)
+
+### Web Interface
+Three-column wiki viewer with sidebar navigation, Mermaid diagram rendering, and an AI-powered Q&A chat about the codebase.
+
+### CLI-First Design
+Everything works from the terminal. No Docker, no database server, no web browser required.
+
+```bash
+repowiki scan .                    # generate wiki
+repowiki scan . -f html --open     # open in browser
+repowiki scan . -l zh              # Chinese output
+repowiki chat .                    # ask questions (coming soon)
+repowiki config list               # show configuration
+```
+
+## Supported Languages
+
+Python, JavaScript, TypeScript, Go, Rust, Java, Kotlin, C/C++, C#, Ruby, PHP, Swift, Dart, Vue, Svelte, and 30+ more.
+
+## Supported LLM Providers
+
+Powered by [litellm](https://github.com/BerriAI/litellm), RepoWiki works with 100+ LLM providers:
+
+| Provider | Model | Alias |
+|----------|-------|-------|
+| Anthropic | Claude Opus 4.6 | `opus` |
+| Anthropic | Claude Sonnet 4.6 | `claude` |
+| OpenAI | GPT-5.4 | `gpt` |
+| OpenAI | GPT-5.4 Mini | `gpt-mini` |
+| Google | Gemini 3.1 Pro | `gemini` |
+| Google | Gemini 2.5 Flash | `gemini-flash` |
+| DeepSeek | DeepSeek V3.2 | `deepseek` |
+| Alibaba | Qwen3.5 Plus | `qwen` |
+| Moonshot | Kimi K2.6 | `kimi` |
+| Zhipu | GLM-5 | `glm` |
+| MiniMax | M2.7 | `minimax` |
+
+```bash
+repowiki config set model deepseek    # use alias
+repowiki scan . -m gpt                # or pass directly
+```
+
+## Configuration
+
+RepoWiki looks for config in this order:
+1. CLI flags (`-m`, `-l`, `-o`)
+2. Environment variables (`REPOWIKI_MODEL`, `REPOWIKI_API_KEY`)
+3. Config file (`~/.repowiki/config.json`)
+4. Provider-specific env vars (`DEEPSEEK_API_KEY`, `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`)
+
+## Project Structure
+
+```
+RepoWiki/
+├── src/repowiki/
+│   ├── cli.py              # Click CLI with scan/serve/chat/config commands
+│   ├── config.py           # Configuration management
+│   ├── core/
+│   │   ├── scanner.py      # File scanning with language detection
+│   │   ├── analyzer.py     # Multi-step LLM analysis pipeline
+│   │   ├── graph.py        # Dependency graph + PageRank
+│   │   ├── wiki_builder.py # Wiki page assembly
+│   │   ├── rag.py          # TF-IDF retrieval for Q&A
+│   │   └── cache.py        # SQLite caching
+│   ├── llm/
+│   │   ├── client.py       # litellm async wrapper
+│   │   └── prompts.py      # Structured prompt templates
+│   ├── ingest/
+│   │   ├── local.py        # Local directory ingestion
+│   │   └── github.py       # Git clone with caching
+│   ├── export/
+│   │   ├── markdown.py     # Markdown directory export
+│   │   ├── json_export.py  # JSON export
+│   │   └── html.py         # Self-contained HTML export
+│   └── server/             # FastAPI web backend
+├── frontend/               # React + Vite + TailwindCSS
+├── pyproject.toml
+└── LICENSE
+```
+
+## How It Works
+
+1. **Scan** — Walk the directory tree, filter out binaries and generated files, detect languages and entry points
+2. **Graph** — Parse import statements across 6 languages, build a dependency graph, run PageRank to rank file importance
+3. **Analyze** — Send file tree + key files to LLM in 4 structured passes (overview, modules, architecture, reading guide)
+4. **Cache** — Store results in SQLite keyed by content hash, skip unchanged files on re-scan
+5. **Export** — Assemble wiki pages with Mermaid diagrams and source links, output in chosen format
+
+## Development
+
+```bash
+git clone https://github.com/he-yufeng/RepoWiki.git
+cd RepoWiki
+
+# backend
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev,web]"
+
+# frontend
+cd frontend && npm install && npm run dev
+
+# run backend
+repowiki serve --port 8000
+```
+
+## License
+
+MIT

repowiki-0.1.0/README.md

@@ -0,0 +1,164 @@
+# RepoWiki
+
+**Open-source DeepWiki alternative** — generate comprehensive wiki documentation for any codebase from your terminal or browser.
+
+[中文文档](README_CN.md)
+
+## Why RepoWiki?
+
+| | DeepWiki | deepwiki-open | **RepoWiki** |
+|---|---------|--------------|-------------|
+| Deploy | SaaS only | Docker Compose | **`pip install repowiki`** |
+| Local repos | No | No | **Yes** |
+| CLI | No | No | **Yes** |
+| Web UI | Yes | Yes | **Yes** |
+| Export | Web only | Web only | **Markdown / JSON / HTML** |
+| Reading guide | No | No | **PageRank + guided path** |
+| Terminal Q&A | No | No | **`repowiki chat`** |
+| Dependencies | N/A | Docker + PostgreSQL | **Python + SQLite** |
+
+## Quick Start
+
+```bash
+pip install repowiki
+
+# set your API key (DeepSeek, OpenAI, Anthropic, etc.)
+export DEEPSEEK_API_KEY=sk-xxx
+# or
+repowiki config set api_key sk-xxx
+
+# scan a local project
+repowiki scan ./my-project
+
+# scan a GitHub repo
+repowiki scan https://github.com/pallets/flask
+
+# generate self-contained HTML
+repowiki scan ./my-project --format html --open
+
+# start the web interface
+pip install repowiki[web]
+repowiki serve
+```
+
+## Features
+
+### Wiki Generation
+Automatically generates structured documentation for any codebase:
+- **Project overview** — what it does, tech stack, setup instructions
+- **Module documentation** — purpose, key files, relationships, important functions
+- **Architecture diagrams** — auto-detected architecture type with Mermaid visualizations
+- **Reading guide** — "start here" path based on PageRank file importance ranking
+
+### Multiple Output Formats
+- **Markdown** — directory of `.md` files, ready to commit to your repo
+- **JSON** — structured data for API consumption or custom rendering
+- **HTML** — self-contained single file, share with anyone (Mermaid diagrams included)
+
+### Web Interface
+Three-column wiki viewer with sidebar navigation, Mermaid diagram rendering, and an AI-powered Q&A chat about the codebase.
+
+### CLI-First Design
+Everything works from the terminal. No Docker, no database server, no web browser required.
+
+```bash
+repowiki scan .                    # generate wiki
+repowiki scan . -f html --open     # open in browser
+repowiki scan . -l zh              # Chinese output
+repowiki chat .                    # ask questions (coming soon)
+repowiki config list               # show configuration
+```
+
+## Supported Languages
+
+Python, JavaScript, TypeScript, Go, Rust, Java, Kotlin, C/C++, C#, Ruby, PHP, Swift, Dart, Vue, Svelte, and 30+ more.
+
+## Supported LLM Providers
+
+Powered by [litellm](https://github.com/BerriAI/litellm), RepoWiki works with 100+ LLM providers:
+
+| Provider | Model | Alias |
+|----------|-------|-------|
+| Anthropic | Claude Opus 4.6 | `opus` |
+| Anthropic | Claude Sonnet 4.6 | `claude` |
+| OpenAI | GPT-5.4 | `gpt` |
+| OpenAI | GPT-5.4 Mini | `gpt-mini` |
+| Google | Gemini 3.1 Pro | `gemini` |
+| Google | Gemini 2.5 Flash | `gemini-flash` |
+| DeepSeek | DeepSeek V3.2 | `deepseek` |
+| Alibaba | Qwen3.5 Plus | `qwen` |
+| Moonshot | Kimi K2.6 | `kimi` |
+| Zhipu | GLM-5 | `glm` |
+| MiniMax | M2.7 | `minimax` |
+
+```bash
+repowiki config set model deepseek    # use alias
+repowiki scan . -m gpt                # or pass directly
+```
+
+## Configuration
+
+RepoWiki looks for config in this order:
+1. CLI flags (`-m`, `-l`, `-o`)
+2. Environment variables (`REPOWIKI_MODEL`, `REPOWIKI_API_KEY`)
+3. Config file (`~/.repowiki/config.json`)
+4. Provider-specific env vars (`DEEPSEEK_API_KEY`, `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`)
+
+## Project Structure
+
+```
+RepoWiki/
+├── src/repowiki/
+│   ├── cli.py              # Click CLI with scan/serve/chat/config commands
+│   ├── config.py           # Configuration management
+│   ├── core/
+│   │   ├── scanner.py      # File scanning with language detection
+│   │   ├── analyzer.py     # Multi-step LLM analysis pipeline
+│   │   ├── graph.py        # Dependency graph + PageRank
+│   │   ├── wiki_builder.py # Wiki page assembly
+│   │   ├── rag.py          # TF-IDF retrieval for Q&A
+│   │   └── cache.py        # SQLite caching
+│   ├── llm/
+│   │   ├── client.py       # litellm async wrapper
+│   │   └── prompts.py      # Structured prompt templates
+│   ├── ingest/
+│   │   ├── local.py        # Local directory ingestion
+│   │   └── github.py       # Git clone with caching
+│   ├── export/
+│   │   ├── markdown.py     # Markdown directory export
+│   │   ├── json_export.py  # JSON export
+│   │   └── html.py         # Self-contained HTML export
+│   └── server/             # FastAPI web backend
+├── frontend/               # React + Vite + TailwindCSS
+├── pyproject.toml
+└── LICENSE
+```
+
+## How It Works
+
+1. **Scan** — Walk the directory tree, filter out binaries and generated files, detect languages and entry points
+2. **Graph** — Parse import statements across 6 languages, build a dependency graph, run PageRank to rank file importance
+3. **Analyze** — Send file tree + key files to LLM in 4 structured passes (overview, modules, architecture, reading guide)
+4. **Cache** — Store results in SQLite keyed by content hash, skip unchanged files on re-scan
+5. **Export** — Assemble wiki pages with Mermaid diagrams and source links, output in chosen format
+
+## Development
+
+```bash
+git clone https://github.com/he-yufeng/RepoWiki.git
+cd RepoWiki
+
+# backend
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev,web]"
+
+# frontend
+cd frontend && npm install && npm run dev
+
+# run backend
+repowiki serve --port 8000
+```
+
+## License
+
+MIT

repowiki-0.1.0/README_CN.md

@@ -0,0 +1,121 @@
+# RepoWiki
+
+**开源 DeepWiki 替代品** — 从终端或浏览器为任意代码仓库生成完整 wiki 文档。
+
+[English](README.md)
+
+## 为什么选 RepoWiki？
+
+| | DeepWiki | deepwiki-open | **RepoWiki** |
+|---|---------|--------------|-------------|
+| 部署方式 | SaaS，不可自托管 | Docker Compose | **`pip install repowiki`** |
+| 本地仓库 | 不支持 | 不支持 | **原生支持** |
+| CLI | 无 | 无 | **有** |
+| Web UI | 有 | 有 | **有** |
+| 导出格式 | 仅网页 | 仅网页 | **Markdown / JSON / HTML** |
+| 阅读指南 | 无 | 无 | **PageRank 排名 + 阅读路径** |
+| 终端问答 | 无 | 无 | **`repowiki chat`** |
+| 依赖 | N/A | Docker + PostgreSQL | **Python + SQLite** |
+
+## 快速开始
+
+```bash
+pip install repowiki
+
+# 设置 API Key（DeepSeek、OpenAI、Anthropic 等）
+export DEEPSEEK_API_KEY=sk-xxx
+# 或者
+repowiki config set api_key sk-xxx
+
+# 扫描本地项目
+repowiki scan ./my-project
+
+# 扫描 GitHub 仓库
+repowiki scan https://github.com/pallets/flask
+
+# 生成自包含 HTML 并打开
+repowiki scan ./my-project --format html --open
+
+# 启动 Web 界面
+pip install repowiki[web]
+repowiki serve
+```
+
+## 核心功能
+
+### Wiki 生成
+自动为任意代码仓库生成结构化文档：
+- **项目概览** — 做什么、技术栈、如何运行
+- **模块文档** — 用途、关键文件、模块间关系、重要函数
+- **架构图** — 自动识别架构模式，Mermaid 可视化
+- **阅读指南** — 基于 PageRank 文件重要性排名的"从这里开始读"路径
+
+### 多格式导出
+- **Markdown** — `.md` 文件目录，可以直接放进仓库当文档用
+- **JSON** — 结构化数据，方便 API 消费或自定义渲染
+- **HTML** — 自包含单文件，分享给任何人都能直接打开（内含 Mermaid 图表）
+
+### Web 界面
+三栏布局 wiki 查看器：侧边导航 + 内容区 + Mermaid 图表，还有 AI 问答聊天功能。
+
+### CLI 优先
+所有功能都能在终端完成。不需要 Docker，不需要数据库，不需要浏览器。
+
+```bash
+repowiki scan .                    # 生成 wiki
+repowiki scan . -f html --open     # 浏览器打开
+repowiki scan . -l zh              # 中文输出
+repowiki chat .                    # 终端问答（即将推出）
+repowiki config list               # 查看配置
+```
+
+## 支持的语言
+
+Python、JavaScript、TypeScript、Go、Rust、Java、Kotlin、C/C++、C#、Ruby、PHP、Swift、Dart、Vue、Svelte 等 30+ 种编程语言。
+
+## 支持的 LLM 提供商
+
+基于 [litellm](https://github.com/BerriAI/litellm)，支持 100+ LLM 提供商：
+
+| 提供商 | 模型 | 别名 |
+|--------|------|------|
+| Anthropic | Claude Opus 4.6 | `opus` |
+| Anthropic | Claude Sonnet 4.6 | `claude` |
+| OpenAI | GPT-5.4 | `gpt` |
+| OpenAI | GPT-5.4 Mini | `gpt-mini` |
+| Google | Gemini 3.1 Pro | `gemini` |
+| Google | Gemini 2.5 Flash | `gemini-flash` |
+| DeepSeek | DeepSeek V3.2 | `deepseek` |
+| 阿里云 | Qwen3.5 Plus | `qwen` |
+| 月之暗面 | Kimi K2.6 | `kimi` |
+| 智谱 | GLM-5 | `glm` |
+| MiniMax | M2.7 | `minimax` |
+
+## 工作原理
+
+1. **扫描** — 遍历目录树，过滤二进制和生成文件，检测语言和入口文件
+2. **建图** — 解析 6 种语言的 import 语句，构建依赖图，PageRank 计算文件重要性
+3. **分析** — 4 步 LLM 分析（概览、模块、架构、阅读指南），并发执行
+4. **缓存** — SQLite 按内容 hash 缓存，重新扫描时跳过未变更文件
+5. **导出** — 组装 wiki 页面，注入 Mermaid 图和源码链接，按选定格式输出
+
+## 开发
+
+```bash
+git clone https://github.com/he-yufeng/RepoWiki.git
+cd RepoWiki
+
+# 后端
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev,web]"
+
+# 前端
+cd frontend && npm install && npm run dev
+
+# 启动后端
+repowiki serve --port 8000
+```
+
+## 许可证
+
+MIT

repowiki-0.1.0/frontend/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>RepoWiki</title>
+</head>
+<body>
+  <div id="root"></div>
+  <script type="module" src="/src/main.tsx"></script>
+</body>
+</html>