usability tweaks (#17)

* add download badge to README

* read the docs badge

* CLI UX feedback when logging in, since it's not always obvious what it is doing.

* add the ability to hide builtin profiles for better UX

Author: carl-adams-planet

README.md

@@ -1,5 +1,7 @@
 # Planet Auth Utility Library
 [![Build Status](https://github.com/planetlabs/planet-auth-python/actions/workflows/test.yml/badge.svg)](https://github.com/planetlabs/planet-auth-python/actions/workflows/test.yml)
+[![PyPI Downloads](https://static.pepy.tech/badge/planet-auth)](https://pepy.tech/projects/planet-auth)
+[![Read The Docs](https://app.readthedocs.org/projects/planet-auth/badge/)](https://planet-auth.readthedocs.io/)
 
 The Planet Auth Library provides generic authentication utilities for clients
 and for services.  For clients, it provides means to obtain access tokens that

src/planet_auth_utils/commands/cli/main.py

@@ -206,6 +206,7 @@ def cmd_plauth_login(
         # auth_password_opt=auth_password,
     )
 
+    print(f"Logging in with authentication profile {override_auth_context.profile_name()}...")
     _ = override_auth_context.login(
         requested_scopes=scope,
         requested_audiences=audience,

src/planet_auth_utils/commands/cli/oauth_cmd.py

@@ -114,6 +114,7 @@ def cmd_oauth_login(
         login_extra["organization"] = organization
 
     current_auth_context = ctx.obj["AUTH"]
+    print(f"Logging in with authentication profile {current_auth_context.profile_name()}...")
     current_auth_context.login(
         requested_scopes=scope,
         requested_audiences=audience,

src/planet_auth_utils/commands/cli/profile_cmd.py

@@ -61,7 +61,18 @@ def _dialogue_choose_auth_client_type():
 
 
 def _dialogue_choose_auth_profile():
-    all_profile_names = Builtins.builtin_profile_names() + Profile.list_on_disk_profiles()
+    filtered_builtin_profile_names = []
+    for profile_name in Builtins.builtin_profile_names():
+        config_dict = Builtins.builtin_profile_auth_client_config_dict(profile_name)
+        # The idea of a "hidden" profile currently only applies to built-in profiles.
+        # This is largely so we can have partial SKEL profiles.
+        if not config_dict.get("_hidden", False):
+            filtered_builtin_profile_names.append(profile_name)
+
+    filtered_builtin_profile_names.sort()
+    sorted_on_disk_profile_names = Profile.list_on_disk_profiles().copy()
+    sorted_on_disk_profile_names.sort()
+    all_profile_names = filtered_builtin_profile_names + sorted_on_disk_profile_names
     choices = []
     for profile_name in all_profile_names:
         choices.append((profile_name, f"{profile_name}"))
@@ -129,21 +140,31 @@ def cmd_profile_list(long):
         display_object = OrderedDict()
         for profile_name in profile_names:
             config_dict = Builtins.builtin_profile_auth_client_config_dict(profile_name)
-            display_object[profile_name] = config_dict
+            # The idea of a "hidden" profile currently only applies to built-in profiles.
+            # This is largely so we can have partial SKEL profiles.
+            if not config_dict.get("_hidden", False):
+                display_object[profile_name] = config_dict
         print_obj(display_object)
 
         click.echo("\nLocally defined profiles:")
         print_obj(_load_all_on_disk_profiles())
 
     else:
         click.echo("Built-in profiles:")
-        profile_names = Builtins.builtin_profile_names().copy()
-        profile_names.sort()
-        print_obj(profile_names)
+        display_profile_names = []
+        for profile_name in Builtins.builtin_profile_names():
+            config_dict = Builtins.builtin_profile_auth_client_config_dict(profile_name)
+            # The idea of a "hidden" profile currently only applies to built-in profiles.
+            # This is largely so we can have partial SKEL profiles.
+            if not config_dict.get("_hidden", False):
+                display_profile_names.append(profile_name)
+        display_profile_names.sort()
+        print_obj(display_profile_names)
+
         click.echo("\nLocally defined profiles:")
-        profile_names = Profile.list_on_disk_profiles()
-        profile_names.sort()
-        print_obj(profile_names)
+        display_profile_names = Profile.list_on_disk_profiles()
+        display_profile_names.sort()
+        print_obj(display_profile_names)
 
 
 @cmd_profile.command("create")