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.1.tar.gz (4.8 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.1-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eagle_exporter-0.1.1.tar.gz
  • Upload date:
  • Size: 4.8 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.1.tar.gz
Algorithm Hash digest
SHA256 331db52fd97603cd568f695605cacee860dcb39d02a4f5c2caaf928a3525501e
MD5 d8240ae54de68ae85964fa1755d793b2
BLAKE2b-256 777f02c55485b347b625c1ffda03975d8b9cf8ff8d9fa8df111511aee0a9d318

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eagle_exporter-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80ccc299ac28e0cab8a22ff3320697cce5864353b7522474e60af16443b1afaf
MD5 df1e2c0a53d0d629c82a715111121ac4
BLAKE2b-256 ac5d8a228da0a9d2ff19145156a89525382578af9200e3bf5537d75974194323

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