https://github.com/orchetect/pdfgadget
Batch PDF operations for Swift
https://github.com/orchetect/pdfgadget
pdf pdf-document-processor pdf-files pdf-merger swift
Last synced: 6 months ago
JSON representation
Batch PDF operations for Swift
- Host: GitHub
- URL: https://github.com/orchetect/pdfgadget
- Owner: orchetect
- License: mit
- Created: 2023-04-02T06:45:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T22:42:36.000Z (about 1 year ago)
- Last Synced: 2024-10-20T08:09:07.717Z (12 months ago)
- Topics: pdf, pdf-document-processor, pdf-files, pdf-merger, swift
- Language: Swift
- Homepage:
- Size: 443 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PDFGadget
[](https://github.com/orchetect/PDFGadget/actions/workflows/build.yml) [](https://developer.apple.com/swift)  [](https://developer.apple.com/swift) [](https://github.com/orchetect/PDFGadget/blob/main/LICENSE)
Batch PDF utilities with simple API for Swift. Declarative API for:
- assigning or removing file attributes (metadata)
- file filtering, ordering, and merging
- page management: reordering, collation, copying, moving, and replacement
- page presentation: rotation, cropping, etc.
- page content: filtering, removal or burn-in of annotations
> [!NOTE]
> Currently this package is only a Swift library. A CLI tool and/or GUI frontend may be added in future.
## Basic Usage
```swift
import PDFGadget
let sources = [URL, URL, URL, ...] // URLs to one or more PDF files
let outputDir = URL.desktopDirectory
```
The steps of loading source PDFs, performing operations, and saving the resulting PDFs can be performed individually:
```swift
let pdfGadget = PDFGadget()
try pdfGadget.load(pdfs: sources)
try pdfGadget.perform(operations: [
// one or more operations
])
// access the resulting PDF documents in memory
pdfGadget.pdfDocuments // [PDFDocument]
// or save them as PDF files to disk
try pdfGadget.savePDFs(outputDir: outputDir)
```
Or a fully automated batch operation can be run with a single call to `run()` by passing in a populated instance of `PDFGadget.Settings`.
```swift
let settings = try PDFGadget.Settings(
sourcePDFs: sources,
outputDir: outputDir,
operations: [
// one or more operations
],
savePDFs: true
)
try PDFGadget().run(using: settings)
```
## Batch Operations
The following are single operations that may be used in a batch sequence of operations.
> **Note**: More to be added in future, including: page cropping, more sophisticated annotation editing/filtering/removal.
### File Operations
- New empty file
- Clone file
- Filter files
- Merge files
- Set file filename(s)
- Set or remove file attributes (metadata such as title, author, etc.)
- Remove file protections (encryption and permissions)
### Page Operations
- Filter pages
- Copy pages
- Move pages
- Replace pages by copying or moving them
- Reverse page order (all or subset of pages)
- Rotate pages
- Crop pages
- Split file into multiple files
### Page Content Operations
- Filter annotations (by types, or remove all)
- Burn in annotations
- Extract plain text (to system pasteboard, to file on disk, or to variable in memory)
## Getting Started
1. Add the package to your application as a dependency using Swift Package Manager
2. `import PDFGadget`
## Author
Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself [@orchetect](https://github.com/orchetect).
## License
Licensed under the MIT license. See [LICENSE](/LICENSE) for details.
## Sponsoring
If you enjoy using PDFGadget and want to contribute to open-source financially, GitHub sponsorship is much appreciated. Feedback and code contributions are also welcome.
## Roadmap & Contributions
Planned and in-progress features can be found in [Issues](https://github.com/orchetect/PDFGadget/issues). Any help is welcome and appreciated.