Bump version to 0.9rc2

- Improved documentation with optimization levels
- Updated version history
- Fixed aspect ratio in PDF output
This commit is contained in:
Esa Kataja
2024-12-03 23:02:44 +02:00
parent 4c9cad58ec
commit 8d5d1c41a2
2 changed files with 27 additions and 7 deletions
+26 -6
View File
@@ -10,10 +10,11 @@ A command-line tool for processing and cleaning scanned musical score PDFs. This
- **PNG Optimization**: Optimize PNG files using optipng (if installed) - **PNG Optimization**: Optimize PNG files using optipng (if installed)
- **Modular Processing**: Process your files step by step or all at once - **Modular Processing**: Process your files step by step or all at once
- **High Quality Output**: Preserve image quality throughout the process - **High Quality Output**: Preserve image quality throughout the process
- **Professional PDF Output**: Generate A4-sized PDFs with proper borders and centered content
## Installation ## Installation
1. Ensure you have Python 3.8+ installed 1. Ensure you have Python 3.12+ installed
2. Install uv (recommended) or pip 2. Install uv (recommended) or pip
3. Clone this repository: 3. Clone this repository:
```bash ```bash
@@ -55,15 +56,20 @@ Automatically detects and corrects page rotation by analyzing staff lines.
### Optimize Pages ### Optimize Pages
```bash ```bash
./pdf_cleaner.py optimize ./pdf_cleaner.py optimize [--level {1,2,3}]
``` ```
Trims excess white space and optionally runs PNG optimization (requires optipng). Processes pages with different optimization levels:
- Level 1: Only trims excess white space
- Level 2: Trims white space and converts to 1-bit monochrome
- Level 3: All optimizations + PNG optimization (requires optipng)
Default level is 1 if not specified.
### Create Final PDF ### Create Final PDF
```bash ```bash
./pdf_cleaner.py finalize output.pdf ./pdf_cleaner.py finalize output.pdf
``` ```
Combines all processed pages into a final PDF and cleans up temporary files. Combines all processed pages into a final PDF with proper A4 sizing, borders, and centered content.
### Typical Workflow ### Typical Workflow
```bash ```bash
@@ -83,7 +89,10 @@ Combines all processed pages into a final PDF and cleans up temporary files.
3. **Optimization**: 3. **Optimization**:
- Detects content boundaries and removes excess white space - Detects content boundaries and removes excess white space
- Optionally runs optipng for additional file size reduction - Optionally runs optipng for additional file size reduction
4. **Finalization**: Combines processed images back into a PDF using img2pdf 4. **Finalization**:
- Combines processed images into a professional A4-sized PDF
- Adds configurable borders around content
- Centers content on each page while maintaining aspect ratio
## Dependencies ## Dependencies
@@ -100,4 +109,15 @@ Contributions are welcome! Please feel free to submit a Pull Request.
## License ## License
[Insert chosen license here] This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Version History
- v0.9rc2: Second release candidate
- Improved documentation
- Added optimization level descriptions
- Fixed aspect ratio in PDF output
- v0.9rc1: First release candidate with full functionality
- Professional PDF output with A4 sizing and borders
- Complete image processing pipeline
- Configurable settings
+1 -1
View File
@@ -1,6 +1,6 @@
[project] [project]
name = "notes-cleaner" name = "notes-cleaner"
version = "0.9rc1" version = "0.9rc2"
description = "Add your description here" description = "Add your description here"
readme = "README.md" readme = "README.md"
license = "MIT" license = "MIT"