i2pdf 1.1.1

i2pdf

i2pdf combines multiple images together to create a single .pdf.

Report Bug · Request Feature

About The Project

(back to top)

Built With

A list of frameworks that were used in developing the program.

• typer
• PyYAML
• Pillow
• PyPDF2

(back to top)

Getting Started

i2pdf was created with python 3.9 and should be used with this version of python.

Prerequisites

Standard Libraries

The following standard libraries are used.

os
platform

Pip

The following dependencies are necessary.

typer~=0.4.0
PyYAML~=6.0
Pillow~=9.0.1
PyPDF2~=1.26.0

Installation

To install i2pdf, enter the following command in the command prompt:

pip install i2pdf

If the installation was successful, then the following text should appear in the terminal

Mac 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)

Usage

Commands

add-metadata

Arguments:
  [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.yml

If 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 keywords

This file should be stored in the config folder.

gen-dir

Before 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:

gen-pdf

Arguments:
  [SAVE_NAME]  Enter the save name of the .pdf file  [default: generated]

Example:

i2pdf gen-pdf testfile

Place 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 generated

Roadmap

• adding the ability to add a table of contents to the generated pdf.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Christopher Chandler - christopher.chandler@outlook.de

Project Link: https://github.com/christopher-chandler/i2pdf

(back to top)

Acknowledgments

/

(back to top)