Table of Contents
A list of frameworks that were used in developing the program.
i2pdf was created with python 3.9 and should be used with this version of python.
The following standard libraries are used.
datetime
os
platform
The following dependencies are necessary.
typer~=0.4.0
PyYAML~=6.0
Pillow~=9.0.1
PyPDF2~=1.26.0
setuptools~=58.1.0
To install i2pdf, enter the following command in the command prompt:
- pypi installation
pip install i2pdf
- build from local project
bash build_package.bash
If the installation was successful, then the following text should appear in the terminal
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.
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.
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:
| Folder | Description |
|---|---|
| config | this contains the .yaml files. |
| images | the image files that are to be combined to a pdf |
| pdfs | the generated .pdf files. |
| results | the pdf files that had metadata added . |
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
- 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).
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!
- Fork the Project
- Create 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
Distributed under the MIT License. See LICENSE for more information.
Christopher Chandler - [email protected]
Project Link: https://github.com/christopher-chandler/i2pdf
/