Walkabout Scorecard Parser

This command-line application parses multiple Walkabout mini golf scorecard images using Anthropic's Claude API and outputs the data in a specified JSON format.

Demo

Screen.Recording.2024-08-03.at.2.27.13.PM.mov

Prerequisites

• Node.js (v14.8.0 or later, as ES modules support is required)
• npm (Node Package Manager)
• An Anthropic API key

Installation

1. Clone this repository or download the source code.
2. Navigate to the project directory in your terminal.
3. Run npm install to install the required dependencies.

Configuration

1. Create a .env file in the project root directory.
2. Add your Anthropic API key to the .env file:

   ANTHROPIC_API_KEY=your_api_key_here
   

Usage

Run the script with the following command:

node parse.js <path_to_scorecard1.png> [path_to_scorecard2.png ...] [options]

Replace <path_to_scorecard1.png> with the actual paths to your scorecard image files. You can provide up to 5 image files.

Options

• -f, --format: Format the output JSON (default: false)
• -n, --no-animation: Disable the loading animation (default: false)
• -h, --help: Show help

Examples:

node parse.js scorecard1.png
node parse.js scorecard1.png scorecard2.png scorecard3.png --format
node parse.js scorecard1.png scorecard2.png --no-animation
node parse.js scorecard1.png scorecard2.png scorecard3.png -f -n

The script will output the parsed data in JSON format to the console.

Output Format

The script will generate JSON output in the following format:

{
  "filename1": {
    "course": {
      "name": "Course Name",
      "holes": [par1, par2, ..., par18]
    },
    "players": {
      "player1": [score1, score2, ..., score18],
      "player2": [score1, score2, ..., score18],
      ...
    }
  },
  "filename2": {
    ...
  },
  ...
}

Each key in the top-level object corresponds to the filename (without extension) of the input image.

Troubleshooting

• Ensure your Anthropic API key is correctly set in the .env file.
• Make sure the image file paths are correct and the files exist.
• If you encounter any errors, check the console output for error messages.
• Ensure you're using a Node.js version that supports ES modules (v14.8.0 or later).
• The script is limited to processing a maximum of 5 files at once. If you need to process more, you'll need to run the script multiple times.

License

This project is open-source and available under the MIT License.