https://github.com/iandinwoodie/pdfpop

🍡Automate PDF population with pdfpop.
https://github.com/iandinwoodie/pdfpop

csv excel forms pdf populate

Last synced: 1 day ago
JSON representation

🍡Automate PDF population with pdfpop.

• Host: GitHub
• URL: https://github.com/iandinwoodie/pdfpop
• Owner: iandinwoodie
• License: gpl-3.0
• Created: 2022-05-06T02:48:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-23T14:00:06.000Z (over 2 years ago)
• Last Synced: 2024-12-20T02:33:58.218Z (about 1 month ago)
• Topics: csv, excel, forms, pdf, populate
• Language: Python
• Homepage:
• Size: 854 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-THIRD-PARTY.txt

Awesome Lists containing this project

README

        


  



[![License](https://img.shields.io/github/license/iandinwoodie/pdfpop)](https://github.com/iandinwoodie/pdfpop/blob/main/LICENSE.txt)

[![Release](https://img.shields.io/github/v/tag/iandinwoodie/pdfpop)](https://github.com/iandinwoodie/pdfpop/releases)

[![CI/CD Tests](https://github.com/iandinwoodie/pdfpop/actions/workflows/tests.yml/badge.svg)](https://github.com/iandinwoodie/pdfpop/actions/workflows/tests.yml)

[![Codecov](https://codecov.io/gh/iandinwoodie/pdfpop/branch/main/graph/badge.svg?token=ZNY5FIHA9U)](https://codecov.io/gh/iandinwoodie/pdfpop)

[![Size](https://img.shields.io/github/repo-size/iandinwoodie/pdfpop)](https://github.com/iandinwoodie/pdfpop)

---

Automate PDF population with pdfpop.

## Installation

You can install `pdfpop` with:

```bash

pip install pdfpop

```

## Usage

The `pdfpop` usage consists of two steps: (1) form configuration and (2)

execution.

### Step 1. Form Configuration

> ℹ️  This step only needs to be run once for each unique form.

This step generates a form-specific configuration file that allows you to inform

`pdfpop` how data should be routed from the data file to the PDF form. You can

generate this file with the `config` command:

```bash

# Usage: pdfpop config 

pdfpop config examples/example-form.pdf

```

This will output a `pdfpop-` prefixed JSON file in your current working

directory (e.g., `pdfpop-example-form.json`). By default, all fields will be

assigned a value of `null` and, therefore, will be ignored until the `null`

value is replaced with instructions on how to populate the field. An example of

an edited configuration file is available [here](https://github.com/iandinwoodie/pdfpop/blob/main/examples/example-form.json).

### Step 2. Exectuion

Once you have a form configuration file you can populate your PDF form using the

`run` command:

```bash

# Usage: pdfpop run  

pdfpop run examples/example-form.json examples/example-data.xlsx

```

This will generate a populated PDF form at the location prescribed by the values

of`/` in the configuration file (e.g.,

`examples/pdfpop-example-form.pdf`).

# License

Copyright (C) 2022 Ian Dinwoodie

* Licensed under [GNU General Public License v3.0](https://github.com/iandinwoodie/pdfpop/blob/main/LICENSE.txt).

* Exceptions:

    * Material covered by [Third Party Licenses](https://github.com/iandinwoodie/pdfpop/blob/main/LICENSE-THIRD-PARTY.txt).

    * Logo icon: Popsicle stick icons created by Freepik - Flaticon