Skip to content

Commit

Permalink
add commands to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kimpham54 committed Oct 11, 2024
1 parent 9a6a172 commit af8cd2d
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,30 @@ pip install jp2_remediator==0.0.2

## Usage

```python
from jp2_remediator import main
## Process one file
`python3 box_reader.py --file tests/test-images/7514499.jp2`

main.hello_world()
main.add_one(4)
```
`python3 box_reader.py --file tests/test-images/481014278.jp2`

## Process directory
`python3 box_reader.py --directory tests/test-images/`

## Process Amazon S3 bucket
`python3 box_reader.py --bucket your-bucket-name --prefix optional-prefix`

## Process all .jp2 files in the bucket:
`python3 box_reader.py --bucket remediation-folder`

##Process only files with a specific prefix (folder):
`python3 box_reader.py --bucket remediation-folder --prefix testbatch_20240923`

`python3 box_reader.py --help`

## Run Tests
`python3 test_aws_connection.py`

### Run from src folder
`python3 -m unittest jp2_remediator.tests.test_box_reader`

## Docker environment

Expand Down

0 comments on commit af8cd2d

Please sign in to comment.