Metadata-Version: 2.1
Name: sheetfusion
Version: 1.0.2
Project-URL: Homepage, https://github.com/SMZ70/SheetFusion
Project-URL: Bug Tracker, https://github.com/SMZ70/SheetFusion/issues
Author-email: Mohammad Znz <52261779+SMZ70@users.noreply.github.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: pypdf3~=1.0.6
Description-Content-Type: text/markdown

[python]: https://img.shields.io/badge/-Python-3776AB?logo=python&logoColor=white
[version]: https://img.shields.io/badge/Version-1.0.1-blue

![python][python]
![version][version]

<p align="center">
  <img src="https://raw.githubusercontent.com/SMZ70/SheetFusion/master/assets/logo.png" alt="SheetFusion Logo" width="200">
</p>

<h1 align="center">SheetFusion</h1>

<p align="center">
  <b>Simple, user-friendly tool for merging cover sheets with document files.</b>
</p>

## 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.

## Installation

### Using pip

```bash
pip install sheetfusion
```

### From source

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

## Usage

`SheetFusion` is a command-line tool for merging cover sheets with exams. Use the following syntax to run `SheetFusion`:

## Usage

`SheetFusion` is a command-line tool designed for merging cover sheets with exams. To use it, follow the command syntax below:

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

### Help Options

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

### Required Arguments

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

### Optional Arguments

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

## Examples

The following examples demonstrate how to use `SheetFusion`:

### Basic Usage

```bash
sheetfusion -c cover_sheets.pdf -e exam.pdf
```

### Specifying an Output Directory

```bash
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.

```bash
sheetfusion -c cover_sheets.pdf -e exam.pdf -o output_dir --overwrite
```

## Change Log

See the [CHANGELOG](CHANGELOG.md) for more information.

## License

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