File tree Expand file tree Collapse file tree 3 files changed +11
-10
lines changed
planet_auth_config_injection
planet_auth_utils/commands/cli Expand file tree Collapse file tree 3 files changed +11
-10
lines changed Original file line number Diff line number Diff line change 2828
2929These concerns belong more to the final end-user application than to a
3030library that sits between the Planet Auth library and the end-user
31- application, that itself may be used by a variety of applications in
32- a variety of deployment environments
31+ application. Such libraries themselves may be used by a variety of
32+ applications in any number of deployment environments, making the
33+ decision of what configuration to inject a difficult one.
3334
3435Library writers may provide configuration injection to their developers,
3536but should be conscious of the fact that multiple libraries within an
Original file line number Diff line number Diff line change 1818
1919# Unlike other environment variables, AUTH_BUILTIN_PROVIDER is not name-spaced.
2020# It is intended for libraries and applications to inject configuration by
21- # being set within the program. It's not generally expected to be set by
22- # users.
21+ # being set within the program. It's not expected to be set by end-users.
2322AUTH_BUILTIN_PROVIDER = "PL_AUTH_BUILTIN_CONFIG_PROVIDER"
2423"""
2524Environment variable to specify a python module and class that implement the
@@ -47,11 +46,12 @@ class BuiltinConfigurationProviderInterface(ABC):
4746
4847 def namespace (self ) -> str :
4948 """
50- Application namespace. This will be used as a prefix in various contexts
51- so that multiple applications may use the Planet auth libraries in the same
52- environment without collisions. Presently, this includes being
53- used as a prefix for environment variables, and as a prefix for config
54- settings store to the user's `~/.planet.json` file.
49+ Application namespace. This will be used as a prefix in various
50+ contexts so that multiple applications may use the Planet auth
51+ libraries in the same environment without collisions. Presently,
52+ this namespace is used as a prefix for environment variables, and
53+ as a prefix for config settings store to the user's `~/.planet.json`
54+ file.
5555 """
5656 return ""
5757
Original file line number Diff line number Diff line change @@ -85,7 +85,7 @@ def cmd_plauth_embedded(ctx):
8585 The embedded command differs from the stand-alone command in that it
8686 expects the context to be instantiated and options to be handled by
8787 the parent command. The [planet_auth.Auth][] library context _must_
88- be set to the object field `AUTH` in the click context object.
88+ be saved to the object field `AUTH` in the click context object.
8989
9090 See [planet_auth_utils.PlanetAuthFactory.initialize_auth_client_context][]
9191 for user-friendly auth client context initialization.
You can’t perform that action at this time.
0 commit comments