Skip to content

synthetic-society/corehr-pdf-split

Repository files navigation

CoreHR Application Pack PDF Splitter

CI Python License PyPI version codecov

A Python package to extract individual applications from a combined PDF file, such as for Oxford HR application packs.

Installation and Usage

Option 1: Using uvx (Recommended)

If you have uv installed, you can run the tool directly without installing it:

uvx corehr-pdf-split --input-pdf applicationspack.pdf --output-dir output

Option 2: Install from PyPI

Install the package globally or in a virtual environment:

pip install corehr-pdf-split

Then run:

corehr-pdf-split --input-pdf applicationspack.pdf --output-dir output

Option 3: Using uv (for development or local use)

uv tool install corehr-pdf-split

Then run:

corehr-pdf-split --input-pdf applicationspack.pdf --output-dir output

How it works

The tool processes the input PDF file and saves individual applications in the specified output directory. The output folder will be created if it does not exist yet. Each applicant's PDF is saved with a filename format: LastName,FirstName [ApplicantID].pdf.

Example

uvx corehr-pdf-split --input-pdf applicationspack.pdf --output-dir output

This will process the applicationspack.pdf file and save individual applications in the output directory.

Development

If you want to contribute to or modify this project:

Prerequisites

  • uv for dependency management

Setup

  1. Clone this repository:

    git clone https://github.com/synthetic-society/corehr-pdf-split.git
    cd corehr-pdf-split
  2. Install dependencies:

    uv sync
  3. Set up pre-commit hooks:

    uvx pre-commit install
  4. Run the tool in development mode:

    uv run corehr-pdf-split --input-pdf <path_to_input_pdf> --output-dir <path_to_output_directory>

Code Quality

We use pre-commit hooks to ensure code quality. Run checks manually with:

uvx pre-commit run --all-files

Building and Publishing

To build the package:

uv build

To publish to PyPI (maintainers only):

uv publish

License

This project is available under the MIT License.

Contributing

Contributions, issues, and feature requests are welcome.

About

Python package to extract individual applications from a combined CoreHR PDF file

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages