Short Description

Refactor Python service entry point to use named arguments instead of positional arguments, making it easier to use, more maintainable, and less error-prone.

Fixes #132

Implementation Details

The Python service entry point (entry.py) is a critical part of our system, used both at runtime by the API and during local development. Previously, it relied on positional arguments for service configuration, which caused confusion and made the script harder to maintain.

Key Changes

1. Switch to Named Arguments
   The script now uses named arguments via argparse, making it more explicit and self-explanatory:

   python services/entry.py <service> --input input.json --output output.json --port 5000

   • <service>: Required; specifies the service to run.
   • --input (-i): Optional; path to the input JSON file.
   • --output (-o): Optional; path to the output JSON file (auto-generated if not provided).
   • --port (-p): Optional; sets the Apollo server port.

2. Improved Error Handling

   • Clear error messages are provided for common issues like invalid JSON input or missing files.
   • Type hints have been added for better clarity and maintainability.

3. Integration

   • bridge.ts has been updated to use the new named argument format when spawning Python processes.

These changes enhance the usability and maintainability of the entry point while maintaining backward compatibility for existing API.

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our Responsible AI Policy