RepoAuditor 0.4.1__tar.gz → 0.4.3__tar.gz

{repoauditor-0.4.1 → repoauditor-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.4.1
+Version: 0.4.3
 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.4.1 → repoauditor-0.4.3}/docs/DEVELOPMENT.md

@@ -146,7 +146,7 @@ We use [MkDocs](https://www.mkdocs.org/) to generate the documentation website.
 To generate the docs, please run
 
 ```sh
-uv run mkdocs --serve
+uv run mkdocs serve
 ```
 
 and go to the specified URL.

{repoauditor-0.4.1 → repoauditor-0.4.3}/docs/index.md

@@ -4,6 +4,10 @@
 
 It helps maintain high-quality and consistent open-source repositories even if you are new to maintaining open-source software.
 
+## Compatibility
+
+We only support Python 3.10 and above. Please make sure you have a suitable python version.
+
 ## Contents
 
 - [Installation](#installation)
@@ -16,10 +20,13 @@ It helps maintain high-quality and consistent open-source repositories even if y
 ## Installation
 
 We recommend using [uv](https://docs.astral.sh/uv/#uv) since it can install `RepoAuditor` as a tool via `uvx` into a sandbox environment for quick use.
-This lets you directly run `RepoAuditor`.
 
+This lets you directly run `RepoAuditor` without the need to clone the repository or install the package.
+
+<!-- termynal -->
 ```sh
-uvx RepoAuditor
+> uvx RepoAuditor --version
+RepoAuditor v0.4.2
 ```
 
 Alternatively, you can install `RepoAuditor` via `uv` or `pip`.

{repoauditor-0.4.1 → repoauditor-0.4.3}/mkdocs.yml

@@ -15,6 +15,8 @@ theme:
     primary: teal
     accent: lime
 
+plugins:
+  - termynal
 
 # Extensions to render emojis
 markdown_extensions:

{repoauditor-0.4.1 → repoauditor-0.4.3}/pyproject.toml

@@ -57,6 +57,7 @@ dev = [
     "ruff>=0.11.8",
     "syrupy>=4.9.1",
     "mkdocs-material>=9.6.16",
+    "termynal>=0.13.1",
 ]
 
 [tool.hatch.version]

{repoauditor-0.4.1 → repoauditor-0.4.3}/src/RepoAuditor/Plugins/CommunityStandards/Impl/ExistsRequirementImpl.py

@@ -30,6 +30,7 @@ class ExistsRequirementImpl(Requirement):
         resolution: str,
         rationale: str,
         *,
+        enabled_by_default: bool = True,
         dynamic_arg_name: str = "unrequired",
         requires_explicit_include: bool = False,
     ) -> None:
@@ -41,7 +42,8 @@ class ExistsRequirementImpl(Requirement):
             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.
+            enabled_by_default (bool): Flag which indicates if the required file should be present in the repository by default. Defaults to True.
+            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 check if file is not present.
             requires_explicit_include (bool, optional): Flag checking if this requirement needs to be explicitly included in the invocation. Defaults to False.
 
         """
@@ -56,8 +58,8 @@ class ExistsRequirementImpl(Requirement):
 
         self.dynamic_arg_name = dynamic_arg_name
         self.filename = filename
-
         self.possible_locations = possible_locations
+        self.enabled_by_default = enabled_by_default
 
     # ----------------------------------------------------------------------
     @override
@@ -68,7 +70,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Disable requirement that the file {self.filename} exists.",
+                    help=f"{'Disable' if self.enabled_by_default else 'Enable'} requirement that the file {self.filename} exists.{' Needs to be explicitly included.' if self.requires_explicit_include else ''}",
                 ),
             ),
         }
@@ -80,8 +82,14 @@ class ExistsRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        # Check if dynamic argument is `not unrequired`.
-        if not requirement_args.get(self.dynamic_arg_name, False):
+        # Flag to check if required file exists
+        check_exists: bool = self.enabled_by_default
+
+        # Check if the dynamic argument is provided, which toggles the check flag
+        if requirement_args.get(self.dynamic_arg_name, False):
+            check_exists = not check_exists
+
+        if check_exists:
             for location in self.possible_locations:
                 # Get full file path in temporary repo directory and check if it exists
                 # This checks both upper case and lower case variants
@@ -107,5 +115,5 @@ class ExistsRequirementImpl(Requirement):
                 provide_rationale=True,
             )
 
-        # Requirement flag not set so DoesNotApply
+        # Requirement not enabled, so DoesNotApply
         return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)

{repoauditor-0.4.1 → repoauditor-0.4.3}/src/RepoAuditor/Plugins/ScientificSoftware/Requirements/Citation.py

@@ -37,7 +37,7 @@ class Citation(ExistsRequirementImpl):
                 "citations.bib",
                 "citation.md",
                 "citations.md",
-                # R packages are located in the `inst` directory
+                # Citations for R packages are located in the `inst` directory
                 "inst/CITATION",
             ],
             resolution=textwrap.dedent(
@@ -59,5 +59,4 @@ class Citation(ExistsRequirementImpl):
                 https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
                 """
             ),
-            dynamic_arg_name="unrequired",
         )

{repoauditor-0.4.1 → repoauditor-0.4.3}/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.4.1"
+__version__ = "0.4.3"

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/EntryPoint_UnitTest.py

@@ -8,13 +8,12 @@
 
 import pytest
 import typer
-
 from dbrownell_Common.TestHelpers.StreamTestHelpers import InitializeStreamCapabilities
 from dbrownell_Common.TyperEx import TypeDefinitionItem  # type: ignore [import-untyped]
 from typer.testing import CliRunner
 
 from RepoAuditor import __version__
-from RepoAuditor.EntryPoint import app, TypeInfoToString
+from RepoAuditor.EntryPoint import TypeInfoToString, app
 
 from .Plugins.utilities import GetGithubUrl
 

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/ExecuteModules_UnitTest.py

@@ -9,23 +9,20 @@
 import sys
 import textwrap
 import time
-
 from typing import cast
 
 import pytest
-
-from dbrownell_Common.Types import override
 from dbrownell_Common.TestHelpers.StreamTestHelpers import (
     GenerateDoneManagerAndContent,
     InitializeStreamCapabilities,
 )
+from dbrownell_Common.Types import override
 
 from RepoAuditor.Display import *
 from RepoAuditor.ExecuteModules import *
 from RepoAuditor.Module import *
 from RepoAuditor.Requirement import *
 
-
 # ----------------------------------------------------------------------
 pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/Plugins/ScientificSoftware_EndToEndTest.py

@@ -24,11 +24,11 @@ class TestScientificSoftware:
     """End-to-end tests for files in a GitHub repository which implements scientific software."""
 
     # ----------------------------------------------------------------------
-    def test_NoCitation(self, pat_args, snapshot):
+    def test_NoCitation(self, args, snapshot):
         """Test if no CITATION file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args,
+            args,
         )
 
         assert result.exit_code == -1, result.output

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/Plugins/__snapshots__/GitHubEnterprise_EndToEndTest.ambr

@@ -23,7 +23,7 @@
   │                                                                                                                      │
   │ ╭─ [Error] AllowDeletions ─────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Allow deletions' is set to False.                                                                │ │
+  │ │ Validates that 'Allow deletions' is set to True.                                                                 │ │
   │ │                                                                                                                  │ │
   │ │ ERROR: 'Allow deletions' must be set to 'True' (it is currently set to 'False').                                 │ │
   │ │                                                                                                                  │ │

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/Plugins/conftest.py

@@ -6,13 +6,13 @@
 # -------------------------------------------------------------------------------
 """Common test fixtures for Plugins."""
 
-from typing import Any
 from pathlib import Path
+from typing import Any
 
 import pytest
 
 # Fixtures included here so it is available for all tests
-from GitHubModule.fixtures import session_fixture, query_data_fixture  # noqa: F401
+from GitHubModule.fixtures import query_data_fixture, session_fixture  # noqa: F401
 from utilities import CheckPATFileExists, GetGithubUrl
 
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/Query_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Query import *

{repoauditor-0.4.1 → repoauditor-0.4.3}/tests/Requirement_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Requirement import *

{repoauditor-0.4.1 → repoauditor-0.4.3}/uv.lock

@@ -781,6 +781,7 @@ dev = [
     { name = "pytest-cov" },
     { name = "ruff" },
     { name = "syrupy" },
+    { name = "termynal" },
 ]
 
 [package.metadata]
@@ -803,6 +804,7 @@ dev = [
     { name = "pytest-cov", specifier = ">=6.1.1" },
     { name = "ruff", specifier = ">=0.11.8" },
     { name = "syrupy", specifier = ">=4.9.1" },
+    { name = "termynal", specifier = ">=0.13.1" },
 ]
 
 [[package]]
@@ -1015,6 +1017,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/ec/9d/aef9ec5fd5a4ee2f6a96032c4eda5888c5c7cec65cef6b28c4fc37671d88/syrupy-4.9.1-py3-none-any.whl", hash = "sha256:b94cc12ed0e5e75b448255430af642516842a2374a46936dd2650cfb6dd20eda", size = 52214, upload-time = "2025-03-24T01:36:35.278Z" },
 ]
 
+[[package]]
+name = "termynal"
+version = "0.13.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "markdown" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/6c/a6/099ed030e3e534ec91aec84dfe2cb11cea6ec8dcbec454fe569cdbbb4888/termynal-0.13.1.tar.gz", hash = "sha256:c7abecfdbda3ccdeee2723049a70f0e2e7f63e1973bb9b8f0b3fe6c1bfb391cd", size = 174253, upload-time = "2025-09-01T13:03:35.02Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/80/72/6949a512f16653cecebb737b8512ee76ca078d8e0e4e948d7322b528fb4d/termynal-0.13.1-py3-none-any.whl", hash = "sha256:7a1605a4d4ed38bf851bf25f842aafa52ef29786d52762aecee59622ed030592", size = 10628, upload-time = "2025-09-01T13:03:34.236Z" },
+]
+
 [[package]]
 name = "tomli"
 version = "2.2.1"