Conversation
BREAKING CHANGE: CLI command renamed from 'javelin' to 'highflame'
- Rename javelin_cli/ directory to highflame_cli/
- Update pyproject.toml to reference highflame_cli module
- Update CLI entry point from javelin_cli.cli:main to highflame_cli.cli:main
- Update all internal imports to use highflame_cli namespace
- Change CLI command from 'javelin' to 'highflame'
- Update all user-facing messages to reference 'HighFlame' instead of 'Javelin'
Backward compatibility:
- Cache directory now uses ~/.highflame/ but maintains backward compatibility
with existing ~/.javelin/ directory (reads from old location if it exists)
- New authentications will write to ~/.highflame/cache.json
- Existing users with ~/.javelin/cache.json can continue using their cached credentials
Impact:
- Users must now run 'highflame' command instead of 'javelin'
- Auth command: 'highflame auth' instead of 'javelin auth'
- All other commands follow the same pattern: 'highflame <command>'
Add support for new HIGHFLAME_* environment variable names while maintaining
backward compatibility with existing JAVELIN_* variables.
Changes:
- Update all environment variable references to check HIGHFLAME_* first
- Fall back to JAVELIN_* if HIGHFLAME_* is not set
- Applies to: HIGHFLAME_API_KEY, HIGHFLAME_BASE_URL, HIGHFLAME_VIRTUALAPIKEY
Pattern:
os.getenv("HIGHFLAME_*") or os.getenv("JAVELIN_*")
Backward compatibility:
- Existing users with JAVELIN_* variables will continue to work
- New users can use HIGHFLAME_* variables
- If both are set, HIGHFLAME_* takes precedence
… to highflame Rename all example files, directories, and notebooks to use 'highflame' naming convention instead of 'javelin'.
…nd example file paths.
Summary of ChangesHello @darshana-v, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request executes a complete rebranding of the SDK and its associated CLI from 'Javelin' to 'HighFlame'. The changes are extensive, touching nearly every file to reflect the new naming convention. A key focus of this update is to provide robust backward compatibility, allowing existing configurations and environment variables to continue functioning alongside the new 'HighFlame' equivalents, thereby minimizing disruption during the transition. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
List of http headers to be changed: |
There was a problem hiding this comment.
Code Review
This pull request does a great job of renaming the javelin-sdk to highflame-sdk. The changes are extensive and cover file names, package configurations, and internal code. The introduction of backward compatibility for environment variables and configuration parameters is a thoughtful touch.
My review focuses on a few areas for improvement:
- Consistency in Examples: Many examples have been updated to read the new
HIGHFLAME_*environment variables but still use old variable names likejavelin_api_keyinternally. It would be more consistent to use the new names throughout the example code. - Configuration Parameters: The
JavelinConfigclass now supportshighflame_api_key, but many examples still use the deprecatedjavelin_api_keyparameter. Updating the examples to use the new parameter would improve clarity. - Code Duplication: There's a duplicated helper function in the CLI code that should be refactored.
- Documentation Links: A couple of links in the
README.mdstill point to oldjavelinresources.
Overall, this is a solid refactoring PR. The suggested changes are mostly for improving consistency and maintainability.
- Rename JavelinClient → Highflame - Rename JavelinConfig → Config - Rename JavelinRequestWrapper → RequestWrapper - Simplify Config to use api_key directly - Update base URL to https://api.highflame.app - Maintain dual header support (x-highflame-* and x-javelin-*) for backward compatibility
- Remove duplicate get_cache_file() from cli.py and import from commands.py to follow DRY principle - Rename JAVELIN_API_KEY to HIGHFLAME_API_KEY in adk_gemini_agent_highflame/agent.py - Rename javelin_api_key/javelin_base_url to highflame_* in openai_agents_highflame.py - Rename javelin_api_key to highflame_api_key in azure_function_call.py
No description provided.