Add `--format` Option for Custom Page Sizes in `x2pdf` Command

mulla028 commented 3 weeks ago

Closes #63

Summary

This pull request introduces the --format option to the x2pdf command in pdfly, allowing users to specify custom page sizes for PDF output. The option supports standard formats such as Letter, A4-portrait, and A4-landscape, as well as custom dimensions (e.g., 210x297 mm). This enhancement provides flexibility for generating PDFs with various page sizes, scaling and centering images to fit each specified format.

Changes

Code Updates

cli.py
- Added --format option to the x2pdf command with a default value of A4-portrait.
- Updated help documentation to list available format options.
x2pdf.py
- Implemented the get_page_size function to map standard format names to dimensions or parse custom dimensions (e.g., 210x297).
- Updated image_to_pdf function to center and scale images according to the specified page size.
- Modified main function to accept format as a parameter and apply the selected page size to each PDF page.

Tests

test_x2pdf.py
- Added new test cases to validate the --format option with various formats, including standard (Letter, A4-portrait, A4-landscape) and custom dimensions (210x297).
- Included a test to handle invalid format values, verifying appropriate error handling.

Verification Steps

Run pdfly x2pdf --help to verify that --format is listed in the options.

Test x2pdf with standard and custom formats:


pdfly x2pdf sample-files/sample1.jpg --output output_letter.pdf --format Letter
pdfly x2pdf sample-files/sample2.jpg --output output_a4.pdf --format A4-portrait
pdfly x2pdf sample-files/sample3.jpg --output output_custom.pdf --format 210x297

mulla028 commented 3 weeks ago

Good job tackling this issue! 👍

Thank you for your contribution 🙂

I made a few comments as feedback.

Thank you for your feedback! I will do my best to make all these changes 🙂

mulla028 commented 3 weeks ago

@Lucas-C I tried to make all the requested changes. Review please, and let me know if you noticed any issues!

mulla028 commented 3 weeks ago

@Lucas-C Thank you for your feedback, some things were pretty new to me. Thank you for your patience. Hopefully, this time code follows your requirements 😄

mulla028 commented 3 weeks ago

@Lucas-C is my problem comes with my code styling?

Lucas-C commented 3 weeks ago

@Lucas-C is my problem comes with my code styling?

No, it's OK 🙂

I only see a couple of blocking points:

this comment has not been adressed yet: https://github.com/py-pdf/pdfly/pull/65#pullrequestreview-2404712998
the GitHub Actions pipeline is failing: https://github.com/py-pdf/pdfly/actions/runs/11616493703/job/32381813640?pr=65 This is due to a fail with the new unit test:
```
FAILED tests/test_x2pdf.py::test_x2pdf_with_format - ValueError: Invalid or unsupported page format provided: Letter
```

You should be able to reproduce the problem by executing the unit tests on your own computer 🙂

Lucas-C commented 5 days ago

Hi @mulla028 🙂

Just to get a quick update: do you still want to implement this feature?

mulla028 commented 5 days ago

Hi @mulla028 🙂

Just to get a quick update: do you still want to implement this feature?

Hi! Yes, I just had to do a lot of work for school. I am gonna finish implementing this issue by the end of this week.

py-pdf / pdfly