10 Commits

18 changed files with 932 additions and 98 deletions
+2
View File
@@ -4,3 +4,5 @@ python-embed/*
logs/*.log logs/*.log
__pycache__/* __pycache__/*
.coverage .coverage
build/*
dist/*
+236
View File
@@ -0,0 +1,236 @@
# AGENTS.md — pptx-image-compress
Guidelines for AI agents and contributors working in this codebase.
---
## Project Overview
Single-file Python CLI tool (`pptx_image_compress.py`) that compresses images
inside `.pptx` files using the external binary `caesiumclt`. Supports single-
file and batch modes, multi-threaded processing, and CSV logging.
**Entry point:** `pptx_image_compress.py``main()`
**Tests:** `test_pptx_image_compress.py` (stdlib `unittest`, run via `pytest`)
**External dependency:** `caesiumclt` must be on `PATH`
---
## Running Tests
```bash
python -m pytest test_pptx_image_compress.py -v
```
All 5 tests must pass before any change is considered complete.
Never remove or weaken an existing test. Always add a test for new behaviour.
---
## Code Readability
- **One responsibility per function.** If a function does more than one thing,
split it.
- **Descriptive names.** Avoid single-letter variables outside of short loops.
Prefer `img_path` over `p`, `result` over `r`.
- **Type-annotate every function signature** — parameters and return type.
Use `Optional[X]` / `X | None` consistently (the codebase uses both; prefer
`X | None` for new code on Python 3.10+).
- **Constants at module level**, UPPER_SNAKE_CASE. Never hardcode magic values
inline (e.g. file extensions, prefix strings, bar lengths).
- **Section comments** (`# --- Section ---`) are used to separate logical
blocks. Keep them and add new ones when introducing a new logical group.
- **German UI strings are intentional** (progress output, error messages shown
to the end-user). Keep them in German. Internal code identifiers stay in
English.
- **No dead code.** Remove commented-out blocks and unused functions before
committing.
---
## Testability
- **Inject external dependencies via callable parameters.** The `compressor`
parameter on `process_image_file` and `process_single_deck` is the canonical
pattern — always use it for any new external-process call.
- **Never call `shutil.which` or `subprocess` directly inside a function under
test.** Route through an injectable or mockable seam.
- **Tests use `tempfile.TemporaryDirectory`** for isolation. Every test must
clean up after itself — rely on the context manager, not `tearDown`.
- **Do not test private implementation details.** Test observable behaviour:
return values, file contents, log output.
- **One assertion focus per test.** A test named `test_X` should assert exactly
what `X` does, with a minimal setup.
- **Use `fake_compressor` pattern** (as seen in existing tests) to decouple
image-compression logic from the real `caesiumclt` binary in all unit tests.
---
## Performance
- **Thread pool sizing:** outer thread count is controlled by `-t/--threads`
(default 16). When `threads > 1`, each `caesiumclt` subprocess is launched
with `--threads 1` to prevent CPU over-subscription. Do not change this
without benchmarking.
- **Scratch directories are per-image** (`img_{idx:06d}` sub-dirs) to avoid
filename collisions across threads without locking.
- **`Lock` scope must be minimal.** Only counter increments and `log_lines`
appends are inside the lock — never I/O or subprocess calls.
- **Avoid redundant filesystem walks.** `build_image_slide_index` is called
once per deck, not per image. Keep it that way.
- **`zip_dir_to_pptx` collects all files before writing** so `[Content_Types].xml`
can be placed first. Do not revert this to a streaming walk.
---
## Architecture
### Current state
Single-file design (`pptx_image_compress.py`) is intentional for zero-install
distribution. It is acceptable as long as the file stays under ~700 lines.
### Target layout (clean architecture — migrate when the file grows)
When the project needs to grow, extract to a package following these layers.
Dependencies must only point **inward** (CLI → Application → Domain ←
Infrastructure implements Domain ports).
```
pptx_compress/
├── __init__.py
├── __main__.py # python -m pptx_compress entry point
├── domain/ # innermost — zero external imports
│ ├── __init__.py
│ ├── models.py # DeckResult, ImageProcessResult (dataclasses)
│ ├── constants.py # ALLOWED_EXT, TEMP_PREFIX, defaults
│ └── ports.py # Compressor Protocol (typing.Protocol), SlideIndex ABC
├── application/ # orchestration — imports domain only
│ ├── __init__.py
│ ├── compress_deck.py # process_single_deck() use-case
│ └── batch.py # batch loop, overall summary logic
├── infrastructure/ # implements domain ports — imports domain + stdlib/3rd-party
│ ├── __init__.py
│ ├── caesium_adapter.py # compress_with_caesium() (caesiumclt subprocess)
│ ├── pptx_reader.py # discover_images(), build_image_slide_index()
│ ├── pptx_writer.py # zip_dir_to_pptx()
│ └── temp_manager.py # cleanup_old_temps(), TEMP_PREFIX lifecycle
└── cli/ # outermost — imports application only
├── __init__.py
├── args.py # argparse definition, expand_inputs(), collect_from_dir()
└── output.py # print_progress(), format_duration(), human_mb/kb
```
### Layer rules
| Layer | May import | Must NOT import |
|---|---|---|
| `domain` | stdlib only | everything else |
| `application` | `domain` | `infrastructure`, `cli` |
| `infrastructure` | `domain`, stdlib, 3rd-party | `application`, `cli` |
| `cli` | `application`, `domain.models` | `infrastructure` directly |
### Key architectural decisions
- **`Compressor` is a `typing.Protocol`** (in `domain/ports.py`), not a bare
`Callable`. This makes the contract explicit and IDE-checkable without
creating an import cycle:
```python
class Compressor(Protocol):
def __call__(
self,
original: Path,
out_dir: Path,
threads: int | None,
quality: int,
min_savings: str,
) -> Path | None: ...
```
- **`DeckResult` and `ImageProcessResult` live in `domain/models.py`** — they
are pure data, no logic, no I/O.
- **`compress_deck.py` receives a `Compressor` instance via constructor or
parameter** — never imports `caesium_adapter` directly. This is what makes
the use-case fully unit-testable with a `fake_compressor`.
- **`main()` (in `cli/args.py`) owns argument parsing only.** It resolves
paths, builds the `Compressor` adapter, and calls `application.compress_deck`
or `application.batch`. No processing logic belongs there.
- **`expand_inputs` / `collect_from_dir` live in `cli/args.py`** — path
resolution is a CLI concern. All layers below receive `Path` objects.
- **Temp directory lifecycle belongs in `infrastructure/temp_manager.py`.**
Always use `TEMP_PREFIX` so orphaned dirs from crashed runs are recoverable.
### Migration guide (single file → package)
1. Create the `pptx_compress/` directory.
2. Move dataclasses and constants to `domain/`.
3. Move `compress_with_caesium` → `infrastructure/caesium_adapter.py`.
4. Move PPTX read/write helpers → `infrastructure/pptx_reader.py` and
`pptx_writer.py`.
5. Move `process_image_file` + `process_single_deck` → `application/compress_deck.py`.
6. Move `main()` + input helpers → `cli/args.py`.
7. Add `__main__.py` with `from pptx_compress.cli.args import main; main()`.
8. Update `test_pptx_image_compress.py` imports accordingly — test logic does
not need to change because the public API surface is identical.
### Refactoring plan (aligned with this AGENTS.md)
- Keep the same layer direction: `cli` → `application` → `domain`; only
`infrastructure` implements domain ports.
- Add dedicated raster/vector implementations behind domain ports, not in CLI:
- `domain/ports.py`: `RasterCompressor`, `VectorCompressor` protocols
(or one `Compressor` protocol + typed strategies)
- `infrastructure/caesium_adapter.py`: raster implementation
- `infrastructure/svg_polish_adapter.py`: vector implementation
- Add routing in `application` (not `infrastructure`):
- `application/compress_deck.py`: `CompressorRouter` decides by extension
- no direct `subprocess` / external library calls in `application`
- Split image workflow into explicit application steps:
- `compress_step`
- `optimal_format_step` (PNG → JPEG optimization step; not a fallback)
- `replace_step` (atomic replace via `.tmp` + `Path.replace()`)
- Centralize PPTX metadata handling in infrastructure modules:
- keep relationship/content-type updates in `infrastructure/pptx_reader.py`
and/or `infrastructure/pptx_writer.py`
- `application` only orchestrates and passes domain models
- Introduce configuration object in `domain/constants.py` or a dedicated
domain config model; avoid new magic values in `application`.
- Preserve public behaviour and CLI surface during migration; refactor in
small commits with green tests after each step.
### Suggested commit sequence
1. Extract domain models/constants/ports unchanged.
2. Extract caesium adapter + add svg_polish adapter seam.
3. Introduce router in `application` with extension-based dispatch.
4. Refactor image processing into `compress_step` + `optimal_format_step` +
`replace_step`.
5. Extract PPTX metadata update helpers to infrastructure modules.
6. Move CLI parsing/output concerns into `cli/` only.
7. Remove dead monolith code paths and keep tests passing.
---
## Security
- **Never pass unsanitised user input directly to `subprocess`.** The
`compress_with_caesium` function builds the command as a list (not a shell
string). Keep it that way — do not use `shell=True`.
- **Validate file extensions before compression.** `compress_with_caesium`
checks `ext not in ALLOWED_EXT` and returns `None` for unrecognised types.
Do not bypass or widen this check without explicit justification.
- **Validate input paths early.** `process_single_deck` checks that the input
exists and has a `.pptx` suffix before doing any filesystem work.
- **Temp files are written atomically.** Image replacement uses a `.tmp`
intermediate and `Path.replace()` (atomic rename) — do not change this to a
direct overwrite.
- **`capture_output=True`** is set on all subprocess calls so that stdout/stderr
from `caesiumclt` cannot interfere with or inject into the tool's own output.
- **Do not log file contents**, only metadata (name, size, slide references).
The CSV log must never contain image binary data or path information outside
the output directory.
- **`ignore_errors=True` on `shutil.rmtree`** is acceptable for temp cleanup
only. Never suppress errors on writes to the output PPTX or its log file.
+288
View File
@@ -0,0 +1,288 @@
# PPTX Image Compressor - Packaging & Distribution Guide
## Overview
This project now supports 3 different deployment approaches:
1. **Embedded Python** (Current - Development & Local Use)
2. **PyInstaller Portable** (Recommended for End Users)
3. **Hybrid Approach** (Recommended for Maximum Flexibility)
---
## Approach 1: Embedded Python (Development Setup)
### Use Case
- ✅ Development with VS Code
- ✅ Debugging with Python Debugger
- ✅ Running tests with pytest
- ✅ Source code control & modifications
### What You Have
- `install_and_run.bat` - Main launcher
- `.venv/` - Virtual environment for development
- Source code - Fully editable
### Usage
```bash
# Development (with --debug flag to see pip output)
.\install_and_run.bat --debug -i "path\to\file.pptx" -o "path\to\output.pptx"
# With VS Code debugger
# Open pptx_image_compress.py and click "Debug" or press F5
# Run tests
.\.venv\Scripts\pytest tests/
```
### Setup Instructions
1. Ensure Python 3.9+ is installed on Windows
2. Run: `.\install_and_run.bat`
3. Virtual environment is created/updated automatically
### Files
- `install_and_run.bat` - Handles Python setup and execution
- `requirements.txt` - Python package dependencies for runtime
- `requirements-dev.txt` - Development dependencies (pytest, coverage, etc.)
---
## Approach 2: PyInstaller Portable (User Distribution)
### Use Case
- ✅ Distribute to end users (No Python installation needed)
- ✅ Single-file executable
- ✅ Professional appearance
- ✅ "Just download and run" experience
- ✅ Drag-and-drop support for non-technical users
### What Gets Generated
- `dist/pptx-image-compress.exe` - Standalone executable
- `dist/run.bat` - Simple command-line wrapper
- `dist/dragdrop.bat` - Drag-and-drop wrapper (easiest for users)
### Usage by End User
```bash
# Option 1: Drag-and-drop (Easiest!)
# Drag a .pptx file onto dragdrop.bat
# Output: filename_compressed.pptx
# Option 2: Command line
.\pptx-image-compress.exe -i "path\to\file.pptx" -o "path\to\output.pptx"
# Option 3: Wrapper
.\run.bat -i "path\to\file.pptx" -o "path\to\output.pptx"
# Get help
.\pptx-image-compress.exe --help
```
### Build Instructions
1. Ensure you have the development environment set up (Approach 1)
2. Run: `.\build.bat`
3. Wait for build to complete (first run takes 2-3 minutes)
4. Generated files are in `dist/` folder
### Build Files
- `build.bat` - Automated build script that:
- Installs PyInstaller if needed
- Compiles Python to standalone executable
- Creates wrapper batch file
- Prepares distribution package
### Advantages
- No Python installation required on user's machine
- Smaller footprint than full Python installation
- Professional distribution option
- Can be code-signed and digitally stamped
### Limitations
- Larger file size (~80-150 MB) due to bundled Python
- First launch slightly slower (unpacking)
- Harder to debug if issues occur
### Distribution Notes
- Ensure `caesiumclt.exe` is in the same directory as the .exe
- Can optionally add `.venv\Lib\site-packages\svg_polish\*` if svg-polish needs updating
- All dependencies are pre-bundled
- Users can:
1. **Drag-and-drop files** onto `dragdrop.bat` for easy compression
2. Use command line for batch operations
3. Call `.exe` directly with custom parameters
### Drag-and-Drop Feature
The `dragdrop.bat` wrapper provides the easiest user experience:
- Drag a `.pptx` file onto `dragdrop.bat`
- Automatically creates `[filename]_compressed.pptx` in the same directory
- Shows progress and completion status
- No command-line knowledge required
---
## Approach 3: Hybrid (Recommended)
### Use Case
- ✅ Flexible development workflow
- ✅ Easy distribution to users
- ✅ Best of both worlds
### How It Works
**For Developers:**
- Use Embedded Python approach (Approach 1)
- Edit code, debug, run tests
- Keep development lightweight
**For Users:**
- Use PyInstaller Portable (Approach 2)
- Download and run .exe
- No installation or configuration needed
### Workflow
```
Development Phase:
├── Edit code
├── Test with: .\.venv\Scripts\pytest
├── Debug with VS Code
└── Use: .\install_and_run.bat --debug -i file.pptx
Release Phase:
├── Run: .\build.bat
├── Test the .exe: .\dist\pptx-image-compress.exe -i file.pptx
├── Package: Copy dist/* to users
└── Users just run: pptx-image-compress.exe
```
---
## Dependency Management
### Runtime Dependencies (required for execution)
See `requirements.txt`:
- `svg-polish==1.0.0` - SVG optimization library (brings defusedxml)
The core script uses only Python Standard Library modules:
- No need for external image libraries
- Uses system's `caesiumclt.exe` for image compression
- Handles PPTX files using only built-in zipfile module
### Development Dependencies (for testing/development)
See `requirements-dev.txt`:
- `pytest==9.0.3` - Testing framework
- `pytest-cov==7.1.0` - Coverage reporting
- Plus all runtime dependencies
### Managing Dependencies
**Update packages:**
```bash
.\.venv\Scripts\pip install --upgrade -r requirements.txt
```
**Add new package:**
```bash
.\.venv\Scripts\pip install package_name
.\.venv\Scripts\pip freeze > requirements.txt
```
**For development:**
```bash
.\.venv\Scripts\pip install -r requirements-dev.txt
```
---
## Troubleshooting
### Development Setup Issues
**Problem:** "Python not found"
- **Solution:** Run `.\install_and_run.bat` which will download and setup Python
**Problem:** "svg_polish not found"
- **Solution:** Run with `--debug` flag to see installation details
- Or manually: `.\.venv\Scripts\pip install svg-polish`
### PyInstaller Build Issues
**Problem:** Build takes too long
- **Solution:** First build is slower due to PyInstaller analysis. Subsequent builds are faster.
**Problem:** .exe won't run
- **Solution:** Ensure `caesiumclt.exe` is in the same directory or system PATH
**Problem:** "PyInstaller not installed"
- **Solution:** Run `build.bat` again - it will auto-install PyInstaller
---
## Technical Comparison
| Aspect | Embedded Python | PyInstaller | Hybrid |
|--------|-----------------|-------------|--------|
| **Installation** | Auto (via batch) | None (single .exe) | Mixed |
| **Disk Space** | ~50 MB | ~100-150 MB | Both available |
| **Execution Speed** | Fast | Fast | Fast |
| **Debuggability** | Excellent | Difficult | Excellent (dev) |
| **Distribution** | Manual setup | Just .exe | Just .exe (users) |
| **Development** | Quick iteration | Requires rebuild | Quick iteration |
---
## Recommended Workflow
### For You (Developer)
```
1. Daily Development:
- Use: .\install_and_run.bat --debug
- Edit code in VS Code
- Test with pytest
- Use debugger with F5
2. Before Release:
- Run: .\build.bat
- Test: .\dist\pptx-image-compress.exe
- Package and distribute
```
### For End Users
```
1. First Time:
- Download pptx-image-compress.exe
- Download run.bat (optional)
- Download caesiumclt.exe (if image compression needed)
2. Usage:
- Double-click run.bat
- Or: pptx-image-compress.exe -i input.pptx -o output.pptx
```
---
## Next Steps
1. **Test Embedded Python Setup:**
```bash
.\install_and_run.bat --debug -i test.pptx -o test_output.pptx
```
2. **Build Portable Distribution:**
```bash
.\build.bat
```
3. **Test the Executable:**
```bash
.\dist\pptx-image-compress.exe -h
```
4. **Check Generated Files:**
- `dist/pptx-image-compress.exe` - Main executable
- `dist/run.bat` - Batch wrapper
---
## Support & Maintenance
- Keep Python version updated for security
- Update dependencies: `pip install --upgrade -r requirements.txt`
- Rebuild .exe when updating dependencies: `.\build.bat`
- Test both approaches before major updates
+7 -7
View File
@@ -1,6 +1,5 @@
# PPTX Image Compressor (CaesiumCLT + svg-polish)
# PPTX Image Compressor (CaesiumCLT only) **Version 1.2.0**
**Version 1.1.8**
Dieses Paket enthält: Dieses Paket enthält:
@@ -33,22 +32,23 @@ Zusätzlich wird **pip** installiert, damit das **svg-polish** Modul installiert
## Was das Tool macht ## Was das Tool macht
- Entpackt die PPTX in einen TempOrdner - Entpackt die PPTX in einen TempOrdner
- Komprimiert **JPG/JPEG, PNG, WebP, GIF** mit **CaesiumCLT** (Default `-q 90`, `-O bigger`) - Komprimiert **JPG/JPEG, PNG, WebP, GIF** mit **CaesiumCLT** (Default `-q 90`, `-O bigger`)
- Komprimiert **SVG** mit **svg-polish** (Default-Modus: `agressive`) - Komprimiert **SVG** mit **svg-polish** (Default-Modus: `balanced`)
- Ersetzt Bilder nur, wenn die komprimierte Datei kleiner ist - Ersetzt Bilder nur, wenn die komprimierte Datei kleiner ist
- Versucht bei PNG zusätzlich einen PNG->JPG Wechsel, wenn das Bild nach Kompression noch größer als 500 KB ist - Versucht bei PNG zusätzlich einen PNG->JPG Wechsel, wenn das Bild nach Kompression noch größer als 500 KB ist
- Ersetzt Bilder nur, wenn sei mindestens 2% kleiner sind (verhindert *doppelte Komprimierung*) - Ersetzt Bilder nur, wenn sei mindestens 2% kleiner sind (verhindert *doppelte Komprimierung*)
- Schreibt ein CSVLog (`.log` neben der OutputPPTX) - Schreibt ein CSVLog (`.log` neben der OutputPPTX)
- Baut eine neue PPTX und zeigt eine Summary (Name, Größe vorher/nachher, Ersparnis %, Zeit) - Baut eine neue PPTX und zeigt eine Summary (Name, Größe vorher/nachher, Ersparnis %, Zeit)
## Änderungen in 1.1.8 ## Änderungen in 1.2.0
- SVG Files werden bei Vorhandensein von svg-polish anhand von 2 Profilen optimiert: balanced|agressive - Möglichkeit mit build.bat eine pptx-image-compressor.exe zu erstellen
- Fixes für install_and_run.bat in venv / "raw" environments
## Hinweise ## Hinweise
- `-t` steuert die Parallelität der PythonThreads; intern wird `caesiumclt --threads 1` gesetzt, sobald `-t > 1`, um Oversubscription zu vermeiden. Default ist 16 - `-t` steuert die Parallelität der PythonThreads; intern wird `caesiumclt --threads 1` gesetzt, sobald `-t > 1`, um Oversubscription zu vermeiden. Default ist 16
- `-q` steuert das Qualitätslevel; intern wird `caesiumclt -q` mit diesem Wert von `0..100` benutzt, Default ist 90 - `-q` steuert das Qualitätslevel; intern wird `caesiumclt -q` mit diesem Wert von `0..100` benutzt, Default ist 90
- `--min-savings` steuert das Mindestmass an Komprimierung zur Verhinderung von doppelter Komprimierunt, Default ist 2% - `--min-savings` steuert das Mindestmass an Komprimierung zur Verhinderung von doppelter Komprimierunt, Default ist 2%
- Die Batch **verwendet bevorzugt das Embeddable Python** neben der BAT; ansonsten sucht sie echte `python.exe`/`py.exe` im PATH, **ignoriert** aber die MicrosoftStoreAliasPfade (`WindowsApps`). - Die Batch **verwendet bevorzugt das Embeddable Python** neben der BAT; ansonsten sucht sie echte `python.exe`/`py.exe` im PATH, **ignoriert** aber die MicrosoftStoreAliasPfade (`WindowsApps`).
- `--svg-profile` steuert das Vector-Optimierungsprofil `balanced|agressive` - `--svg-profile` steuert das Vector-Optimierungsprofil `balanced|aggressive`
## Manuelle Nutzung des .py (falls Python vorhanden) ## Manuelle Nutzung des .py (falls Python vorhanden)
```bat ```bat
+126
View File
@@ -0,0 +1,126 @@
@echo off
setlocal EnableExtensions
set "SELF_DIR=%~dp0"
pushd "%SELF_DIR%"
set "BUILD_DIR=%SELF_DIR%dist"
set "SPEC_DIR=%SELF_DIR%build"
set "PY_CMD=%SELF_DIR%.venv\Scripts\python.exe"
set "UPX_DIR=%SELF_DIR%buildtools"
set "MINIFY="
if /I "%~1"=="--minify" set "MINIFY=1"
echo [INFO] Build started...
rem =========================
rem Check Python
rem =========================
if not exist "%PY_CMD%" (
echo [ERROR] Python not found
exit /b 1
)
rem =========================
rem Check PyInstaller
rem =========================
"%PY_CMD%" -m pip show pyinstaller >nul 2>&1
if errorlevel 1 (
echo [INFO] Installing PyInstaller...
"%PY_CMD%" -m pip install pyinstaller --quiet
)
rem =========================
rem Clean
rem =========================
if exist "%BUILD_DIR%" rmdir /s /q "%BUILD_DIR%"
if exist "%SPEC_DIR%" rmdir /s /q "%SPEC_DIR%"
rem =========================
rem Optional icon
rem =========================
set "ICON_ARG="
if exist "%SELF_DIR%pptx-image-compress.ico" (
set "ICON_ARG=%SELF_DIR%pptx-image-compress.ico"
)
echo [INFO] Icon param: %ICON_ARG%
rem =========================
rem Build EXE (STABLE)
rem =========================
echo [INFO] Building EXE...
if defined ICON_ARG (
"%PY_CMD%" -m PyInstaller ^
--onefile ^
--console ^
--name pptx-image-compress ^
--distpath "%BUILD_DIR%" ^
--specpath "%SPEC_DIR%" ^
--workpath "%SPEC_DIR%\build" ^
--icon="%ICON_ARG%" ^
--hidden-import svg_polish ^
pptx_image_compress.py
) else (
"%PY_CMD%" -m PyInstaller ^
--onefile ^
--console ^
--name pptx-image-compress ^
--distpath "%BUILD_DIR%" ^
--specpath "%SPEC_DIR%" ^
--workpath "%SPEC_DIR%\build" ^
--hidden-import svg_polish ^
pptx_image_compress.py
)
if errorlevel 1 (
echo [ERROR] Build failed
exit /b 1
)
rem =========================
rem Copy templates
rem =========================
copy "%SELF_DIR%templates\run.tpl.bat" "%BUILD_DIR%\run.bat" >nul
copy "%SELF_DIR%templates\dragdrop.tpl.bat" "%BUILD_DIR%\dragdrop.bat" >nul
rem =========================
rem Copy caesiumclt.exe
rem =========================
copy "%SELF_DIR%bin\caesiumclt.exe" "%BUILD_DIR%\caesiumclt.exe"
rem =========================
rem Optional UPX
rem =========================
if defined MINIFY (
if exist "%UPX_DIR%\upx.exe" (
echo [INFO] Running UPX compression...
"%UPX_DIR%\upx.exe" --best --force "%BUILD_DIR%\pptx-image-compress.exe"
"%UPX_DIR%\upx.exe" --best --force "%BUILD_DIR%\caesiumclt.exe"
) else (
echo [WARN] UPX not found at %UPX_DIR%
)
)
rem =========================
rem Done
rem =========================
echo(
echo [SUCCESS] Build complete!
echo Output:
echo %BUILD_DIR%\pptx-image-compress.exe
popd
endlocal
Binary file not shown.
+1 -38
View File
@@ -1,11 +1,7 @@
@echo off @echo off
setlocal EnableExtensions EnableDelayedExpansion setlocal EnableExtensions EnableDelayedExpansion
set UPDATE_DIR=%~dp0updates
if not exist "%UPDATE_DIR%" mkdir "%UPDATE_DIR%"
set TMP_OUT=%TEMP%\update_check_%RANDOM%.txt set TMP_OUT=%TEMP%\update_check_%RANDOM%.txt
set TMP_OUT_2=%TEMP%\update_check_%RANDOM%.txt
python check_new_version.py > "%TMP_OUT%" python check_new_version.py > "%TMP_OUT%"
set EXITCODE=%ERRORLEVEL% set EXITCODE=%ERRORLEVEL%
@@ -23,39 +19,6 @@ if %EXITCODE%==0 (
echo. echo.
type "%TMP_OUT%" type "%TMP_OUT%"
choice /c jn /m "Wollen Sie die Updates-Packages herunterladen?"
if errorlevel 2 goto :END
if exist "%TMP_OUT%" (
findstr /b "PYTHON_DOWNLOAD=" "%TMP_OUT%" >nul
if not errorlevel 1 (
for /f "tokens=1,* delims==" %%a in (
'findstr /b "PYTHON_DOWNLOAD=" "%TMP_OUT%"'
) do (
echo Downloading Python update from PYTHON_DOWNLOAD
powershell -NoProfile -Command ^
"Invoke-WebRequest '%%b' -OutFile '%UPDATE_DIR%\python-embed.zip'"
)
)
findstr /b "CAESIUM_DOWNLOAD=" "%TMP_OUT_2%" >nul
if not errorlevel 1 (
for /f "tokens=1,* delims==" %%a in (
'findstr /b "CAESIUM_DOWNLOAD=" "%TMP_OUT_2%"'
) do (
echo Downloading caesiumclt update from CAESIUM_DOWNLOAD
powershell -NoProfile -Command ^
"Invoke-WebRequest '%%b' -OutFile '%UPDATE_DIR%\caesiumclt.zip'"
)
)
)
:END :END
del "%TMP_OUT%" >nul 2>&1 del "%TMP_OUT%" >nul 2>&1
del "%TMP_OUT_2%" >nul 2>&1 endlocal
endlocal
+2 -2
View File
@@ -1,6 +1,6 @@
[DEFAULT] [DEFAULT]
python_used_version = 3.14.5 python_used_version = 3.14.6
python_latest_version = 3.14.5 python_latest_version = 3.14.6
caesiumclt_used_version = v1.3.0 caesiumclt_used_version = v1.3.0
caesiumclt_latest_version = v1.3.0 caesiumclt_latest_version = v1.3.0
+5 -4
View File
@@ -2,10 +2,11 @@ import argparse
import configparser import configparser
import json import json
import sys import sys
import os
import urllib.request import urllib.request
from pathlib import Path from pathlib import Path
INI_FILE = Path("latestversion.ini") INI_FILE = Path("check_new_version.ini")
PYTHON_API = "https://endoflife.date/api/v1/products/python" PYTHON_API = "https://endoflife.date/api/v1/products/python"
CAESIUM_API = "https://api.github.com/repos/Lymphatus/caesium-clt/tags" CAESIUM_API = "https://api.github.com/repos/Lymphatus/caesium-clt/tags"
@@ -79,7 +80,6 @@ def check_caesium(cfg, result):
) )
}) })
def main(): def main():
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
parser.add_argument("--yes", action="store_true") parser.add_argument("--yes", action="store_true")
@@ -104,10 +104,11 @@ def main():
for u in result["updates"]: for u in result["updates"]:
print( print(
f"{u['tool'].capitalize()}: aktuell genutzt {u['used']}, " f"{u['tool'].capitalize()}: aktuell genutzt {u['used']}, "
f"neu {u['latest']}, download?" f"neu {u['latest']}"
) )
print(f"{u['tool'].upper()}_DOWNLOAD={u['url']}") print(f"{u['tool'].upper()}_DOWNLOAD={u['url']}")
print(f"{u['tool'].upper()}_LATEST_VERSION={u['latest']}")
if not u["maintained"]: if not u["maintained"]:
print( print(
f"WARNING: Achtung Version {u['latest']} " f"WARNING: Achtung Version {u['latest']} "
+31 -6
View File
@@ -4,7 +4,7 @@ setlocal EnableExtensions EnableDelayedExpansion
rem ============================================ rem ============================================
rem PPTX Image Compressor - Installer/Runner (Batch-enabled) rem PPTX Image Compressor - Installer/Runner (Batch-enabled)
rem Fix: caesiumclt.exe aus [ROOT]\bin; Python-Discovery ohne MS Store Alias rem Version 1.2.0
rem ============================================ rem ============================================
set "APP_NAME=PPTX Image Compressor" set "APP_NAME=PPTX Image Compressor"
@@ -12,7 +12,7 @@ set "SELF_DIR=%~dp0"
set "SCRIPT=%SELF_DIR%pptx_image_compress.py" set "SCRIPT=%SELF_DIR%pptx_image_compress.py"
rem ---- Python Embeddable config ---- rem ---- Python Embeddable config ----
set "PY_EMBED_VERSION=3.14.5" set "PY_EMBED_VERSION=3.14.6"
set "PY_EMBED_ZIP=python-%PY_EMBED_VERSION%-embed-amd64.zip" set "PY_EMBED_ZIP=python-%PY_EMBED_VERSION%-embed-amd64.zip"
set "PY_EMBED_URL=https://www.python.org/ftp/python/%PY_EMBED_VERSION%/%PY_EMBED_ZIP%" set "PY_EMBED_URL=https://www.python.org/ftp/python/%PY_EMBED_VERSION%/%PY_EMBED_ZIP%"
set "PY_DIR=%SELF_DIR%python-embed" set "PY_DIR=%SELF_DIR%python-embed"
@@ -110,6 +110,14 @@ if errorlevel 1 (
) )
set "PY_CMD=%PY_EXE%" set "PY_CMD=%PY_EXE%"
rem ---- Fix embedded Python isolation for the installation of pip ----
set "PTH_FILE=%PY_DIR%\python314._pth"
if exist "%PTH_FILE%" (
echo [INFO] Enabling site-packages in embedded Python...
powershell -Command ^
"(Get-Content '%PTH_FILE%') -replace '^#?\s*import site','import site' | Set-Content '%PTH_FILE%'"
)
:have_python :have_python
if not defined PY_CMD ( if not defined PY_CMD (
echo [ERROR] Konnte Python nicht ermitteln. Abbruch. echo [ERROR] Konnte Python nicht ermitteln. Abbruch.
@@ -122,8 +130,17 @@ if not exist "%SCRIPT%" (
exit /b 6 exit /b 6
) )
set "RUN_ARGS=%*" set "ALL_ARGS=%*"
if "%~1"=="" set "RUN_ARGS=-h" set "RUN_ARGS=%ALL_ARGS%"
set "DEBUG_MODE=0"
if "%~1"=="--debug" (
set "DEBUG_MODE=1"
set "RUN_ARGS=!ALL_ARGS:~8!"
if "!RUN_ARGS:~0,1!"==" " set "RUN_ARGS=!RUN_ARGS:~1!"
)
if "!RUN_ARGS!"=="" set "RUN_ARGS=-h"
echo [INFO] Pruefe und installiere Python-Abhaengigkeit: svg-polish ... echo [INFO] Pruefe und installiere Python-Abhaengigkeit: svg-polish ...
set "PIP_OK=0" set "PIP_OK=0"
@@ -165,14 +182,22 @@ if "%PIP_OK%"=="0" (
if "%PIP_OK%"=="1" ( if "%PIP_OK%"=="1" (
if defined USE_PY_LAUNCHER ( if defined USE_PY_LAUNCHER (
"%PY_CMD%" -3 -m pip install --disable-pip-version-check --quiet svg-polish "%PY_CMD%" -3 -m pip install --disable-pip-version-check --quiet --no-warn-script-location svg-polish
) else ( ) else (
"%PY_CMD%" -m pip install --disable-pip-version-check --quiet svg-polish "%PY_CMD%" -m pip install --disable-pip-version-check --quiet --no-warn-script-location svg-polish
) )
if errorlevel 1 ( if errorlevel 1 (
echo [WARN] 'svg-polish' konnte nicht installiert werden. SVG-Dateien werden nicht komprimiert. echo [WARN] 'svg-polish' konnte nicht installiert werden. SVG-Dateien werden nicht komprimiert.
) else ( ) else (
echo [OK] 'svg-polish' ist verfuegbar. echo [OK] 'svg-polish' ist verfuegbar.
if %DEBUG_MODE%==1 (
echo [DEBUG] pip list:
if defined USE_PY_LAUNCHER (
"%PY_CMD%" -3 -m pip list
) else (
"%PY_CMD%" -m pip list
)
)
) )
) else ( ) else (
echo [WARN] pip konnte nicht eingerichtet werden. SVG-Dateien werden nicht komprimiert. echo [WARN] pip konnte nicht eingerichtet werden. SVG-Dateien werden nicht komprimiert.
+107
View File
@@ -0,0 +1,107 @@
# PPTX Image Compressor Installation Logic
## 1. Intro One Line Summary
> The script selects the best available Python environment, falls back to a self-installed embedded runtime if necessary, ensures `pip`, installs `svg-polish` when possible, and runs the application with graceful degradation.
## 2. Lightweight Overview
```text
START
├─► Find usable Python
│ ├─ venv (active / local)
│ ├─ system Python
│ └─ fallback: download embedded Python
├─► Ensure pip works
│ ├─ pip exists → OK
│ ├─ ensurepip → try fix
│ └─ get-pip.py → fallback fix
├─► Install dependency
│ └─ svg-polish (optional but preferred)
├─► Run main script
└─► END
```
---
## 3. Detailed Logic Tree
```text
START
├─► [A] Pre-check: caesiumclt
│ ├─ found → continue
│ └─ not found → EXIT
├─► [B] Python resolution (priority-based)
│ │
│ ├─ Active venv (VIRTUAL_ENV)?
│ │ └─ use it ✅
│ │
│ ├─ Local ".venv"?
│ │ └─ use it ✅
│ │
│ ├─ Local "venv"?
│ │ └─ use it ✅
│ │
│ ├─ System Python (python.exe, excluding WindowsApps)?
│ │ └─ use it ✅
│ │
│ ├─ Python launcher (py.exe)?
│ │ └─ use py -3 ✅
│ │
│ ├─ Existing embedded Python?
│ │ └─ use it ✅
│ │
│ └─ NONE FOUND →
│ ├─ Download embeddable Python
│ ├─ Extract to python-embed
│ ├─ Fix isolation (enable "import site")
│ └─ use it ✅
├─► [C] Validate main script exists
│ ├─ missing → EXIT
│ └─ exists → continue
├─► [D] Ensure pip availability
│ │
│ ├─ pip works?
│ │ └─ YES → continue ✅
│ │
│ └─ NO →
│ ├─ try: ensurepip
│ │ ├─ success → ✅
│ │ └─ fail →
│ │
│ └─ if embedded Python:
│ ├─ download get-pip.py
│ ├─ execute it
│ ├─ remove file
│ └─ re-check pip
│ ├─ still no pip →
│ │ └─ WARN: disable SVG compression
│ │
│ └─ pip available →
│ ✅ continue
├─► [E] Install dependency
│ ├─ install svg-polish
│ │ ├─ success → ✅ SVG enabled
│ │ └─ fail → ⚠ SVG disabled
│ │
│ └─ optional debug: pip list
├─► [F] Run application
│ ├─ execute Python script
│ ├─ capture return code
│ ├─ success → "Fertig"
│ └─ error → report exit code
└─► END
```
Binary file not shown.

After

Width:  |  Height:  |  Size: 800 KiB

+54 -16
View File
@@ -2,7 +2,11 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """
PPTX Raster & Vector Komprimier-Tool (Raster-Iamges: via CaesiumCLT, Vector-Images: via python Module svg_polish) PPTX Raster & Vector Komprimier-Tool (Raster-Iamges: via CaesiumCLT, Vector-Images: via python Module svg_polish)
Version: 1.1.8 Version: 1.1.9
Änderungen in 1.1.9
- SVG Files Default Profile: `balanced` statt `aggressive`
- Datei-Eigenschaften der neu generierten PPTX enthält Hinweis auf Compression `compressed by PPTX Image Compressor`
Änderungen in 1.1.8: Änderungen in 1.1.8:
- SVG Files werden bei Vorhandensein von svg_polish anhand von 2 Profilen optimiert: balanced|agressive - SVG Files werden bei Vorhandensein von svg_polish anhand von 2 Profilen optimiert: balanced|agressive
@@ -38,7 +42,7 @@ from typing import Callable, List, Optional
__version__ = "1.1.8" __version__ = "1.2.0"
RASTER_EXT = {".jpg", ".jpeg", ".png", ".webp", ".gif"} RASTER_EXT = {".jpg", ".jpeg", ".png", ".webp", ".gif"}
VECTOR_EXT = {".svg"} VECTOR_EXT = {".svg"}
@@ -50,7 +54,7 @@ PNG_TO_JPEG_THRESHOLD_BYTES = 500 * 1024
SVG_POLISH_MODULE_NAME = "svg_polish" SVG_POLISH_MODULE_NAME = "svg_polish"
SVG_PROFILE_BALANCED = "balanced" SVG_PROFILE_BALANCED = "balanced"
SVG_PROFILE_AGGRESSIVE = "aggressive" SVG_PROFILE_AGGRESSIVE = "aggressive"
SVG_PROFILE_DEFAULT = SVG_PROFILE_AGGRESSIVE SVG_PROFILE_DEFAULT = SVG_PROFILE_BALANCED
@dataclass @dataclass
@@ -252,17 +256,8 @@ def build_svg_polish_options(svg_polish_module: object, profile: str = SVG_PROFI
try: try:
if profile == SVG_PROFILE_BALANCED: if profile == SVG_PROFILE_BALANCED:
return options_type( return options_type(
digits=3, shorten_ids=True,
style_to_xml=True, enable_viewboxing=True,
group_collapse=True,
simple_colors=True,
indent_type="none",
newlines=False,
strip_xml_prolog=True,
strip_comments=True,
remove_metadata=True,
remove_titles=True,
remove_descriptions=True,
) )
return options_type( return options_type(
digits=2, digits=2,
@@ -648,6 +643,8 @@ def process_single_deck(
except Exception: except Exception:
pass pass
update_core_description(work_dir, "PPTX Image Compressor",__version__)
zip_dir_to_pptx(work_dir, output_pptx) zip_dir_to_pptx(work_dir, output_pptx)
size_after = output_pptx.stat().st_size size_after = output_pptx.stat().st_size
result.size_after = size_after result.size_after = size_after
@@ -832,8 +829,9 @@ def extractParserArguments():
parser.add_argument('-O','--output-dir', help='Output-Verzeichnis (erforderlich für Batch)') parser.add_argument('-O','--output-dir', help='Output-Verzeichnis (erforderlich für Batch)')
parser.add_argument('--pattern', default='*.pptx', help='Dateimuster für --input-dir') parser.add_argument('--pattern', default='*.pptx', help='Dateimuster für --input-dir')
parser.add_argument('--recursive', action='store_true', help='Rekursiv in --input-dir suchen') parser.add_argument('--recursive', action='store_true', help='Rekursiv in --input-dir suchen')
#parser.add_argument('-t','--threads', type=int, default=min(32, os.cpu_count() or 4), help='Anzahl paralleler Threads pro Datei') # Standard as of https://docs.python.org/3/library/concurrent.futures.html. Changed in version 3.13: Default value of max_workers is changed to min(32, (os.process_cpu_count() or 1) + 4).
parser.add_argument('-t','--threads', type=int, default=16, help='Anzahl paralleler Threads pro Datei') # On my machine this is 16 Threads
parser.add_argument('-t','--threads', type=int, default=min(32, (os.process_cpu_count() or 1) + 4), help='Anzahl paralleler Threads pro Datei')
parser.add_argument('-q','--quality', type=int, default=90, help='Qualität für caesiumclt (0..100), höher = bessere Qualität / größere Datei') parser.add_argument('-q','--quality', type=int, default=90, help='Qualität für caesiumclt (0..100), höher = bessere Qualität / größere Datei')
parser.add_argument('--min-savings', default=DEFAULT_MIN_SAVINGS, help="Mindestersparnis für caesiumclt (z. B. 2%%, 100KB, 1MB oder Bytes als Zahl)") parser.add_argument('--min-savings', default=DEFAULT_MIN_SAVINGS, help="Mindestersparnis für caesiumclt (z. B. 2%%, 100KB, 1MB oder Bytes als Zahl)")
parser.add_argument('--svg-profile', choices=[SVG_PROFILE_BALANCED, SVG_PROFILE_AGGRESSIVE], default=SVG_PROFILE_DEFAULT, help='Optimierungsprofil für SVG-Kompression') parser.add_argument('--svg-profile', choices=[SVG_PROFILE_BALANCED, SVG_PROFILE_AGGRESSIVE], default=SVG_PROFILE_DEFAULT, help='Optimierungsprofil für SVG-Kompression')
@@ -845,6 +843,46 @@ def extractParserArguments():
def update_core_description(base_dir, app_name, version):
core_xml_path = Path(base_dir) / "docProps" / "core.xml"
if not core_xml_path.exists():
raise FileNotFoundError(f"{core_xml_path} nicht gefunden")
# Namespaces definieren
ns = {
"cp": "http://schemas.openxmlformats.org/package/2006/metadata/core-properties",
"dc": "http://purl.org/dc/elements/1.1/",
"dcterms": "http://purl.org/dc/terms/",
"xsi": "http://www.w3.org/2001/XMLSchema-instance"
}
# Registrieren, damit Prefixe erhalten bleiben
for prefix, uri in ns.items():
ET.register_namespace(prefix, uri)
tree = ET.parse(core_xml_path)
root = tree.getroot()
description_text = f"compressed by {app_name} {version}"
# Suche vorhandenes Element
desc_elem = root.find("dc:description", ns)
if desc_elem is None:
# neu anlegen
desc_elem = ET.SubElement(
root,
f"{{{ns['dc']}}}description"
)
# Text setzen/überschreiben
desc_elem.text = description_text
# Datei speichern
tree.write(core_xml_path, encoding="utf-8", xml_declaration=True)
if __name__ == '__main__': if __name__ == '__main__':
main() main()
+3
View File
@@ -0,0 +1,3 @@
svg-polish==1.0.0
pytest==9.0.3
pytest-cov==7.1.0
+1
View File
@@ -0,0 +1 @@
svg-polish==1.0.0
+39
View File
@@ -0,0 +1,39 @@
@echo off
setlocal EnableExtensions EnableDelayedExpansion
if "%~1"=="" goto help
set "INPUT=%~1"
set "EXT=%~x1"
set "PATH=%PATH%;%~dp0"
if /I not "%EXT%"==".pptx" (
echo [ERROR] Only .pptx supported
pause
exit /b 1
)
echo [INFO] Compressing %~n1
rem optional: ensure correct working dir
pushd "%~dp0"
"%~dp0pptx-image-compress.exe" -i "%INPUT%"
set RC=%ERRORLEVEL%
popd
if %RC% neq 0 (
echo [ERROR] Failed (%RC%)
) else (
echo [SUCCESS] Done
)
pause
exit /b %RC%
:help
echo.
echo Drag ^& Drop a .pptx file onto this script
echo.
pause
+8
View File
@@ -0,0 +1,8 @@
@echo off
setlocal EnableExtensions
if "%~1"=="" (
"%~dp0pptx-image-compress.exe" -h
) else (
"%~dp0pptx-image-compress.exe" %*
)
+22 -25
View File
@@ -155,15 +155,17 @@ class TestPptxImageCompress(unittest.TestCase):
out.write_bytes(b"B" * 50) out.write_bytes(b"B" * 50)
return out return out
result = pic.process_single_deck( with mock.patch("pptx_image_compress.update_core_description", create=True) as mocked_update_core_description:
input_pptx=input_pptx, result = pic.process_single_deck(
output_pptx=output_pptx, input_pptx=input_pptx,
threads=2, output_pptx=output_pptx,
quality=90, threads=2,
min_savings="2%", quality=90,
compressor=fake_compressor, min_savings="2%",
) compressor=fake_compressor,
)
mocked_update_core_description.assert_called_once_with(mock.ANY, "PPTX Image Compressor", pic.__version__)
self.assertTrue(result.ok) self.assertTrue(result.ok)
self.assertEqual(result.error, None) self.assertEqual(result.error, None)
self.assertTrue(output_pptx.exists()) self.assertTrue(output_pptx.exists())
@@ -222,15 +224,17 @@ class TestPptxImageCompress(unittest.TestCase):
out.write_bytes(b"B" * 700000) out.write_bytes(b"B" * 700000)
return out return out
result = pic.process_single_deck( with mock.patch("pptx_image_compress.update_core_description", create=True) as mocked_update_core_description:
input_pptx=input_pptx, result = pic.process_single_deck(
output_pptx=output_pptx, input_pptx=input_pptx,
threads=1, output_pptx=output_pptx,
quality=90, threads=1,
min_savings="2%", quality=90,
compressor=fake_compressor, min_savings="2%",
) compressor=fake_compressor,
)
mocked_update_core_description.assert_called_once_with(mock.ANY, "PPTX Image Compressor", pic.__version__)
self.assertTrue(result.ok) self.assertTrue(result.ok)
with zipfile.ZipFile(output_pptx, "r") as z: with zipfile.ZipFile(output_pptx, "r") as z:
self.assertIn("ppt/media/image1.jpg", z.namelist()) self.assertIn("ppt/media/image1.jpg", z.namelist())
@@ -314,13 +318,6 @@ class TestPptxImageCompress(unittest.TestCase):
result = pic.optimize_svg_content_with_module(fake_module, svg) result = pic.optimize_svg_content_with_module(fake_module, svg)
self.assertEqual(result, "<svg/>") self.assertEqual(result, "<svg/>")
self.assertEqual(captured_options["digits"], 2)
self.assertEqual(captured_options["indent_type"], "none")
self.assertEqual(captured_options["newlines"], False)
self.assertEqual(captured_options["strip_xml_prolog"], True)
self.assertEqual(captured_options["strip_comments"], True)
self.assertEqual(captured_options["strip_ids"], True)
self.assertEqual(captured_options["renderer_workaround"], False)
self.assertEqual(fake_module.optimize_path.call_count, 1) self.assertEqual(fake_module.optimize_path.call_count, 1)
def test_build_svg_polish_options_balanced_profile(self): def test_build_svg_polish_options_balanced_profile(self):
@@ -336,8 +333,8 @@ class TestPptxImageCompress(unittest.TestCase):
options = pic.build_svg_polish_options(fake_module, pic.SVG_PROFILE_BALANCED) options = pic.build_svg_polish_options(fake_module, pic.SVG_PROFILE_BALANCED)
self.assertIsNotNone(options) self.assertIsNotNone(options)
self.assertEqual(captured_options["digits"], 3) self.assertEqual(captured_options["shorten_ids"], True)
self.assertEqual(captured_options["group_collapse"], True) self.assertEqual(captured_options["enable_viewboxing"], True)
self.assertNotIn("strip_ids", captured_options) self.assertNotIn("strip_ids", captured_options)
def test_compress_svg_with_svg_polish_returns_none_when_module_missing(self): def test_compress_svg_with_svg_polish_returns_none_when_module_missing(self):