lean-explore 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

lean_explore/cli/config_utils.py

@@ -6,7 +6,8 @@ This module provides functions to save and load user-specific settings,
 such as API keys for Lean Explore and OpenAI, from a configuration
 file stored in the user's home directory. It handles file creation,
 parsing, and sets secure permissions for files containing sensitive
-information.
+information. It also supports loading API keys from environment
+variables as a fallback if they are not found in the configuration file.
 """
 
 import logging
@@ -23,12 +24,14 @@ _APP_CONFIG_DIR_NAME: str = "leanexplore"
 _CONFIG_FILENAME: str = "config.toml"
 
 # Define keys for Lean Explore API section
-_LEAN_EXPLORE_API_SECTION_NAME: str = "lean_explore_api"  # Renamed for clarity
+_LEAN_EXPLORE_API_SECTION_NAME: str = "lean_explore_api"
 _LEAN_EXPLORE_API_KEY_NAME: str = "key"
+_LEAN_EXPLORE_API_KEY_ENV_VAR: str = "LEANEXPLORE_API_KEY"
 
 # Define keys for OpenAI API section
 _OPENAI_API_SECTION_NAME: str = "openai"
-_OPENAI_API_KEY_NAME: str = "api_key"  # Using a distinct key name for clarity
+_OPENAI_API_KEY_NAME: str = "api_key"
+_OPENAI_API_KEY_ENV_VAR: str = "OPENAI_API_KEY"
 
 
 def get_config_file_path() -> pathlib.Path:
@@ -83,7 +86,6 @@ def _load_config_data(config_file_path: pathlib.Path) -> Dict[str, Any]:
                 "Configuration file %s is corrupted. Treating as empty.",
                 config_file_path,
             )
-            # Potentially back up corrupted file before returning empty
         except Exception as e:
             logger.error(
                 "Error reading existing config file %s: %s",
@@ -91,7 +93,6 @@ def _load_config_data(config_file_path: pathlib.Path) -> Dict[str, Any]:
                 e,
                 exc_info=True,
             )
-            # Decide if to proceed with empty or raise further
     return config_data
 
 
@@ -162,9 +163,7 @@ def save_api_key(api_key: str) -> bool:
         if _save_config_data(config_file_path, config_data):
             logger.info("Lean Explore API key saved to %s", config_file_path)
             return True
-    except (
-        Exception
-    ) as e:  # Catch any exception from _ensure_config_dir_exists or broad issues
+    except Exception as e:
         logger.error(
             "General error during Lean Explore API key saving process: %s",
             e,
@@ -174,50 +173,86 @@ def save_api_key(api_key: str) -> bool:
 
 
 def load_api_key() -> Optional[str]:
-    """Loads the Lean Explore API key from the user's configuration file.
+    """Loads the Lean Explore API key.
+
+    It first checks the user's configuration file (typically
+    ~/.config/leanexplore/config.toml under the section
+    `lean_explore_api` with key `key`). If a valid, non-empty API key
+    is found there, it is returned.
+
+    If the API key is not found in the configuration file, is empty,
+    or is not a string, this function then checks the environment
+    variable `LEAN_EXPLORE_API_KEY`. If this environment variable is
+    set to a non-empty string, its value is returned.
+
+    If the API key is not found or is invalid in both locations,
+    None is returned.
 
     Returns:
         Optional[str]: The Lean Explore API key string if found and valid,
             otherwise None.
     """
     config_file_path = get_config_file_path()
-    if not config_file_path.exists() or not config_file_path.is_file():
-        logger.debug(
-            "Configuration file not found at %s for Lean Explore API key.",
-            config_file_path,
-        )
-        return None
 
-    try:
-        config_data = _load_config_data(config_file_path)
-        api_key = config_data.get(_LEAN_EXPLORE_API_SECTION_NAME, {}).get(
-            _LEAN_EXPLORE_API_KEY_NAME
-        )
-
-        if api_key and isinstance(api_key, str):
-            logger.debug(
-                "Lean Explore API key loaded successfully from %s", config_file_path
-            )
-            return api_key
-        elif api_key:  # Found but not a string
-            logger.warning(
-                "Lean Explore API key found in %s but is not a valid string.",
-                config_file_path,
+    # 1. Try loading from config file
+    if config_file_path.exists() and config_file_path.is_file():
+        try:
+            config_data = _load_config_data(config_file_path)
+            key_value = config_data.get(_LEAN_EXPLORE_API_SECTION_NAME, {}).get(
+                _LEAN_EXPLORE_API_KEY_NAME
             )
-        else:  # Not found under the expected keys
-            logger.debug(
-                "Lean Explore API key not found under section '%s', key '%s' in %s",
-                _LEAN_EXPLORE_API_SECTION_NAME,
-                _LEAN_EXPLORE_API_KEY_NAME,
+
+            if isinstance(key_value, str) and key_value:  # Non-empty string
+                logger.debug(
+                    "Lean Explore API key loaded from configuration file %s",
+                    config_file_path,
+                )
+                return key_value
+            elif key_value is not None:  # Present but not a valid non-empty string
+                logger.warning(
+                    "Lean Explore API key found in %s but is not a valid "
+                    "non-empty string. "
+                    "Will check environment variable %s.",
+                    config_file_path,
+                    _LEAN_EXPLORE_API_KEY_ENV_VAR,
+                )
+        except Exception as e:  # Catch unexpected errors during config processing
+            logger.error(
+                "Error processing configuration file %s for Lean Explore API key: %s. "
+                "Will check environment variable %s.",
                 config_file_path,
+                e,
+                _LEAN_EXPLORE_API_KEY_ENV_VAR,
+                exc_info=True,
             )
-    except Exception as e:  # Catch any other unexpected errors during loading
-        logger.error(
-            "Unexpected error loading Lean Explore API key from %s: %s",
+    else:
+        logger.debug(
+            "Configuration file %s not found. Will check environment "
+            "variable %s for Lean Explore API key.",
             config_file_path,
-            e,
-            exc_info=True,
+            _LEAN_EXPLORE_API_KEY_ENV_VAR,
         )
+
+    # 2. Try loading from environment variable
+    api_key_from_env = os.getenv(_LEAN_EXPLORE_API_KEY_ENV_VAR)
+
+    if isinstance(api_key_from_env, str) and api_key_from_env:  # Non-empty string
+        logger.debug(
+            "Lean Explore API key loaded from environment variable %s",
+            _LEAN_EXPLORE_API_KEY_ENV_VAR,
+        )
+        return api_key_from_env
+    elif api_key_from_env is not None:  # Env var exists but is empty string
+        logger.debug(
+            "Environment variable %s for Lean Explore API key is set but empty.",
+            _LEAN_EXPLORE_API_KEY_ENV_VAR,
+        )
+
+    logger.debug(
+        "Lean Explore API key not found in configuration file or "
+        "valid in environment variable %s.",
+        _LEAN_EXPLORE_API_KEY_ENV_VAR,
+    )
     return None
 
 
@@ -262,7 +297,7 @@ def delete_api_key() -> bool:
                 "Lean Explore API key not found in %s, no deletion performed.",
                 config_file_path,
             )
-            return True  # Key wasn't there, so considered successful
+            return True
 
     except Exception as e:
         logger.error(
@@ -316,46 +351,84 @@ def save_openai_api_key(api_key: str) -> bool:
 
 
 def load_openai_api_key() -> Optional[str]:
-    """Loads the OpenAI API key from the user's configuration file.
+    """Loads the OpenAI API key.
+
+    It first checks the user's configuration file (typically
+    ~/.config/leanexplore/config.toml under the section
+    `openai` with key `api_key`). If a valid, non-empty API key
+    is found there, it is returned.
+
+    If the API key is not found in the configuration file, is empty,
+    or is not a string, this function then checks the environment
+    variable `OPENAI_API_KEY`. If this environment variable is
+    set to a non-empty string, its value is returned.
+
+    If the API key is not found or is invalid in both locations,
+    None is returned.
 
     Returns:
         Optional[str]: The OpenAI API key string if found and valid, otherwise None.
     """
     config_file_path = get_config_file_path()
-    if not config_file_path.exists() or not config_file_path.is_file():
-        logger.debug(
-            "Configuration file not found at %s for OpenAI API key.", config_file_path
-        )
-        return None
 
-    try:
-        config_data = _load_config_data(config_file_path)
-        api_key = config_data.get(_OPENAI_API_SECTION_NAME, {}).get(
-            _OPENAI_API_KEY_NAME
-        )
-
-        if api_key and isinstance(api_key, str):
-            logger.debug("OpenAI API key loaded successfully from %s", config_file_path)
-            return api_key
-        elif api_key:  # Found but not a string
-            logger.warning(
-                "OpenAI API key found in %s but is not a valid string.",
-                config_file_path,
+    # 1. Try loading from config file
+    if config_file_path.exists() and config_file_path.is_file():
+        try:
+            config_data = _load_config_data(config_file_path)
+            key_value = config_data.get(_OPENAI_API_SECTION_NAME, {}).get(
+                _OPENAI_API_KEY_NAME
             )
-        else:  # Not found under the expected keys
-            logger.debug(
-                "OpenAI API key not found under section '%s', key '%s' in %s",
-                _OPENAI_API_SECTION_NAME,
-                _OPENAI_API_KEY_NAME,
+
+            if isinstance(key_value, str) and key_value:  # Non-empty string
+                logger.debug(
+                    "OpenAI API key loaded from configuration file %s",
+                    config_file_path,
+                )
+                return key_value
+            elif key_value is not None:  # Present but not a valid non-empty string
+                logger.warning(
+                    "OpenAI API key found in %s but is not a valid non-empty string. "
+                    "Will check environment variable %s.",
+                    config_file_path,
+                    _OPENAI_API_KEY_ENV_VAR,
+                )
+        except Exception as e:  # Catch unexpected errors during config processing
+            logger.error(
+                "Error processing configuration file %s for OpenAI API key: %s. "
+                "Will check environment variable %s.",
                 config_file_path,
+                e,
+                _OPENAI_API_KEY_ENV_VAR,
+                exc_info=True,
             )
-    except Exception as e:
-        logger.error(
-            "Unexpected error loading OpenAI API key from %s: %s",
+    else:
+        logger.debug(
+            "Configuration file %s not found. Will check environment "
+            "variable %s for OpenAI API key.",
             config_file_path,
-            e,
-            exc_info=True,
+            _OPENAI_API_KEY_ENV_VAR,
         )
+
+    # 2. Try loading from environment variable
+    api_key_from_env = os.getenv(_OPENAI_API_KEY_ENV_VAR)
+
+    if isinstance(api_key_from_env, str) and api_key_from_env:  # Non-empty string
+        logger.debug(
+            "OpenAI API key loaded from environment variable %s",
+            _OPENAI_API_KEY_ENV_VAR,
+        )
+        return api_key_from_env
+    elif api_key_from_env is not None:  # Env var exists but is empty string
+        logger.debug(
+            "Environment variable %s for OpenAI API key is set but empty.",
+            _OPENAI_API_KEY_ENV_VAR,
+        )
+
+    logger.debug(
+        "OpenAI API key not found in configuration file or valid in "
+        "environment variable %s.",
+        _OPENAI_API_KEY_ENV_VAR,
+    )
     return None
 
 
@@ -396,7 +469,7 @@ def delete_openai_api_key() -> bool:
                 "OpenAI API key not found in %s, no deletion performed.",
                 config_file_path,
             )
-            return True  # Key wasn't there, so considered successful
+            return True
 
     except Exception as e:
         logger.error(

{lean_explore-0.2.0.dist-info → lean_explore-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lean-explore
-Version: 0.2.0
+Version: 0.2.2
 Summary: A project to explore and rank Lean mathematical declarations.
 Author-email: Justin Asher <justinchadwickasher@gmail.com>
 License:                                  Apache License
@@ -213,15 +213,13 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Classifier: Topic :: Text Processing :: Indexing
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: sqlalchemy>=2.0

{lean_explore-0.2.0.dist-info → lean_explore-0.2.2.dist-info}/RECORD

@@ -4,7 +4,7 @@ lean_explore/api/__init__.py,sha256=LK4g9wj7jCilTUfQcdQAxDf3F2GjMwzQZJYgnQ8ciGo,
 lean_explore/api/client.py,sha256=AgZG7pUY53Tl1WOhJgUdT0yxa_O1sHsals0pnjRD-Pc,4839
 lean_explore/cli/__init__.py,sha256=LK4g9wj7jCilTUfQcdQAxDf3F2GjMwzQZJYgnQ8ciGo,38
 lean_explore/cli/agent.py,sha256=jf1ebnViAqtKcZAGArqBf9YKHPbsOTpffOXr0Cd2M3Q,29933
-lean_explore/cli/config_utils.py,sha256=_g2aVMM1MyTWJCOVQj_jndI6ZA_Ct09WvpLsP2FFlSM,13643
+lean_explore/cli/config_utils.py,sha256=RyIaDNP1UpUQZoy7HfaZ_JOXUgtzUP51Zrq_s6q7urY,16639
 lean_explore/cli/data_commands.py,sha256=mTBqFU7-fF4ZBGzCmNawZA_eHy0jyEMLlBEDEBXpxwY,21462
 lean_explore/cli/main.py,sha256=ZdbXy8x2VQ--JARqJMa9iFnrOhOCLcVgjpWhXkxj80o,24323
 lean_explore/local/__init__.py,sha256=LK4g9wj7jCilTUfQcdQAxDf3F2GjMwzQZJYgnQ8ciGo,38
@@ -18,9 +18,9 @@ lean_explore/shared/__init__.py,sha256=LK4g9wj7jCilTUfQcdQAxDf3F2GjMwzQZJYgnQ8ci
 lean_explore/shared/models/__init__.py,sha256=LK4g9wj7jCilTUfQcdQAxDf3F2GjMwzQZJYgnQ8ciGo,38
 lean_explore/shared/models/api.py,sha256=jejNDpgj-cu0KZTqkuOjM0useN4EvhvNB19lFFAOV94,4635
 lean_explore/shared/models/db.py,sha256=JYfIBnPrHZO2j7gHAVMlw9WSqVC2NinCG5KuBzdQWyk,16099
-lean_explore-0.2.0.dist-info/licenses/LICENSE,sha256=l4QLw1kIvEOjUktmmKm4dycK1E249Qs2s2AQTYbMXpY,11354
-lean_explore-0.2.0.dist-info/METADATA,sha256=5mCWCIY9zhB7Q2F1Y9mZ9efjKjVPYnQhx2OYP8Gb1sw,15611
-lean_explore-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lean_explore-0.2.0.dist-info/entry_points.txt,sha256=JXl2Mo3BRX4jAU-Nxg_CWJR790pB_oi5qnt3Pv5iZnk,58
-lean_explore-0.2.0.dist-info/top_level.txt,sha256=h51BKWrFvB7iym-IlaNAAHX5MZfA8Gmg-aDuXGo0fQ8,13
-lean_explore-0.2.0.dist-info/RECORD,,
+lean_explore-0.2.2.dist-info/licenses/LICENSE,sha256=l4QLw1kIvEOjUktmmKm4dycK1E249Qs2s2AQTYbMXpY,11354
+lean_explore-0.2.2.dist-info/METADATA,sha256=SlZZqUVDTwZmx_LftmAb3yobtTbZMvFfeTQYB1Hnuvs,15512
+lean_explore-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lean_explore-0.2.2.dist-info/entry_points.txt,sha256=JXl2Mo3BRX4jAU-Nxg_CWJR790pB_oi5qnt3Pv5iZnk,58
+lean_explore-0.2.2.dist-info/top_level.txt,sha256=h51BKWrFvB7iym-IlaNAAHX5MZfA8Gmg-aDuXGo0fQ8,13
+lean_explore-0.2.2.dist-info/RECORD,,