deepwiki2md 1.1.0__tar.gz

deepwiki2md-1.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-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/
+cover/
+
+# Translations
+# *.mo  # .moファイルはlocale/以下で追跡するためコメントアウト
+*.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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

deepwiki2md-1.1.0/LICENSE

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

deepwiki2md-1.1.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: deepwiki2md
+Version: 1.1.0
+Summary: DeepWikiからドキュメントを取得し、Markdown形式に変換するツール
+Project-URL: Homepage, https://github.com/matsu582/deepwiki2md
+Project-URL: Repository, https://github.com/matsu582/deepwiki2md
+Project-URL: Issues, https://github.com/matsu582/deepwiki2md/issues
+Author: animalmatsuzawa
+License: MIT
+License-File: LICENSE
+Keywords: converter,deepwiki,documentation,export,markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4<5,>=4.12.0
+Requires-Dist: selenium<5,>=4.37.0
+Requires-Dist: webdriver-manager<5,>=4.0.0
+Description-Content-Type: text/markdown
+
+# DeepWiki Export Tool
+
+A tool to retrieve documents from DeepWiki and convert them to Markdown format.
+
+## Supported Sites
+
+- **app.devin.ai/wiki** - Devin Wiki (Login required, language selection available)
+- **deepwiki.com** - DeepWiki (No login required, no language selection)
+
+## Features
+
+- Automatic content retrieval using Selenium
+- Automatic detection of two site formats
+- HTML to Markdown conversion (supports tables, code blocks, lists)
+- SVG diagram saving and conversion to Mermaid notation
+  - Flowcharts
+  - Sequence diagrams
+  - State diagrams
+  - Class diagrams
+- PNG image output (generated by rendering SVG in browser)
+- Automatic table of contents generation
+- Internal link to relative path conversion
+- `<details>` tag (collapsible) support
+- Session persistence (app.devin.ai/wiki only, no login required after first time)
+
+### Operation Modes
+
+This tool has two operation modes.
+
+**CUI Mode (Default)**
+
+This mode runs in the background without displaying a browser window. When login is required, you enter your email address and authentication code in the terminal. It is suitable for execution in server environments without GUI (such as SSH connections). However, it does not support OAuth authentication (GitHub/Google, etc.), so only email + authentication code login is available.
+
+**GUI Mode (--no-headless)**
+
+This mode runs with the browser window displayed. It is useful for initial setup and debugging as you can visually confirm login operations. Use this mode if you want to log in with OAuth authentication (GitHub/Google, etc.). When you specify an email address with the `-e` option, the email address is automatically entered on the login page and the Continue button is also automatically clicked.
+
+## Supported Platforms
+
+- Windows
+- macOS
+- Linux
+
+## Requirements
+
+- Python 3.10 or higher
+- Chrome/Chromium browser
+- uv (recommended) or pip
+
+## Installation (From PyPI - Recommended)
+
+```bash
+# Install with pip
+pip install deepwiki2md
+
+# Or install with uv
+uv tool install deepwiki2md
+```
+
+After installation, the `deepwiki2md` command is available:
+
+```bash
+deepwiki2md <DeepWiki URL>
+
+# Or run as a Python module
+python -m deepwiki2md <DeepWiki URL>
+```
+
+## Installation (From Source)
+
+```bash
+git clone https://github.com/matsu582/deepwiki2md.git
+cd deepwiki2md
+```
+
+### Using uv (Recommended)
+
+If uv is not installed, use the following command to install it.
+
+**Windows (PowerShell)**:
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+**macOS / Linux**:
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+```bash
+# Dependencies are resolved and installed automatically
+uv run deepwiki2md <DeepWiki URL>
+```
+
+### Using pip
+
+```bash
+# Create virtual environment (recommended)
+python -m venv .venv
+
+# Activate virtual environment
+# Windows
+.venv\Scripts\activate
+# macOS / Linux
+source .venv/bin/activate
+
+# Install from source
+pip install -e .
+
+# Run
+deepwiki2md <DeepWiki URL>
+```
+
+### Without Installation (dependencies only)
+
+You can run the tool directly without installing the package itself:
+
+```bash
+# Install dependencies only
+pip install selenium beautifulsoup4 webdriver-manager
+
+# Run as a Python module from the repository root
+python -m deepwiki2md <DeepWiki URL>
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+# Installed from PyPI
+deepwiki2md <DeepWiki URL>
+
+# Using uv from cloned source (no install needed)
+uv run deepwiki2md <DeepWiki URL>
+
+# As a Python module (from cloned source root)
+python -m deepwiki2md <DeepWiki URL>
+```
+
+### Options
+
+| Option                 | Description                              | Default                 |
+| ---------------------- | ---------------------------------------- | ----------------------- |
+| `-o`, `--output`       | Output directory                         | `output`                |
+| `-l`, `--lang`         | Language selection                       | `japanese`              |
+| `-d`, `--diagram_type` | Diagram output type                      | `mermaid,svg`           |
+| `-e`, `--email`        | Email address for login                  | None (prompt displayed) |
+| `--no-headless`        | Run in GUI mode (display browser window) | `false`                 |
+
+### Diagram Output Type (--diagram_type)
+
+- `png`: PNG images only
+- `svg`: SVG images only
+- `mermaid`: Mermaid notation only
+- Multiple formats (comma-separated): `png,mermaid,svg`
+- First format is displayed directly, others are in `<details>` collapsible sections
+
+### Examples
+
+```bash
+# app.devin.ai/wiki (login required)
+deepwiki2md https://app.devin.ai/wiki/owner/repo
+
+# deepwiki.com (no login required)
+deepwiki2md https://deepwiki.com/owner/repo
+
+# Specify output directory
+deepwiki2md https://deepwiki.com/owner/repo -o ./my_docs
+
+# Retrieve in English (app.devin.ai/wiki only)
+deepwiki2md https://app.devin.ai/wiki/owner/repo -l english
+
+# PNG images only
+deepwiki2md https://deepwiki.com/owner/repo -d png
+
+# PNG first, Mermaid and SVG in collapsible sections
+deepwiki2md https://deepwiki.com/owner/repo -d png,mermaid,svg
+
+# Specify email address
+deepwiki2md https://app.devin.ai/wiki/owner/repo -e user@example.com
+
+# Run in GUI mode (display browser window)
+deepwiki2md https://app.devin.ai/wiki/owner/repo --no-headless
+```
+
+## Execution Flow
+
+### For app.devin.ai/wiki
+
+1. The tool launches a Chrome browser
+2. If a login page is displayed, please log in manually
+3. After logging in, press Enter in the terminal
+4. The specified language is automatically selected on the language selection screen
+5. Language selection defaults to **Japanese**. The Japanese DeepWiki must already be created.
+6. The tool automatically retrieves all sections and converts them to Markdown
+
+### For deepwiki.com
+
+1. The tool launches a Chrome browser
+2. No login required - the page loads automatically
+3. The tool automatically retrieves all sections and converts them to Markdown
+
+### Default Behavior (Headless Mode)
+
+1. The tool launches a headless browser (no display)
+2. If a login page is detected, you will be prompted to enter your email address via CUI
+   - If you specify an email address with the `-e` option, the input prompt will be skipped
+3. After entering your email, an authentication code will be sent to your email
+4. If an authentication code page is detected, you will be prompted to enter the code via CUI
+5. After successful login, the tool automatically retrieves all sections and converts them to Markdown
+
+**Note**: Headless mode only supports email + authentication code method. If you want to log in with OAuth (GitHub/Google, etc.), use the `--no-headless` option to run in GUI mode.
+
+## Output Files
+
+```
+output_directory/
+├── 00_table_of_contents.md  # Table of contents
+├── 01_Overview.md            # Markdown for each section
+├── 02_System_Architecture.md
+├── ...
+└── images/                   # SVG diagrams
+    ├── 01_Overview_01.svg
+    ├── 01_Overview_02.svg
+    └── ...
+```
+
+## File Structure
+
+```
+deepwiki2md/
+├── deepwiki2md/
+│   ├── __init__.py           # Package initialization / version info
+│   ├── __main__.py           # python -m deepwiki2md support
+│   ├── cli.py                # Main script (entry point)
+│   ├── extract_subgraphs.py  # SVG to Mermaid conversion
+│   ├── html_to_markdown.py   # HTML to Markdown conversion
+│   └── locale/               # i18n translation files
+│       └── ja/LC_MESSAGES/
+├── pyproject.toml            # Project configuration
+├── README.md
+├── README_JP.md
+└── LICENSE
+```
+
+## Troubleshooting
+
+### ChromeDriver Error
+
+webdriver-manager automatically downloads ChromeDriver, but
+if problems occur, install it manually:
+
+- Windows: https://chromedriver.chromium.org/downloads
+- macOS: `brew install chromedriver`
+- Linux: `apt install chromium-chromedriver`
+
+### Reset Login Session
+
+Session information is saved in the following location:
+
+- Windows: `%LOCALAPPDATA%\DeepWiki2Md\chrome_profile`
+- macOS: `~/Library/Application Support/DeepWiki2Md/chrome_profile`
+- Linux: `~/.config/deepwiki2md/chrome_profile`
+
+If problems occur, delete this directory.
+
+## Supported DeepWiki Version
+
+This tool is compatible with the DeepWiki site structure as of the following dates.
+
+| Site | Verified | Key Structures |
+| --- | --- | --- |
+| deepwiki.com | 2026-06-23 | Content: `div[class*="prose-custom"]`, Sidebar: link-based |
+| app.devin.ai/wiki | 2026-06-23 | Content: `div.prose-main`, Sidebar: `a[href*="/page/"]` (/page/X.Y format), Language: `menuitemradio` inside "..." menu, URL: `/org/{org}/wiki/{owner}/{repo}/page/{num}` |
+
+DeepWiki's site structure may change without notice. If the tool stops working, a structural change is likely the cause.
+
+## Notes
+
+- app.devin.ai/wiki requires login on first run
+- deepwiki.com does not require login
+- Exporting may take time if there are many pages
+- Timeouts may occur depending on network conditions
+- Language selection option (`-l`) is ignored for deepwiki.com

deepwiki2md-1.1.0/QR/00_table_of_contents.md

@@ -0,0 +1,3 @@
+# 目次
+
+- [01 NTTDATA_CCS](01_NTTDATA_CCS.md)

deepwiki2md-1.1.0/QR/01_NTTDATA_CCS.md

@@ -0,0 +1,2 @@
+# NTTDATA_CCS
+