paddleocr-skills 1.0.0 → 1.1.0

package/README.md

@@ -1,220 +1,220 @@
-# PaddleOCR Skills
-
-One-command installer to add PaddleOCR Skills to your Claude Code project.
-
-## Quick Start
-
-Install PaddleOCR Skills in your Claude Code project with a single command:
-
-```bash
-npx paddleocr-skills
-```
-
-The installer will:
-1. Prompt you to select skills (PP-OCRv5 and/or PaddleOCR-VL)
-2. Copy skill files to your project
-3. Install Python dependencies
-4. Guide you through API configuration
-5. Verify the installation
-
-## What's Included
-
-### PP-OCRv5 (Text OCR)
-- Fast text recognition for images and documents
-- Adaptive quality modes (auto/fast/quality)
-- Supports URLs and local files
-- Confidence scoring and quality metrics
-
-### PaddleOCR-VL (Document Parsing)
-- Advanced document structure analysis
-- Table, formula, and chart recognition
-- Layout detection (headers, footers, page numbers)
-- Complete document parsing with reading order
-
-## Prerequisites
-
-- **Node.js**: 14.0.0 or higher
-- **Python**: 3.7 or higher
-- **Claude Code**: Installed and configured
-- **API Access**: Get your API credentials at [Baidu AI Studio](https://aistudio.baidu.com/paddleocr/task)
-
-## Installation
-
-### Interactive Mode (Recommended)
-
-```bash
-npx paddleocr-skills
-```
-
-The installer will guide you through:
-- Skill selection
-- Python dependency installation
-- API configuration
-
-### Skip Configuration
-
-If you want to configure later:
-
-```bash
-npx paddleocr-skills
-# Choose "No" when asked about configuration
-```
-
-Then configure manually:
-
-```bash
-# For PP-OCRv5
-python scripts/ppocrv5/configure.py
-
-# For PaddleOCR-VL
-python scripts/paddleocr-vl/configure.py
-```
-
-## Usage
-
-After installation, use the skills in your Claude Code session:
-
-### PP-OCRv5 Example
-
-```bash
-# Extract text from an image
-python scripts/ppocrv5/ocr_caller.py --file-url "https://example.com/image.jpg" --pretty
-
-# Save result to file
-python scripts/ppocrv5/ocr_caller.py --file-path "document.pdf" --output result.json --pretty
-```
-
-### PaddleOCR-VL Example
-
-```bash
-# Parse a complex document
-python scripts/paddleocr-vl/vl_caller.py --file-url "https://example.com/paper.pdf" --pretty
-
-# Save result to file
-python scripts/paddleocr-vl/vl_caller.py --file-path "invoice.pdf" --output result.json --pretty
-```
-
-## Project Structure
-
-After installation, your project will have:
-
-```
-your-project/
-├── skills/
-│   ├── ppocrv5/
-│   │   └── SKILL.md
-│   └── paddleocr-vl/
-│       └── SKILL.md
-├── scripts/
-│   ├── ppocrv5/
-│   │   ├── ocr_caller.py
-│   │   ├── configure.py
-│   │   ├── smoke_test.py
-│   │   └── requirements.txt
-│   └── paddleocr-vl/
-│       ├── vl_caller.py
-│       ├── configure.py
-│       ├── smoke_test.py
-│       └── requirements.txt
-├── references/
-│   ├── ppocrv5/
-│   └── paddleocr-vl/
-└── .env.example
-```
-
-## Configuration
-
-### Manual Configuration
-
-If you skipped auto-configuration, create a `.env` file:
-
-```bash
-# Copy the example file
-cp .env.example .env
-
-# Edit with your credentials
-nano .env
-```
-
-Add your API credentials:
-
-```env
-# PP-OCRv5
-API_URL=https://your-api-url.aistudio-app.com/ocr
-TOKEN=your-token-here
-
-# PaddleOCR-VL
-VL_API_URL=https://your-vl-api-url.com/v1
-VL_TOKEN=your-vl-token-here
-```
-
-### Using Configuration Scripts
-
-```bash
-# Configure PP-OCRv5
-python scripts/ppocrv5/configure.py --api-url "YOUR_URL" --token "YOUR_TOKEN"
-
-# Configure PaddleOCR-VL
-python scripts/paddleocr-vl/configure.py --api-url "YOUR_URL" --token "YOUR_TOKEN"
-```
-
-## Verification
-
-Test your installation:
-
-```bash
-# Test PP-OCRv5
-python scripts/ppocrv5/smoke_test.py
-
-# Test PaddleOCR-VL
-python scripts/paddleocr-vl/smoke_test.py
-```
-
-## Troubleshooting
-
-### Python Not Found
-
-Ensure Python is in your PATH:
-
-```bash
-python --version
-```
-
-If not found, install Python 3.7+ from [python.org](https://www.python.org/).
-
-### API Configuration Error
-
-Get your API credentials:
-
-1. Visit [Baidu AI Studio](https://aistudio.baidu.com/paddleocr/task)
-2. Create a new task or use an existing one
-3. Copy the API URL and TOKEN
-4. Run the configuration script
-
-### Permission Denied
-
-On Windows, run your terminal as Administrator if you encounter permission errors.
-
-## Documentation
-
-Each skill includes comprehensive documentation:
-
-- **skills/ppocrv5/SKILL.md**: PP-OCRv5 usage guide
-- **skills/paddleocr-vl/SKILL.md**: PaddleOCR-VL usage guide
-- **references/**: Technical reference documentation
-
-## License
-
-MIT
-
-## Support
-
-For issues and questions:
-- GitHub Issues: [Report a bug](https://github.com/yourusername/PP-OCRv5-claude-code-Skill/issues)
-- Documentation: See `skills/*/SKILL.md` files
-
-## Credits
-
-Built with:
-- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) by PaddlePaddle
-- [Claude Code](https://claude.ai/claude-code) by Anthropic
+# PaddleOCR Skills
+
+One-command installer to add PaddleOCR Skills to your Claude Code project.
+
+## Quick Start
+
+Install PaddleOCR Skills in your Claude Code project with a single command:
+
+```bash
+npx paddleocr-skills
+```
+
+The installer will:
+1. Prompt you to select skills (PP-OCRv5 and/or PaddleOCR-VL)
+2. Copy skill files to your project
+3. Install Python dependencies
+4. Guide you through API configuration
+5. Verify the installation
+
+## What's Included
+
+### PP-OCRv5 (Text OCR)
+- Fast text recognition for images and documents
+- Adaptive quality modes (auto/fast/quality)
+- Supports URLs and local files
+- Confidence scoring and quality metrics
+
+### PaddleOCR-VL (Document Parsing)
+- Advanced document structure analysis
+- Table, formula, and chart recognition
+- Layout detection (headers, footers, page numbers)
+- Complete document parsing with reading order
+
+## Prerequisites
+
+- **Node.js**: 14.0.0 or higher
+- **Python**: 3.7 or higher
+- **Claude Code**: Installed and configured
+- **API Access**: Get your API credentials at [Baidu AI Studio](https://aistudio.baidu.com/paddleocr/task)
+
+## Installation
+
+### Interactive Mode (Recommended)
+
+```bash
+npx paddleocr-skills
+```
+
+The installer will guide you through:
+- Skill selection
+- Python dependency installation
+- API configuration
+
+### Skip Configuration
+
+If you want to configure later:
+
+```bash
+npx paddleocr-skills
+# Choose "No" when asked about configuration
+```
+
+Then configure manually:
+
+```bash
+# For PP-OCRv5
+python scripts/ppocrv5/configure.py
+
+# For PaddleOCR-VL
+python scripts/paddleocr-vl-1.5/configure.py
+```
+
+## Usage
+
+After installation, use the skills in your Claude Code session:
+
+### PP-OCRv5 Example
+
+```bash
+# Extract text from an image
+python scripts/ppocrv5/ocr_caller.py --file-url "https://example.com/image.jpg" --pretty
+
+# Save result to file
+python scripts/ppocrv5/ocr_caller.py --file-path "document.pdf" --output result.json --pretty
+```
+
+### PaddleOCR-VL Example
+
+```bash
+# Parse a complex document
+python scripts/paddleocr-vl-1.5/vl_caller.py --file-url "https://example.com/paper.pdf" --pretty
+
+# Save result to file
+python scripts/paddleocr-vl-1.5/vl_caller.py --file-path "invoice.pdf" --output result.json --pretty
+```
+
+## Project Structure
+
+After installation, your project will have:
+
+```
+your-project/
+├── skills/
+│   ├── ppocrv5/
+│   │   └── SKILL.md
+│   └── paddleocr-vl-1.5/
+│       └── SKILL.md
+├── scripts/
+│   ├── ppocrv5/
+│   │   ├── ocr_caller.py
+│   │   ├── configure.py
+│   │   ├── smoke_test.py
+│   │   └── requirements.txt
+│   └── paddleocr-vl-1.5/
+│       ├── vl_caller.py
+│       ├── configure.py
+│       ├── smoke_test.py
+│       └── requirements.txt
+├── references/
+│   ├── ppocrv5/
+│   └── paddleocr-vl-1.5/
+└── .env.example
+```
+
+## Configuration
+
+### Manual Configuration
+
+If you skipped auto-configuration, create a `.env` file:
+
+```bash
+# Copy the example file
+cp .env.example .env
+
+# Edit with your credentials
+nano .env
+```
+
+Add your API credentials:
+
+```env
+# PP-OCRv5
+API_URL=https://your-api-url.aistudio-app.com/ocr
+TOKEN=your-token-here
+
+# PaddleOCR-VL
+VL_API_URL=https://your-vl-api-url.com/v1
+VL_TOKEN=your-vl-token-here
+```
+
+### Using Configuration Scripts
+
+```bash
+# Configure PP-OCRv5
+python scripts/ppocrv5/configure.py --api-url "YOUR_URL" --token "YOUR_TOKEN"
+
+# Configure PaddleOCR-VL
+python scripts/paddleocr-vl-1.5/configure.py --api-url "YOUR_URL" --token "YOUR_TOKEN"
+```
+
+## Verification
+
+Test your installation:
+
+```bash
+# Test PP-OCRv5
+python scripts/ppocrv5/smoke_test.py
+
+# Test PaddleOCR-VL
+python scripts/paddleocr-vl-1.5/smoke_test.py
+```
+
+## Troubleshooting
+
+### Python Not Found
+
+Ensure Python is in your PATH:
+
+```bash
+python --version
+```
+
+If not found, install Python 3.7+ from [python.org](https://www.python.org/).
+
+### API Configuration Error
+
+Get your API credentials:
+
+1. Visit [Baidu AI Studio](https://aistudio.baidu.com/paddleocr/task)
+2. Create a new task or use an existing one
+3. Copy the API URL and TOKEN
+4. Run the configuration script
+
+### Permission Denied
+
+On Windows, run your terminal as Administrator if you encounter permission errors.
+
+## Documentation
+
+Each skill includes comprehensive documentation:
+
+- **skills/ppocrv5/SKILL.md**: PP-OCRv5 usage guide
+- **skills/paddleocr-vl-1.5/SKILL.md**: PaddleOCR-VL usage guide
+- **references/**: Technical reference documentation
+
+## License
+
+MIT
+
+## Support
+
+For issues and questions:
+- GitHub Issues: [Report a bug](https://github.com/yourusername/PP-OCRv5-claude-code-Skill/issues)
+- Documentation: See `skills/*/SKILL.md` files
+
+## Credits
+
+Built with:
+- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) by PaddlePaddle
+- [Claude Code](https://claude.ai/claude-code) by Anthropic

package/bin/paddleocr-skills.js

@@ -1,20 +1,33 @@
-#!/usr/bin/env node
-
-/**
- * PaddleOCR Skills Installer for Claude Code
- *
- * Entry point for npx paddleocr-skills
- */
-
-const { runInstaller } = require('../lib/installer');
-
-async function main() {
-  try {
-    await runInstaller();
-  } catch (error) {
-    console.error('\n❌ Installation failed:', error.message);
-    process.exit(1);
-  }
-}
-
-main();
+#!/usr/bin/env node
+
+/**
+ * PaddleOCR Skills Installer for Claude Code
+ *
+ * Usage:
+ *   npx paddleocr-skills              # Interactive (select skills)
+ *   npx paddleocr-skills --all        # Install both skills
+ *   npx paddleocr-skills --ppocrv5    # Install PP-OCRv5 only
+ *   npx paddleocr-skills --vl         # Install PaddleOCR-VL 1.5 only
+ */
+
+const { runInstaller } = require('../lib/installer');
+
+function parseArgs() {
+  const args = process.argv.slice(2);
+  if (args.includes('--all')) return ['ppocrv5', 'paddleocr-vl-1.5'];
+  if (args.includes('--ppocrv5')) return ['ppocrv5'];
+  if (args.includes('--vl')) return ['paddleocr-vl-1.5'];
+  return null; // interactive mode
+}
+
+async function main() {
+  try {
+    const skills = parseArgs();
+    await runInstaller(skills);
+  } catch (error) {
+    console.error('\n❌ Installation failed:', error.message);
+    process.exit(1);
+  }
+}
+
+main();

package/lib/copy.js

@@ -1,39 +1,39 @@
-const fs = require('fs-extra');
-const path = require('path');
-
-/**
- * Copy skill files from template to target directory
- */
-async function copySkillFiles(skills, targetDir) {
-  const templateDir = path.join(__dirname, '../templates');
-
-  for (const skill of skills) {
-    const skillTemplateDir = path.join(templateDir, skill);
-
-    // Copy scripts directory
-    const scriptsSource = path.join(skillTemplateDir, 'scripts', skill);
-    const scriptsTarget = path.join(targetDir, 'scripts', skill);
-    await fs.copy(scriptsSource, scriptsTarget, { overwrite: false });
-
-    // Copy skills directory
-    const skillsSource = path.join(skillTemplateDir, 'skills', skill);
-    const skillsTarget = path.join(targetDir, 'skills', skill);
-    await fs.copy(skillsSource, skillsTarget, { overwrite: false });
-
-    // Copy references directory if exists
-    const referencesSource = path.join(skillTemplateDir, 'references', skill);
-    if (await fs.pathExists(referencesSource)) {
-      const referencesTarget = path.join(targetDir, 'references', skill);
-      await fs.copy(referencesSource, referencesTarget, { overwrite: false });
-    }
-  }
-
-  // Copy .env.example if it doesn't exist
-  const envExampleSource = path.join(templateDir, '.env.example');
-  const envExampleTarget = path.join(targetDir, '.env.example');
-  if (await fs.pathExists(envExampleSource)) {
-    await fs.copy(envExampleSource, envExampleTarget, { overwrite: false });
-  }
-}
-
-module.exports = { copySkillFiles };
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Copy skill files from template to target directory
+ */
+async function copySkillFiles(skills, targetDir) {
+  const templateDir = path.join(__dirname, '../templates');
+
+  for (const skill of skills) {
+    const skillTemplateDir = path.join(templateDir, skill);
+
+    // Copy scripts directory
+    const scriptsSource = path.join(skillTemplateDir, 'scripts', skill);
+    const scriptsTarget = path.join(targetDir, 'scripts', skill);
+    await fs.copy(scriptsSource, scriptsTarget, { overwrite: false });
+
+    // Copy skills directory
+    const skillsSource = path.join(skillTemplateDir, 'skills', skill);
+    const skillsTarget = path.join(targetDir, 'skills', skill);
+    await fs.copy(skillsSource, skillsTarget, { overwrite: false });
+
+    // Copy references directory if exists
+    const referencesSource = path.join(skillTemplateDir, 'references', skill);
+    if (await fs.pathExists(referencesSource)) {
+      const referencesTarget = path.join(targetDir, 'references', skill);
+      await fs.copy(referencesSource, referencesTarget, { overwrite: false });
+    }
+  }
+
+  // Copy .env.example if it doesn't exist
+  const envExampleSource = path.join(templateDir, '.env.example');
+  const envExampleTarget = path.join(targetDir, '.env.example');
+  if (await fs.pathExists(envExampleSource)) {
+    await fs.copy(envExampleSource, envExampleTarget, { overwrite: false });
+  }
+}
+
+module.exports = { copySkillFiles };