Metadata-Version: 2.1
Name: cpp_aws_s3_pdf
Version: 1.0.1
Summary: This package createds a PDF file from selected s3 objects
Project-URL: Homepage, https://github.com/noble-cc/cpp_aws_s3_pdf
Project-URL: Issues, https://github.com/noble-cc/cpp_aws_s3_pdf/issues
Author-email: Noble Obioma <nobioma1@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: boto3>=1.28.76
Requires-Dist: botocore>=1.31.76
Requires-Dist: pillow>=10.1.0
Requires-Dist: pypdf>=3.17.1
Description-Content-Type: text/markdown

# CPP_AWS_S3_PDF

## Overview

Cpp_aws_s3_pdf is a Python utility library designed to streamline the process of combining objects from Amazon S3 into a
single
PDF file.
This tool is ideal for users who need to aggregate content stored in S3 buckets and generate consolidated PDF documents
for reports, archives, or data presentation.

## Features

- S3 Integration: Seamlessly connect to Amazon S3 buckets and access objects.
- PDF Generation: Efficiently combine multiple objects into a single PDF file.
- Security: Ensures secure access to S3 resources with AWS credentials, with expiration on combined files.

## Installation

To install Your-Library-Name, simply use pip:

```bash
pip install cpp_aws_s3_pdf
```

## Usage

Here's a quick start on how to use `cpp_aws_s3_pdf`:

- Set up AWS Credentials: Ensure your AWS credentials are configured properly.
  This can be done by following the guidelines outline on
  the [Boto3 Configuration](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html#configuration)
  Page.

- Import and Initialize:

```python
from cpp_aws_s3_pdf.s3_pdf import S3Pdf

s3_pdf = S3Pdf(bucket_name='your-bucket-name')
```

- Combine S3 Objects into PDF:

```python
objects_to_combine = ['object_key1', 'object_key2', ...]
download_url = s3_pdf.combine_objects(objects_to_combine, output_bucket_name='my_combine_bucket')

# object is over-written with watermarked object in bucket
s3_pdf.watermark_file(objects_to_combine[2], "This is a sample watermark.")

# convert_object_to_pdf
download_url = convert_image_to_pdf("object_image.jpg")
```

## Configuration

- AWS Region: Set the AWS region where your S3 bucket is located.

## Dependencies

- AWS
- boto3
- PyPDF
- Pillow

## For local development

- Clone repository

```bash
https://github.com/noble-cc/cpp_aws_s3_pdf.git
```

- Create `venv` environment and activate environment

- Build project

```bash
python -m build
```

### To install project locally:
```bash
pip install <file_path>*-any.whl
```

## License

This project is licensed under the MIT License.

