Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting the intention of altsrc #825

Closed
coilysiren opened this issue Aug 2, 2019 · 3 comments
Closed

Documenting the intention of altsrc #825

coilysiren opened this issue Aug 2, 2019 · 3 comments
Labels
help wanted please help if you can! kind/documentation describes a documentation update

Comments

@coilysiren
Copy link
Member

Speaking as someone who is now partially responsible for helping with this project (along with everyone else) - it would be nice if there was a canonical document describing altsrc. Is it:

  • intended to be merged into the "main" package eventually?
  • do people think of it as a separate package, or an extension?
  • should every PR we create be updating both "main" and altsrc?
@coilysiren coilysiren added help wanted please help if you can! kind/documentation describes a documentation update labels Aug 2, 2019
@project0
Copy link

project0 commented Aug 6, 2019

Personally i would like to see altsrc as an "extension" (interface) which can be used by developers to add more config sources. I have a common use case to retrieve parameters first in AWS SSM and then continue with environment vars and flags.
For creating an own altsrc package (i guess you mean a split to a new repo?) wouldn't this mean some kind of API stability?

@coilysiren
Copy link
Member Author

Personally i would like to see altsrc as an "extension" (interface) which can be used by developers to add more config sources. I have a common use case to retrieve parameters first in AWS SSM and then continue with environment vars and flags.

I also understand it as an extensions interface, yeah. I think it we renamed the functionality to revolve around extensions, it would help with understanding and adoption.

For creating an own altsrc package (i guess you mean a split to a new repo?) wouldn't this mean some kind of API stability?

I'm not sure what this means 🙂

@coilysiren
Copy link
Member Author

I think I'm going to bucket this into #833

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted please help if you can! kind/documentation describes a documentation update
Projects
None yet
Development

No branches or pull requests

2 participants