Add rm module

Author: ebotiab

pdfly/cli.py

@@ -15,6 +15,7 @@
 import pdfly.extract_images
 import pdfly.metadata
 import pdfly.pagemeta
+import pdfly.rm
 import pdfly.up2
 import pdfly.x2pdf
 
@@ -104,7 +105,7 @@ def cat(
     pdfly.cat.main(filename, fn_pgrgs, output, verbose)
 
 
-@entry_point.command(name="rm")  # type: ignore[misc]
+@entry_point.command(name="rm", help=pdfly.rm.__doc__)
 def rm(
     filename: Annotated[
         Path,
@@ -125,9 +126,7 @@ def rm(
         False, help="show page ranges as they are being read"
     ),
 ) -> None:
-    pdfly.cat.main(
-        filename, fn_pgrgs, output, verbose, inverted_page_selection=True
-    )
+    pdfly.rm.main(filename, fn_pgrgs, output, verbose)
 
 
 @entry_point.command(name="meta", help=pdfly.metadata.__doc__)  # type: ignore[misc]

pdfly/rm.py

@@ -0,0 +1,50 @@
+"""
+Remove pages from PDF files.
+
+Page ranges refer to the previously-named file.
+A file not followed by a page range means all the pages of the file.
+
+PAGE RANGES are like Python slices.
+
+        Remember, page indices start with zero.
+
+        Page range expression examples:
+
+            :     all pages.                   -1    last page.
+            22    just the 23rd page.          :-1   all but the last page.
+            0:3   the first three pages.       -2    second-to-last page.
+            :3    the first three pages.       -2:   last two pages.
+            5:    from the sixth page onward.  -3:-1 third & second to last.
+
+        The third, "stride" or "step" number is also recognized.
+
+            ::2       0 2 4 ... to the end.    3:0:-1    3 2 1 but not 0.
+            1:10:2    1 3 5 7 9                2::-1     2 1 0.
+            ::-1      all pages in reverse order.
+
+Examples
+    pdfly rm -o output.pdf document.pdf 2:5
+
+        Remove pages 2 to 4 from document.pdf, producing output.pdf.
+
+    pdfly rm document.pdf :-1
+
+        Removes all pages except the last one from document.pdf, modifying the original file.
+
+    pdfly rm report.pdf :6 7:
+
+        Remove all pages except page seven from report.pdf,
+        producing a single-page report.pdf.
+
+"""
+
+from pathlib import Path
+from typing import List
+
+from pdfly.cat import main as cat_main
+
+
+def main(
+    filename: Path, fn_pgrgs: List[str], output: Path, verbose: bool
+) -> None:
+    cat_main(filename, fn_pgrgs, output, verbose, inverted_page_selection=True)