Package: i2pdf
i2pdfi2pdf combines multiple images together to create a single .pdf.Report Bug·Request FeatureTable of ContentsAbout The ProjectBuilt WithGetting StartedPrerequisitesInstallationUsageRoadmapContributingLicenseContactAcknowledgmentsAbout The Project(back to top)Built WithA list of frameworks that were used in developing the program.typerPyYAMLPillowPyPDF2(back to top)Getting Startedi2pdf was created with python 3.9 and should be used with this version of python.PrerequisitesStandard LibrariesThe following standard libraries are used.os
platformPipThe following dependencies are necessary.typer~=0.4.0
PyYAML~=6.0
Pillow~=9.0.1
PyPDF2~=1.26.0InstallationTo install i2pdf, enter the following command in the command prompt:pip install i2pdfIf the installation was successful, then the following text
should appear in the terminalMac example:Usage: main_app.py [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.

  --help                          Show this message and exit.

Commands:
  add-metadata  Add the data from the .yaml file to the .pdf as metadata.
  gen-dir       Generate directories where the files should reside.
  gen-pdf       Generate a .pdf from a collection of images.(back to top)UsageCommandsadd-metadataArguments:
  [PDF_NAME]     The name of the .pdf that should have metadata added.
                 [default: ]

  [CONFIG_NAME]  The name of the .yaml file which contains the config data.
                 [default: ]Example:i2pdf add-metadata test.pdf test.ymlIf you wish to have metadata added to the .pdf,
you must store it in a .yaml or .yml file.The format of this file should be as follows:/author: test author
/keywords: test keywordsThis file should be stored in the config folder.gen-dirBefore you can combine the images to a .pdf,
you must first generate the necessary folders.
It is possible to do this by hand,
but this command automatically generates the folders
in the directory in which i2pdf was called.The following empty folders are generated:FolderDescriptionconfigthis contains the .yaml files.imagesthe image files that are to be combined to a pdfpdfsthe generated .pdf files.resultsthe pdf files that had metadata added .gen-pdfArguments:
  [SAVE_NAME]  Enter the save name of the .pdf file  [default: generated]Example:i2pdf gen-pdf testfilePlace the images in this file that are to be combined to a .pdf file.
You have the option of specifying a name for the file being generated.
if no file is added, then it is automatically called generatedRoadmapadding the ability to add a table of contents to the generated pdf.See theopen issuesfor a full list of proposed features (and known issues).(back to top)ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)LicenseDistributed under the MIT License. SeeLICENSEfor more information.(back to top)ContactChristopher Chandler -christopher.chandler@outlook.deProject Link:https://github.com/christopher-chandler/i2pdf(back to top)Acknowledgments/(back to top)