SDK-93: Use HIRUNDO_API_* env vars and add deprecation fallback for legacy names#224
Open
mishana wants to merge 7 commits into
Open
SDK-93: Use HIRUNDO_API_* env vars and add deprecation fallback for legacy names#224mishana wants to merge 7 commits into
HIRUNDO_API_* env vars and add deprecation fallback for legacy names#224mishana wants to merge 7 commits into
Conversation
HIRUNDO_API_* env vars and add deprecation fallback for legacy names
benglewis
reviewed
May 4, 2026
Co-authored-by: Ben Lewis <blewis@hirundo.io> Signed-off-by: Michael Leybovich <mishana4life@gmail.com>
Co-authored-by: Ben Lewis <blewis@hirundo.io> Signed-off-by: Michael Leybovich <mishana4life@gmail.com>
Co-authored-by: Ben Lewis <blewis@hirundo.io> Signed-off-by: Michael Leybovich <mishana4life@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Motivation
HIRUNDO_API_KEYandHIRUNDO_API_HOSTand provide a migration path from the legacyAPI_KEY/API_HOSTnames.Description
_get_env_with_deprecationinhirundo/_env.pyto preferHIRUNDO_API_*and fall back toAPI_*while emitting aDeprecationWarningwhen legacy names are used.API_HOST/API_KEYlookup andcheck_api_keymessage to reference the newHIRUNDO_API_*names.hirundo/cli.pyto writeHIRUNDO_API_KEYandHIRUNDO_API_HOSTviaupsert_envforset-api-key,change-remote, andsetupflows.README.md,docs/index.rst) and example notebooks to referenceHIRUNDO_API_KEYandHIRUNDO_API_HOSTinstead of the old names.Testing
Codex Task
Note
Medium Risk
Moderate risk because it changes how API credentials/host are sourced and written, which can break client configuration if users rely on the old variable names or
.envcontents. Backward compatibility is provided via fallback reads, but behavior now emitsDeprecationWarnings.Overview
Standardizes configuration on
HIRUNDO_API_KEY/HIRUNDO_API_HOSTacross the SDK.The env loader now prefers the new variable names and falls back to legacy
API_KEY/API_HOSTwhile emitting aDeprecationWarning, and the CLIsetup/set-api-key/change-remotecommands now write the new variable names into.env/~/.hirundo.conf. Docs and example notebooks are updated to reference the new names, and the missing-key error message now points toHIRUNDO_API_KEY.Reviewed by Cursor Bugbot for commit 4f1689a. Configure here.
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Standardize SDK credential sourcing by reading
HIRUNDO_API_HOST/HIRUNDO_API_KEY(with_get_env_with_deprecationfallback) and adjust thehirundo.cliflows to persist the new variables along with updated user messaging. Align documentation, notebooks, and CLI guidance to mention the new env vars and upgrade dependency pins inpyproject.tomlto remediate several CVEs.python-dotenv,requests,transformers,pytest,uv,authlib, andcryptographyto their patched versions to close the listed CVEs and keep the build/test toolchain secure.Modified files (1)
Latest Contributors(2)
Modified files (1)
Latest Contributors(2)
HIRUNDO_API_HOST/HIRUNDO_API_KEY, emitDeprecationWarnings when the legacy names are present, and ensure the CLIsetup,set-api-key, andchange-remoteflows plus docs/notebooks consistently write and mention the new values so users load the correct credentials.Modified files (7)
Latest Contributors(2)