mddocx 0.4.3__tar.gz

mddocx-0.4.3/LICENSE

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

mddocx-0.4.3/MANIFEST.in

@@ -0,0 +1,10 @@
+# 包含webui目录
+recursive-include src/mddocx/webui *.py
+recursive-include src/mddocx/webui *.html
+recursive-include src/mddocx/webui *.css
+recursive-include src/mddocx/webui *.js
+recursive-include src/mddocx/webui *.md
+
+# 包含其他重要文件
+include LICENSE
+include README.md

mddocx-0.4.3/PKG-INFO

@@ -0,0 +1,377 @@
+Metadata-Version: 2.4
+Name: mddocx
+Version: 0.4.3
+Summary: 一个功能强大的 Markdown 转 DOCX 文档转换工具
+Author-email: "jw.zhou" <zhou24388@163.com>
+License: MIT
+Project-URL: Homepage, https://github.com/wangqiqi/md2docx
+Project-URL: Repository, https://github.com/wangqiqi/md2docx
+Project-URL: Documentation, https://github.com/wangqiqi/md2docx#readme
+Project-URL: Issues, https://github.com/wangqiqi/md2docx/issues
+Keywords: markdown,docx,converter,document,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Topic :: Text Processing :: Markup
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-docx>=0.8.11
+Requires-Dist: markdown-it-py>=2.1.0
+Requires-Dist: flask>=2.0.0
+Requires-Dist: werkzeug>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: coverage>=7.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "docs"
+Dynamic: license-file
+
+# Markdown to DOCX 转换工具
+
+[![Version](https://img.shields.io/badge/version-0.4.3-blue.svg)](https://github.com/wangqiqi/md2docx/releases/tag/v0.4.3)
+[![Cursor AI Rules](https://img.shields.io/badge/Cursor%20AI%20Rules-v3.0.0-green.svg)](https://github.com/wangqiqi/cursor-ai-rules)
+
+一个功能强大的 Markdown 转 DOCX 文档转换工具，支持丰富的 Markdown 语法，提供命令行和批量转换功能，能够生成格式精美的 DOCX 文档。
+
+**✨ 新版本特性：**
+- 🤖 集成 Cursor AI 协作规则系统 v3.0.0
+- 🧠 智能项目感知和自动进化
+- 🌍 多语言协作环境支持
+- 📊 实时项目分析和优化建议
+
+## 特性
+
+- 支持标准 Markdown 语法
+- 完整的格式转换（标题、列表、代码块、表格、引用、图片等）
+- 批量转换功能
+- 命令行接口
+- 本地处理，保护隐私
+
+## 已实现功能
+
+- ✅ 标题转换（h1-h6）
+- ✅ 段落和文本样式（粗体、斜体、删除线）
+- ✅ 引用块（支持多层嵌套）
+- ✅ 列表转换（有序列表、无序列表、多级嵌套）
+- ✅ 代码块（支持语法高亮）
+- ✅ 链接处理（内联链接、引用链接、URL自动链接）
+- ✅ 图片支持（本地图片、在线图片）
+- ✅ 表格转换（基础表格、对齐方式）
+- ✅ 分隔线
+- ✅ 任务列表（TODO列表）
+- ✅ 基础HTML标签支持
+- ✅ Web界面 (Flask + HTML5 + CSS3)
+- ✅ 实时预览功能
+- ✅ 文件上传和下载
+- ✅ 响应式设计 (桌面/移动)
+- ✅ 一次性阅读体验 (无页面滚动)
+- ✅ 防抖优化和安全文件处理
+
+## 质量保证
+
+项目采用专业级的质量保证体系，确保代码可靠性和开发效率：
+
+### 🧪 测试体系
+- **19个测试用例** - 覆盖核心功能和边界条件
+- **85%+ 代码覆盖率** - 多维度测试保证
+- **大文件测试** - 支持1MB+文档处理
+- **边界条件测试** - Unicode、嵌套、异常输入
+- **Web界面测试** - 完整的用户界面功能验证
+
+### 🔄 CI/CD 自动化
+- **GitHub Actions** - 多Python版本测试 (3.8-3.12)
+- **自动化检查** - 代码质量、格式、安全性
+- **持续集成** - 每次提交自动验证
+
+### 🛠️ 开发工具链
+- **pre-commit** - 提交前代码质量检查
+- **black + isort** - 自动代码格式化和导入排序
+- **flake8** - 代码风格和错误检查
+- **依赖分离** - 开发/生产环境独立配置
+
+## 规划与路线图
+
+📋 详细的开发规划和功能路线图请查看：[项目规划文档](docs/plan.md)
+
+**已完成 ✅:**
+- ✅ 专业测试体系 (89个测试，85%+覆盖率)
+- ✅ CI/CD自动化 (GitHub Actions多版本测试)
+- ✅ 代码质量保证 (pre-commit + 多工具检查)
+
+**已完成 ✅:**
+- ✅ Web界面 (Flask + HTML5 + CSS3) (Phase 2完成)
+- ✅ 实时预览功能 (Phase 2完成)
+- ✅ 响应式设计 (Phase 2完成)
+
+**开发中 🔄:**
+- 🔄 自定义样式配置 (v0.4.0)
+- 🔄 性能优化 (v0.4.0)
+
+**规划中 📋:**
+- 🔲 数学公式支持 (v0.5.0)
+- 🔲 流程图支持 (v0.5.0)
+- 🔲 双向转换 (v0.6.0)
+- 🔲 插件系统 (v1.0.0)
+
+## 开发环境要求
+
+- Python 3.8+
+- python-docx
+- markdown-it-py
+- 其他依赖见 requirements.txt
+
+## 安装
+
+### PyPI 安装（推荐）
+
+直接从 PyPI 安装最新稳定版本：
+
+```bash
+pip install mddocx
+```
+
+**安装后即可使用完整功能：**
+- 命令行工具：`mddocx`
+- Web界面：`mddocx-webui`
+
+### 开发环境安装
+
+如果您要进行开发、测试或贡献代码：
+
+1. 克隆仓库：
+```bash
+git clone [repository-url]
+cd mddocx
+```
+
+2. 创建虚拟环境：
+```bash
+python -m venv venv
+source venv/bin/activate  # Linux/Mac
+# 或
+venv\Scripts\activate  # Windows
+```
+
+3. 安装开发依赖：
+```bash
+pip install -e .[dev]
+```
+
+### 生产环境安装
+
+如果您只是想使用 mddocx 进行文档转换：
+
+```bash
+pip install -r requirements-prod.txt
+```
+
+或直接从 PyPI 安装：
+```bash
+pip install mddocx
+```
+
+**安装后即可使用完整功能：**
+- 命令行工具：`mddocx`
+- Web界面：`mddocx-webui`
+
+### 依赖说明
+
+- **`requirements-prod.txt`**：仅包含运行时必需的依赖，轻量化安装
+- **`pyproject.toml`**：现代化的项目配置，包含依赖管理和构建配置
+- **`requirements.txt`**：指向开发依赖的符号链接，向后兼容
+
+## 使用方法
+
+### Web界面 (推荐)
+
+最简单的方式是使用内置的Web界面：
+
+```bash
+# 方法1：使用pip安装后运行（推荐）
+mddocx-webui
+
+# 方法2：使用命令行工具（推荐）
+mddocx-webui
+
+# 方法3：直接运行模块（源码运行）
+python -m webui.app
+
+# 方法4：通过导入运行（源码运行）
+python -c "from webui.app import app; app.run(debug=True)"
+```
+
+启动后在浏览器中访问: `http://localhost:5000`
+
+**Web界面特性：**
+- 🎨 **一次性阅读体验**：页面无需滚动即可完整查看
+- ⚡ **实时预览**：输入Markdown后立即预览DOCX效果（800ms防抖优化）
+- 📁 **文件上传**：支持拖拽上传 .md、.markdown、.txt 文件
+- 🔄 **智能预览**：自动生成DOCX样式预览，支持加载状态显示
+- 🛡️ **安全处理**：严格的文件验证和内容检查，防止恶意文件
+- 📱 **响应式设计**：完美支持桌面、平板、手机等各种设备
+- ⌨️ **键盘快捷键**：
+  - `Ctrl+Enter`: 提交转换
+  - `Ctrl+Shift+P`: 切换预览面板
+- 🌟 **现代化UI**：采用Material Design风格，交互流畅
+
+**环境变量配置：**
+```bash
+# 生产环境
+export FLASK_ENV=production
+export SECRET_KEY=your-secret-key-here
+export PORT=8000
+
+# 开发环境（默认）
+export FLASK_ENV=development
+```
+
+### 命令行工具
+
+#### 单文件转换
+
+```bash
+python -m src.cli input.md output.docx
+```
+
+#### 批量转换
+
+```bash
+python scripts/batch_convert_test.py --input-dir your_md_folder --output-dir your_docx_folder
+```
+
+## 项目结构
+
+```
+md2docx/
+├── src/                    # 源代码目录
+│   └── mddocx/            # Python包
+│       ├── __init__.py    # 包初始化
+│       ├── cli.py         # 命令行接口
+│       ├── converter/     # 转换核心
+│       │   ├── __init__.py
+│       │   ├── base.py   # 基础转换类
+│       │   └── elements/ # 各类元素转换器
+│       │       ├── __init__.py
+│       │       ├── base.py     # 基础元素转换器
+│       │       ├── text.py     # 文本相关（段落、样式）
+│       │       ├── heading.py  # 标题转换
+│       │       ├── list.py     # 列表转换
+│       │       ├── code.py     # 代码块转换
+│       │       ├── table.py    # 表格转换
+│       │       ├── image.py    # 图片转换
+│       │       ├── links.py    # 链接转换
+│       │       ├── blockquote.py # 引用块转换
+│       │       ├── hr.py       # 分隔线转换
+│       │       ├── task_list.py # 任务列表转换
+│       │       └── html.py     # HTML标签转换
+│       └── webui/         # 🆕 Web界面模块
+│           ├── __init__.py
+│           ├── app.py      # Flask应用主文件
+│           ├── config.py   # 配置管理
+│           ├── start_webui.py  # WebUI启动脚本
+│           ├── templates/  # HTML模板
+│           │   ├── base.html
+│           │   ├── index.html
+│           │   └── preview.html
+│           ├── static/     # 静态文件
+│           │   ├── css/
+│           │   │   └── styles.css
+│           │   ├── img/
+│           │   └── js/
+│           │       └── app.js
+│           └── tests/      # WebUI测试
+│               ├── __init__.py
+│               └── test_basic.py
+├── tests/                 # 测试用例
+│   ├── __init__.py
+│   ├── conftest.py       # 测试配置
+│   ├── unit/            # 单元测试
+│   │   ├── __init__.py
+│   │   ├── test_edge_cases.py
+│   │   └── test_elements/ # 元素测试
+│   ├── integration/     # 集成测试
+│   └── samples/         # 测试样例
+│       ├── basic/       # 基础语法样例
+│       └── advanced/    # 高级语法样例
+├── docs/                # 项目文档
+├── scripts/             # 工具脚本目录
+│   ├── batch_convert_test.py    # 批量转换脚本
+│   └── test_roundtrip_demo.py   # 闭环测试演示
+├── dist/                # 构建产物
+├── requirements-prod.txt  # 生产环境依赖
+├── pyproject.toml          # 项目配置和依赖管理
+├── requirements.txt       # 开发依赖符号链接
+├── pyproject.toml        # 项目配置
+├── MANIFEST.in          # 打包配置
+├── .pre-commit-config.yaml  # pre-commit 配置
+├── LICENSE              # 许可证
+├── CHANGELOG.md         # 更新日志
+└── README.md           # 项目说明
+```
+
+## 开发指南
+
+请参考 `docs/architecture.md` 了解详细的架构设计和开发规范。
+
+## 测试
+
+运行测试：
+```bash
+pytest tests/
+```
+
+## 贡献指南
+
+1. Fork 项目
+2. 创建特性分支
+3. 提交变更
+4. 推送到分支
+5. 创建 Pull Request
+
+## 发布说明
+
+### 自动发布
+项目使用 GitHub Actions 和 PyPI Trusted Publisher 实现自动发布：
+
+```bash
+# 推送版本标签触发自动发布
+git tag v0.4.3
+git push origin v0.4.3
+```
+
+### 手动发布
+如果自动发布失败，可以使用手动发布脚本：
+
+```bash
+./scripts/publish_to_pypi.sh
+```
+
+### 配置 Trusted Publisher
+在 PyPI 项目设置中添加：
+- **Publisher**: GitHub
+- **Repository**: wangqiqi/md2docx
+- **Workflow**: publish.yml
+- **Environment**: (留空)
+
+## 贡献
+
+欢迎贡献代码！请查看 [贡献指南](CONTRIBUTING.md) 了解详细信息。
+
+## 许可证
+
+MIT License