eagle-exporter 0.1.4

CLI tool and library for exporting metadata from Eagle app JSON into parquet or huggingface dataset.

Eagle Exporter

Eagle Exporter is a command-line utility (and Python library) to parse image metadata JSON files from an Eagle library directory and export them to either a local Parquet file or a Hugging Face Dataset repository.

Features

• Recursively scans an Eagle library's images/ folder for JSON files.
• Extracts tags, star ratings, palette info, etc.
• Optionally merges with s5cmd logs to provide S3 URIs for each file.
• NEW: Can include the actual image data when exporting to Hugging Face datasets.
• Exports to either:
  • A local .parquet file
  • A Hugging Face dataset (can be public or private).

Installation

pip install eagle-exporter

Usage

Example command to export an Eagle library to Hugging Face:

eagle-exporter path/to/my_eagle.library --to myuser/my_hf_dataset --hf-public

Export to Hugging Face with image data included:

eagle-exporter path/to/my_eagle.library --to myuser/my_hf_dataset --hf-public --include-images

Or export to a local .parquet file:

eagle-exporter path/to/my_eagle.library --to /tmp/output.parquet

Optionally include an s5cmd file to attach S3 URIs:

eagle-exporter path/to/my_eagle.library --s5cmd /path/to/s5cmd.txt --to /tmp/output.parquet

Command-Line Arguments

• EAGLE_DIR (positional): The path to your Eagle library directory (the folder that has images/ inside).

• --s5cmd <FILE> (optional): Path to the s5cmd log file (with lines like cp localfile s3://bucket/...)

• --to <DEST> (required):

  • If <DEST> ends with .parquet, will export to Parquet.
  • Otherwise, treats <DEST> as a Hugging Face dataset name (e.g. username/datasetname).

• --hf-public (optional): If exporting to Hugging Face, mark it as public.

• --include-images (optional): Include the actual image files in the export. This is particularly useful for Hugging Face exports. Note that binary image data will be excluded from Parquet exports.

• --help: Show the help message.

Developer Notes

• The core functionality resides in src/eagle_exporter/core.py.
• The CLI is in src/eagle_exporter/cli.py.
• The library uses click for the command line, pandas for data manipulation, and datasets for pushing to Hugging Face.
• Image processing is handled using Pillow (PIL).

Building and publishing

To build and publish the repo, run the following commands:

python -m pip install build twine
python -m build
twine check dist/*
twine upload dist/*