jp2-remediator 1.0.0

A module to validate jp2images

jp2_remediator

README for the module to validate jp2images

https://pypi.org/project/jp2_remediator/

Installation

pip install jp2_remediator
python3 -m pip install jp2_remediator

pip install jp2_remediator==0.0.2

Usage

python3 src/jp2_remediator/main.py  -h

usage: main.py [-h] {file,directory,bucket} ...

JP2 file processor

options:
  -h, --help            show this help message and exit

Input source:
  {file,directory,bucket}
    file                Process a single JP2 file
    directory           Process all JP2 files in a directory
    bucket              Process all JP2 files in an S3 bucket

Process one file

python3 src/jp2_remediator/main.py file tests/test-images/7514499.jp2

python3 src/jp2_remediator/main.py file tests/test-images/481014278.jp2

Process directory

python3 src/jp2_remediator/main.py directory tests/test-images/

Process all .jp2 files in an S3 bucket:

python3 src/jp2_remediator/main.py bucket remediation-folder

Process only files with a specific prefix (folder):

python3 src/jp2_remediator/main.py bucket remediation-folder --prefix testbatch_20240923`

Run tests

Run integration tests

pytest src/jp2_remediator/tests/integration/

Run unit tests

pytest src/jp2_remediator/tests/unit/

Docker environment

Build Docker image

./bin/docker-build.sh

Start Docker container

./bin/docker-run.sh

Development environment

python3 -m venv myenv
source myenv/bin/activate
export PYTHONPATH="${PYTHONPATH}:src"
pip install -r requirements.txt

python src/jp2_remediator/main.py -h