Skip to main content

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

Reason this release was yanked:

buggy

Project description

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.
  • 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-export path/to/my_eagle.library --to myuser/my_hf_dataset --hf-public

Or export to a local .parquet file:

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

Optionally include an s5cmd file to attach S3 URIs:

eagle-export 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.

  • --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.

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/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eagle_exporter-0.1.2.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eagle_exporter-0.1.2-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file eagle_exporter-0.1.2.tar.gz.

File metadata

  • Download URL: eagle_exporter-0.1.2.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.13

File hashes

Hashes for eagle_exporter-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5be0dfcc1e483e4b46fa40ae36eee8557e6bbaa698954a56d94ff6d56704a1f8
MD5 fc4a5681c134a2ef9b679e55e9e77d07
BLAKE2b-256 199a481d46aca4fcaf93126b3d9f58368554e9716aa322ea6f1b6c17379cb4e0

See more details on using hashes here.

File details

Details for the file eagle_exporter-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: eagle_exporter-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.13

File hashes

Hashes for eagle_exporter-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d4d507c18228cc3e2412860b488d5ea5f5a035cf417e074fef0583e483e3e19b
MD5 25c5b55ac51213323c2b17da5fbcbea8
BLAKE2b-256 93db027f2bf07646e037bc0ba4e603830ab655127397ea757ea1d4a0dfab7952

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page