sheetfusion 1.0.6

No project description provided

SheetFusion

Simple, user-friendly tool for merging cover sheets with document files.

---

Description

SheetFusion is a simple, user-friendly tool designed to merge cover sheets with document files, primarily for academic and professional use. It automates the creation of personalized PDFs by combining individual cover pages with a standard document, such as exams or reports. This straightforward software offers a practical solution for those needing to distribute customized documents efficiently. It is written in Python and uses the [PyPDF3](https://github.com/sfneal/PyPDF3) library. It was created to merge cover sheets with exams. That is why the arguments are named as they are. However, it can be used to merge any PDF file with any other PDF file.

---

• 1. System Requirements
• 2. Installation
  • 2.1. Using pip (recommended)
  • 2.2. From source
• 3. Usage
  • 3.1. Arguments
  • 3.2. Examples
• 4. Change Log
• 5. License
• 6. Contact

1. System Requirements

SheetFusion runs on any system with Python installed:

• Python: Python 3.x is required. Verify your Python installation by running python --version or python3 --version in your command line.

• Operating System: Compatible with Windows, macOS, Linux, and any OS supporting Python.

2. Installation

2.1. Using pip (recommended)

python3 -m pip install sheetfusion

2.2. From source

You could use the following commands to clone and install SheetFusion. Make sure to replace X.X.X with the built version.

git clone https://github.com/SMZ70/SheetFusion.git
cd SheetFusion
python3 -m build
python3 -m pip install dist/sheetfusion-X.X.X.tar.gz

3. Usage

3.1. Arguments

SheetFusion is a command-line tool designed for merging cover sheets with exams. To use it, follow the command syntax below (see Examples for quick start).

python3 -m sheetfusion [--help] --cover-sheets --exam [--output-dir] [--overwrite]

or:

sheetfusion [--help] --cover-sheets --exam [--output-dir] [--overwrite]

4.1. Help Options

• --help, -h
  Show this help message and exit.

4.2. Required Arguments

• --cover-sheets, -c
  Specify the PDF file containing the cover sheets.
• --exam, -e
  Specify the PDF file containing the exam.

4.3. Optional Arguments

• --output-dir, -o
  Define the directory to output the merged PDFs to.
• --overwrite
  Enable overwriting of existing files.

3.2. Examples

The following examples demonstrate how to use SheetFusion:

Basic Usage

python3 -m sheetfusion -c cover_sheets.pdf -e exam.pdf

Specifying an Output Directory

python3 -m sheetfusion -c cover_sheets.pdf -e exam.pdf -o output_dir

Overwriting Existing Files

If the output directory already contains files with the same name as the merged PDFs, SheetFusion will not overwrite them by default. To enable overwriting, use the --overwrite flag.

python3 -m sheetfusion -c cover_sheets.pdf -e exam.pdf -o output_dir --overwrite

4. Change Log

See the CHANGELOG for more information.

5. License

SheetFusion is open-source software licensed under the MIT License. For more details, see the LICENSE file in this repository.

6. Contact

Thank you for your interest in SheetFusion! For bug reports, feature requests, or general inquiries related to the project, please use GitHub Issues. This is the fastest way to get your questions answered. It also allows other users to benefit from the discussion.