Skip to content

Commit 4012e34

Browse files
docs: Add CHANGELOG.md, bug_report.md, feature_request.md
Fix schema URL
1 parent b5347cc commit 4012e34

6 files changed

Lines changed: 91 additions & 2 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Put a code example that produces the error.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots**
20+
If applicable, add screenshots to help explain your problem.
21+
22+
**Desktop (please complete the following information):**
23+
24+
- OS: [e.g. Windows]
25+
- Version [e.g. 2.0.0]
26+
27+
**Smartphone (please complete the following information):**
28+
29+
- Device: [e.g. Samsung Galaxy A52s]
30+
- OS: [e.g. Android 10]
31+
- Version [e.g. 2.0.0]
32+
33+
**Additional context**
34+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,4 +148,3 @@ cython_debug/
148148
*.png
149149
*.jpg
150150
*.txt
151-
*.md

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Changelog
2+
=========
3+
4+
All notable changes to PDF-Helper will be documented in this file.
5+
6+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
7+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
[0.3.0]
10+
-------
11+
12+
### Added
13+
14+
- Recipe system: run multi-step PDF workflows from YAML files
15+
- 8 supported operations: `bundle`, `remove_pages`, `split_pdf`, `pdf_to_image`,
16+
`extract_text`, `watermark`, `encrypt`, `metadata`
17+
- Step referencing with `input: { step: step_id }` to pipe outputs
18+
- Template resolution (`{temp_dir}`) in file paths
19+
- Input resolution from environment variables or interactive prompts
20+
- Cleanup of temporary files via `cleanup_temp` setting
21+
- New CLI subcommand: `pdf-helper run-recipe <recipe.yaml> [--force] [--verbose]`
22+
- `encrypt_pdf()` and `set_metadata()` API functions (raise `NotImplementedError`,
23+
graceful pipeline fallback)
24+
- Example recipes in `examples/recipes/`:
25+
- `remove-pages.yaml` — remove pages from a PDF
26+
- `bundle-with-pages.yaml` — bundle files with per-file page selection
27+
- `split-convert-extract.yaml` — split, convert to images, and extract text
28+
- `secure-report-workflow.yaml` — full multi-step pipeline with encryption and metadata
29+
- Recipe JSON Schema at `schemas/recipe-schema.json` for YAML LSP support
30+
31+
### Fixed
32+
33+
- Windows file-lock issues: explicit `PdfDocument` reader/writer close in `bundle()`,
34+
`remove_pages()`, and `split_pdf()`
35+
- README: corrected `merge` CLI example to `bundle`

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ logs a warning and copies the input file through, so pipelines don't break.
185185
#### Advanced Example: Multi-step Pipeline
186186

187187
```yaml
188+
# yaml-language-server: $schema=https://raw.githubusercontent.com/MPCodeWriter21/PDF-Helper/master/schemas/recipe-schema.json
188189
name: "Split, Convert, and Extract Pipeline"
189190
version: "1.0"
190191

schemas/recipe-schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"$id": "https://raw.githubusercontent.com/MPCodeWriter21/PDF-Helper/main/schemas/recipe-schema.json",
3+
"$id": "https://raw.githubusercontent.com/MPCodeWriter21/PDF-Helper/master/schemas/recipe-schema.json",
44
"title": "PDF-Helper Recipe",
55
"description": "JSON Schema for PDF-Helper recipe YAML files",
66
"type": "object",

0 commit comments

Comments
 (0)