winipedia-utils 0.4.20__tar.gz → 0.4.23__tar.gz

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.20
+Version: 0.4.23
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: cryptography
 Requires-Dist: defusedxml
+Requires-Dist: dotenv
 Requires-Dist: keyring
 Requires-Dist: pathspec
 Requires-Dist: polars

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.4.20"
+version = "0.4.23"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -31,6 +31,7 @@ keyring = "*"
 cryptography = "*"
 polars = "*"
 pygithub = "*"
+dotenv = "*"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "*"

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/winipedia_utils/git/gitignore/config.py

@@ -5,8 +5,8 @@ from typing import Any
 
 import requests
 
-from winipedia_utils.testing.config import ExperimentConfigFile, LocalSecretsConfigFile
-from winipedia_utils.text.config import ConfigFile
+from winipedia_utils.testing.config import ExperimentConfigFile
+from winipedia_utils.text.config import ConfigFile, DotEnvConfigFile
 
 
 class GitIgnoreConfigFile(ConfigFile):
@@ -54,9 +54,12 @@ class GitIgnoreConfigFile(ConfigFile):
             ".git/",
             "# for executing experimental code",
             ExperimentConfigFile.get_path().as_posix(),
-            "# for secrets used locally",
-            LocalSecretsConfigFile.get_path().as_posix(),
         ]
+
+        dotenv_path = DotEnvConfigFile.get_path().as_posix()
+        if dotenv_path not in needed:
+            needed.extend(["# for secrets used locally", dotenv_path])
+
         existing = cls.load()
         needed = [p for p in needed if p not in set(existing)]
         return existing + needed

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/winipedia_utils/testing/config.py

@@ -125,25 +125,3 @@ class ExperimentConfigFile(PythonConfigFile):
         """Get the config."""
         return '''"""This file is for experimentation and is ignored by git."""
 '''
-
-
-class LocalSecretsConfigFile(PythonConfigFile):
-    """Config file for secrets.py.
-
-    Config file for secrets. Is added to .gitignore automatically.
-    Should be in .gitignore.
-    """
-
-    @classmethod
-    def get_parent_path(cls) -> Path:
-        """Get the path to the config file."""
-        return Path()
-
-    @classmethod
-    def get_content_str(cls) -> str:
-        """Get the config."""
-        return '''"""This file is for secrets you might use and is ignored by git.
-
-Can be used by tests or other developing code.
-"""
-'''

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/winipedia_utils/testing/tests/base/utils/utils.py

@@ -18,17 +18,15 @@ from winipedia_utils.logging.logger import get_logger
 from winipedia_utils.modules.function import is_abstractmethod
 from winipedia_utils.modules.module import (
     get_objs_from_obj,
-    import_obj_from_importpath,
     make_obj_importpath,
-    to_module_name,
 )
 from winipedia_utils.testing.assertions import assert_with_msg
-from winipedia_utils.testing.config import LocalSecretsConfigFile
 from winipedia_utils.testing.convention import (
     get_obj_from_test_obj,
     make_test_obj_importpath_from_obj,
     make_untested_summary_error_msg,
 )
+from winipedia_utils.text.config import DotEnvConfigFile
 
 logger = get_logger(__name__)
 
@@ -92,17 +90,15 @@ def get_github_repo_token() -> str:
     if token:
         return token
 
-    local_secrets_module_path = to_module_name(LocalSecretsConfigFile.get_path())
-    local_secrets_module = import_obj_from_importpath(local_secrets_module_path)
-    token = getattr(local_secrets_module, "REPO_TOKEN", None)
-    if not isinstance(token, str):
-        msg = f"Expected REPO_TOKEN to be str, got {type(token)}"
-        raise TypeError(msg)
+    # try .env next
+    dotenv_path = DotEnvConfigFile.get_path()
+    if not dotenv_path.exists():
+        msg = f"Expected {dotenv_path} to exist"
+        raise ValueError(msg)
+    dotenv = DotEnvConfigFile.load()
+    token = dotenv.get("REPO_TOKEN")
     if token:
         return token
 
-    msg = (
-        f"No token named REPO_TOKEN found "
-        f"in github secrets or {LocalSecretsConfigFile.get_path()}"
-    )
+    msg = f"Expected REPO_TOKEN in {dotenv_path}"
     raise ValueError(msg)

{winipedia_utils-0.4.20 → winipedia_utils-0.4.23}/winipedia_utils/text/config.py

@@ -7,6 +7,7 @@ from typing import Any
 
 import tomlkit
 import yaml
+from dotenv import dotenv_values
 
 import winipedia_utils
 from winipedia_utils.iterating.iterate import nested_structure_is_subset
@@ -198,3 +199,45 @@ class TomlConfigFile(ConfigFile):
     def get_file_extension(cls) -> str:
         """Get the file extension of the config file."""
         return "toml"
+
+
+class DotEnvConfigFile(ConfigFile):
+    """config class for .env config files."""
+
+    @classmethod
+    def load(cls) -> dict[str, str | None]:
+        """Load the config file."""
+        return dotenv_values(cls.get_path())
+
+    @classmethod
+    def dump(cls, config: dict[str, Any] | list[Any]) -> None:
+        """Dump the config file."""
+        # is not supposed to be dumped to, so just raise error
+        if config:
+            msg = f"Cannot dump {config} to .env file."
+            raise ValueError(msg)
+
+    @classmethod
+    def get_file_extension(cls) -> str:
+        """Get the file extension of the config file."""
+        return "env"
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the filename of the config file."""
+        return ""  # so it builds the path .env and not env.env
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the path to the config file."""
+        return Path()
+
+    @classmethod
+    def get_configs(cls) -> dict[str, Any]:
+        """Get the config."""
+        return {}
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the config is correct."""
+        return super().is_correct() or cls.get_path().exists()