RepoAuditor 0.2.56__tar.gz → 0.2.58__tar.gz

{repoauditor-0.2.56 → repoauditor-0.2.58}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.56
+Version: 0.2.58
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor

{repoauditor-0.2.56 → repoauditor-0.2.58}/pyproject.toml

@@ -40,7 +40,7 @@ repo_auditor = "RepoAuditor:EntryPoint.app"
 
 [project.entry-points.RepoAuditor]
 GitHubPlugin = "RepoAuditor.Plugins.GitHubPlugin"
-GitHubCommunityStandardsPlugin = "RepoAuditor.Plugins.GitHubCommunityStandardsPlugin"
+CommunityStandardsPlugin = "RepoAuditor.Plugins.CommunityStandardsPlugin"
 
 [build-system]
 requires = ["hatchling"]

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/CommunityStandardsQuery.py

@@ -12,19 +12,19 @@ from urllib.parse import urlparse
 
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.CodeOfConduct import CodeOfConduct
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.CodeOwners import CodeOwners
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.Contributing import Contributing
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.IssueTemplates import IssueTemplates
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.LicenseFile import LicenseFile
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.PullRequestTemplates import PullRequestTemplate
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.ReadMe import ReadMe
-from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.SecurityPolicy import SecurityPolicy
+from RepoAuditor.Plugins.CommunityStandards.Requirements.CodeOfConduct import CodeOfConduct
+from RepoAuditor.Plugins.CommunityStandards.Requirements.CodeOwners import CodeOwners
+from RepoAuditor.Plugins.CommunityStandards.Requirements.Contributing import Contributing
+from RepoAuditor.Plugins.CommunityStandards.Requirements.IssueTemplates import IssueTemplates
+from RepoAuditor.Plugins.CommunityStandards.Requirements.LicenseFile import LicenseFile
+from RepoAuditor.Plugins.CommunityStandards.Requirements.PullRequestTemplates import PullRequestTemplate
+from RepoAuditor.Plugins.CommunityStandards.Requirements.ReadMe import ReadMe
+from RepoAuditor.Plugins.CommunityStandards.Requirements.SecurityPolicy import SecurityPolicy
 from RepoAuditor.Query import ExecutionStyle, Query
 
 
 class CommunityStandardsQuery(Query):
-    """Query with requirements that check for GitHub CommunityStandards files."""
+    """Query with requirements that check for repository Community Standards files."""
 
     def __init__(self) -> None:
         super().__init__(
@@ -50,29 +50,29 @@ class CommunityStandardsQuery(Query):
     ) -> Optional[dict[str, Any]]:
         """Get the repo data."""
 
-        # Clone the GitHub repository to a temp directory
+        # Clone the git repository to a temp directory
         branch = module_data.get("branch", "main")
         temp_repo_dir = TemporaryDirectory()
-        github_url = module_data["url"]
+        url = module_data["url"]
 
-        # Add PAT to GitHub URL, if present
-        github_pat = module_data.get("pat")
-        if github_pat:
-            url = urlparse(github_url)
-            github_url = f"https://{github_pat}@{url.netloc}{url.path}"
+        # Add PAT to git URL, if present
+        pat = module_data.get("pat")
+        if pat:
+            parsed_url = urlparse(url)
+            url = f"https://{pat}@{parsed_url.netloc}{parsed_url.path}"
 
         # Import git.Repo here so that it is only imported
-        # if the GitHubCommunityStandards plugin is requested.
+        # if the CommunityStandards plugin is requested.
         from git import Repo
 
         try:
-            Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
+            Repo.clone_from(url, temp_repo_dir.name, branch=branch)
         except Exception as e:
             error_msg = f"""
             An error occurred while attempting to clone the target repository.
             If you are auditing a private repository, {
                 "please ensure your PAT has access to the repository."
-                if github_pat
+                if pat
                 else "please provide a PAT with access to the repository."
             }
             Error: {e}

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Impl/ExistsRequirementImpl.py

@@ -25,7 +25,7 @@ class ExistsRequirementImpl(Requirement):
     def __init__(
         self,
         name: str,
-        github_file: str,
+        filename: str,
         possible_locations: Sequence[str],
         resolution: str,
         rationale: str,
@@ -37,8 +37,8 @@ class ExistsRequirementImpl(Requirement):
 
         Args:
             name (str): The name of the requirement. Used for unique identification.
-            github_file (str): The name of the file in the GitHub repository being checked for.
-            possible_locations (Sequence[str]): List of potential paths in the repo to check if `github_file` exists.
+            filename (str): The name of the file in the git repository being checked for.
+            possible_locations (Sequence[str]): List of potential paths in the repo to check if `filename` exists.
             resolution (str): Message on how to resolve the requirement in case of an error.
             rationale (str): Rationale message on why this requirement is needed.
             dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement.Defaults to "unrequired", which if enabled causes the requirement to be skipped.
@@ -47,7 +47,7 @@ class ExistsRequirementImpl(Requirement):
         """
         super().__init__(
             name,
-            f"Validates that {github_file} file exists.",
+            f"Validates that {filename} file exists.",
             ExecutionStyle.Parallel,
             resolution,
             rationale,
@@ -55,7 +55,7 @@ class ExistsRequirementImpl(Requirement):
         )
 
         self.dynamic_arg_name = dynamic_arg_name
-        self.github_file = github_file
+        self.filename = filename
 
         self.possible_locations = possible_locations
 
@@ -68,7 +68,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Disable requirement that the file {self.github_file} exists.",
+                    help=f"Disable requirement that the file {self.filename} exists.",
                 ),
             ),
         }
@@ -97,12 +97,12 @@ class ExistsRequirementImpl(Requirement):
 
                     return Requirement.EvaluateImplResult(
                         EvaluateResult.Success,
-                        f"{self.github_file} found in repository",
+                        f"{self.filename} found in repository",
                     )
 
             return Requirement.EvaluateImplResult(
                 EvaluateResult.Error,
-                f"No {self.github_file} file found.",
+                f"No {self.filename} file found.",
                 provide_resolution=True,
                 provide_rationale=True,
             )

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Module.py

@@ -4,20 +4,20 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the GitHubCommunityStandardsModule object."""
+"""Contains the CommunityStandardsModule object."""
 
 from RepoAuditor.Module import ExecutionStyle
+from RepoAuditor.Plugins.CommunityStandards.CommunityStandardsQuery import CommunityStandardsQuery
 from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
-from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import CommunityStandardsQuery
 
 
-class GitHubCommunityStandardsModule(GitHubBaseModule):
-    """Module that validates GitHub repository files for Community Standards."""
+class CommunityStandardsModule(GitHubBaseModule):
+    """Module that validates existence of repository files for Community Standards."""
 
     def __init__(self) -> None:
         super().__init__(
-            "GitHubCommunityStandards",
-            "Validates GitHub repository files for Community Standards.",
+            "CommunityStandards",
+            "Validates existence of repository files for Community Standards.",
             ExecutionStyle.Parallel,
             [
                 CommunityStandardsQuery(),

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/CodeOfConduct.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class CodeOfConduct(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/CodeOwners.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class CodeOwners(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/Contributing.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class Contributing(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/IssueTemplates.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the IssueTemplates requirement."""
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class IssueTemplates(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/LicenseFile.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import (
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import (
     ExistsRequirementImpl,
 )
 

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/PullRequestTemplates.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the PullRequestTemplate requirement."""
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class PullRequestTemplate(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/ReadMe.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class ReadMe(ExistsRequirementImpl):

{repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandards}/Requirements/SecurityPolicy.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class SecurityPolicy(ExistsRequirementImpl):

repoauditor-0.2.56/src/RepoAuditor/Plugins/GitHubCommunityStandardsPlugin.py → repoauditor-0.2.58/src/RepoAuditor/Plugins/CommunityStandardsPlugin.py

@@ -10,11 +10,11 @@ import pluggy
 
 from RepoAuditor import APP_NAME
 from RepoAuditor.Module import Module
-from RepoAuditor.Plugins.GitHubCommunityStandards.Module import GitHubCommunityStandardsModule
+from RepoAuditor.Plugins.CommunityStandards.Module import CommunityStandardsModule
 
 
 # ----------------------------------------------------------------------
 @pluggy.HookimplMarker(APP_NAME)
 def GetModule() -> Module:
-    """Return GitHub Customization Module."""
-    return GitHubCommunityStandardsModule()
+    """Return Community Standards Module."""
+    return CommunityStandardsModule()

{repoauditor-0.2.56 → repoauditor-0.2.58}/src/RepoAuditor/__init__.py

@@ -2,4 +2,4 @@ APP_NAME = "RepoAuditor"
 
 # Note that the default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.56"
+__version__ = "0.2.58"

{repoauditor-0.2.56/tests/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/tests/Plugins/CommunityStandards}/CommunityStandardsQuery_UnitTest.py

@@ -9,7 +9,7 @@
 import pytest
 from git import Repo
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import (
+from RepoAuditor.Plugins.CommunityStandards.CommunityStandardsQuery import (
     CommunityStandardsQuery,
     TemporaryDirectory,
 )

{repoauditor-0.2.56/tests/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/tests/Plugins/CommunityStandards}/ExistsRequirementImpl_UnitTest.py

@@ -9,7 +9,7 @@
 from pathlib import Path
 from tempfile import TemporaryDirectory
 
-from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 from RepoAuditor.Requirement import EvaluateResult
 
 
@@ -23,20 +23,20 @@ class TestExistsRequirementImpl:
         """Test the requirement implementation constructor."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            github_file="README.md",
+            filename="README.md",
             possible_locations=[
                 "README.md",
             ],
             resolution="Get test to pass",
             rationale="For testing",
         )
-        assert requirement.github_file == "README.md"
+        assert requirement.filename == "README.md"
 
     def test_Disabled(self):
         """Test disabled requirement."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            github_file="README.md",
+            filename="README.md",
             possible_locations=[
                 "README.md",
             ],
@@ -53,7 +53,7 @@ class TestExistsRequirementImpl:
         """Test for when file is not found."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            github_file="README.md",
+            filename="README.md",
             possible_locations=[
                 "MEREAD.md",
             ],
@@ -71,7 +71,7 @@ class TestExistsRequirementImpl:
         """Test for when file is found as is."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            github_file="README.md",
+            filename="README.md",
             possible_locations=[
                 "README.md",
             ],
@@ -93,7 +93,7 @@ class TestExistsRequirementImpl:
         """Test if provided path is directory."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            github_file="README.md",
+            filename="README.md",
             possible_locations=[
                 "docs",
             ],

{repoauditor-0.2.56/tests/Plugins/GitHubCommunityStandards → repoauditor-0.2.58/tests/Plugins/CommunityStandards}/GitHubCommunityStandards_UnitTest.py

@@ -12,7 +12,7 @@ from pathlib import Path
 import pluggy
 
 from RepoAuditor import APP_NAME
-from RepoAuditor.Plugins.GitHubCommunityStandardsPlugin import GetModule
+from RepoAuditor.Plugins.CommunityStandardsPlugin import GetModule
 
 
 # ----------------------------------------------------------------------
@@ -28,7 +28,7 @@ def test_get_module_returns_object():
     module = GetModule()
     assert module is not None
     assert hasattr(module, "name")
-    assert module.name == "GitHubCommunityStandards"
+    assert module.name == "CommunityStandards"
 
 
 # ----------------------------------------------------------------------
@@ -55,7 +55,7 @@ def test_plugin_registration():
 
 
 # ----------------------------------------------------------------------
-class TestGitHubCommunityStandardsModule:
+class TestCommunityStandardsModule:
     """Unit tests for the GitHubCustomizaton module."""
 
     def test_Construct(self):
@@ -63,7 +63,7 @@ class TestGitHubCommunityStandardsModule:
         module = GetModule()
 
         assert module is not None
-        assert module.name == "GitHubCommunityStandards"
+        assert module.name == "CommunityStandards"
         # Comment out checks that would fail with minimal implementation
         # assert module.execution_style.name == "Parallel"
         # assert len(module.queries) == 1