Repository navigation
Implement global shade module configuration #1
Description
Description:
The SDK should support module-level configuration (e.g. shade.api_key = "sk_live_...") so developers can configure it once at app startup without instantiating a client object on every call. This mirrors the ergonomics of the Stripe Python SDK. The global config must be thread-safe and readable by all resource classes.
Proposed Steps:
- Create
src/shade/config.pywith module-level variables:api_key,api_base,environment,timeout,max_retries. - Expose these on the top-level
shadenamespace via__init__.py. - Write a
get_config()helper that merges instance-level overrides with global defaults, used internally by all resource methods. - Guard against
Noneapi_key at request time and raiseAuthenticationError.
Acceptance Criteria:
-
shade.api_key = "sk_live_xxx"sets the global key accessible across all resource calls. -
shade.environment = "sandbox"switches the active environment. - Setting
shade.api_key = Noneand then calling any resource raisesAuthenticationErrorwith a clear message. - Global config does not bleed between threads when changed concurrently.
Activity
Whiznificent commentedon Jun 19, 2026
gm again maintainer please assign me this issue to work on
Elizabeth-dev270 commentedon Jun 20, 2026
I enjoy solving software problems and have experience in backend development, APIs, OOP, and scalable application design.
timiturn3r commentedon Jun 20, 2026
Hi! I came across this issue and would love to work on it. I have experience with similar tasks and I'm confident I can investigate, implement a clean solution, and thoroughly test it before submitting a PR. If the issue is still open, I would appreciate it if you could assign it to me. Thank you!
DioChuks commentedon Jul 21, 2026
Hello, i am senior SWE, the problem seems to be about global module configuration, ensuring a well rounded setup for the application startup, i would handle this well, thanks.
grantfox-oss commentedon Jul 24, 2026
🦊 GrantFox — @DioChuks has been assigned to this issue as part of the Official Campaign | FWC26 campaign!
Next steps:
Closes #1)Good luck! Track your progress on GrantFox.
grantfox-oss commentedon Jul 29, 2026
🎉 This issue has been marked as completed on GrantFox as part of the Official Campaign | FWC26 campaign!
@DioChuks's PR #53 was approved and merged by @codebestia.
🏆 @DioChuks: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (204 total points). Track your full progress on GrantFox.
👏 Great work, @DioChuks! Keep contributing to ShadeProtocol.