RepoAuditor 0.2.79__tar.gz → 0.2.81__tar.gz

{repoauditor-0.2.79 → repoauditor-0.2.81}/.gitignore

@@ -22,3 +22,9 @@ tests/Plugins/github_pat.txt
 tests/Plugins/github_gatech_pat.txt
 .DS_Store
 post_generation_instructions.html
+
+# Ignore Personal Access Token (PAT) files
+**/*PAT.txt
+
+# Test coverage report
+**/coverage.xml

{repoauditor-0.2.79 → repoauditor-0.2.81}/DEVELOPMENT.md

@@ -77,9 +77,13 @@ Please follow the steps below to complete the configuration.
   - Click `Add classic branch protection rule`.
   - Under `Branch name pattern`, type in `main`.
   - Check `Require a pull request before merging`.
+  - Check `Require a pull request before merging -> Require approvals`.
   - Check `Require a pull request before merging -> Dismiss stale pull request approvals when new commits are pushed`.
   - Check `Require a pull request before merging -> Require approval of the most recent reviewable push`.
-  - Check `Require status checks to pass before merging`, and add the `CI+CD Workflow / Validate (ubuntu-latest, 3.13)` or equivalent status check.
+  - Under `Protect matching branches`
+    - Check `Require status checks to pass before merging`.
+    - Check `Require status checks to pass before merging -> Require branches to be up to date before merging`.
+    - Add the `CI+CD Workflow / Validate (ubuntu-latest, 3.13)` or an equivalent status check.
   - Check `Require conversation resolution before merging`.
   - Check `Require signed commits`.
   - Check `Do not allow bypassing the above settings`.
@@ -97,8 +101,8 @@ Please follow the steps below to complete the configuration.
   - Enable `Restrict deletions`
   - Enable `Require signed commits`
   - Enable `Require a pull request before merging` with 1 required approval.
-  - Enable `Require status checks to pass` with the `CI+CD Workflow / Validate (ubuntu-latest, 3.12)` check.
-  - Enable `Block force pushes`.
+  - Enable `Require status checks to pass` with the `CI+CD Workflow / Validate (ubuntu-latest, 3.12)` or an equivalent check.
+  - Disable `Block force pushes`.
   - Be sure to hit `Save changes` at the end.
 
 ### Development Activities
@@ -129,4 +133,4 @@ To verify that an artifact is valid, visit [the latest release](https://github.c
 
 ```shell
 uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"
-```
+```

{repoauditor-0.2.79 → repoauditor-0.2.81}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.79
+Version: 0.2.81
 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
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
-Requires-Dist: dbrownell-common>=0.14.10
+Requires-Dist: dbrownell-common>=0.16.0
 Requires-Dist: gitpython>=3.1.44
 Requires-Dist: pluggy>=1.5.0
 Requires-Dist: requests>=2.32.3
@@ -142,12 +142,48 @@ uvx RepoAuditor --include GitHub \
 
 `RepoAuditor` will generate a series of messages describing all the issues in the repository, along with the rationale behind them and the steps for resolution.
 
+### Custom Settings
+
+`RepoAuditor` tries to provide default settings and checks which are considered best practices. However, your team or organization may have different ways of doing things.
+You can override the default settings by specifying the appropriate flag.
+
+We have 3 types of flags:
+
+1. Boolean flags for those settings which are checked to be on by default and you wish to check are off, with the form `Module-no-Requirement` (e.g. `--GitHub-no-MergeCommit`).
+2. Conversely, boolean flags for those settings which are checked to be off by default, and you wish to check are on, denoted by the form `Module-Requirement` (e.g. `--GitHub-AllowDeletions`).
+3. Values flags take a string value to determine what value to enforce, and have the form `Module-Requirement-value` (e.g. `--GitHub-License-value "MIT License"`).
+
+Please run `uvx repoauditor --help` to get the list of all flags available.
+
+#### Examples
+
+For example, `RepoAuditor` by default checks that the setting `Allow rebase merging` is off. If you wish to check that this setting is turned on, you can run:
+
+```shell
+uvx repoauditor --GitHub-RebaseMergeCommit
+```
+
+Similarly, `RepoAuditor` checks if `Issues` are enabled. You can set `RepoAuditor` to check if `Issues` is disabled by specifying
+
+```shell
+uvx repoauditor --GitHub-no-SupportIssues
+```
+
+Finally, `RepoAuditor` by default enforces that the `MIT License` exists for the repository. If your organization requires another license (such as `GPL`), you can enforce that by specifying the license keyword such as:
+
+```shell
+uvx repoauditor --GitHub-License-value "GNU General Public License v2.0"
+```
+
+The types of licenses supported by GitHub can be found [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type). Be sure to specify the full license name, e.g. `GNU General Public License v2.0`.
+
 ### Config File
 
 `RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
 
 The configuration (or config) file can make usage easier by recording preferences as well as facilitating sharing of enforced requirements within an organization.
 We have provided a sample configuration file called [default_config.yaml](https://github.com/gt-sse-center/RepoAuditor/blob/main/default_config.yaml), which can be used as:
+
 ```shell
 uvx run RepoAuditor --config default_config.yaml
 ```
@@ -171,4 +207,4 @@ Additional information can be found at these locations.
 
 ## License
 
-RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.79 → repoauditor-0.2.81}/README.md

@@ -115,12 +115,48 @@ uvx RepoAuditor --include GitHub \
 
 `RepoAuditor` will generate a series of messages describing all the issues in the repository, along with the rationale behind them and the steps for resolution.
 
+### Custom Settings
+
+`RepoAuditor` tries to provide default settings and checks which are considered best practices. However, your team or organization may have different ways of doing things.
+You can override the default settings by specifying the appropriate flag.
+
+We have 3 types of flags:
+
+1. Boolean flags for those settings which are checked to be on by default and you wish to check are off, with the form `Module-no-Requirement` (e.g. `--GitHub-no-MergeCommit`).
+2. Conversely, boolean flags for those settings which are checked to be off by default, and you wish to check are on, denoted by the form `Module-Requirement` (e.g. `--GitHub-AllowDeletions`).
+3. Values flags take a string value to determine what value to enforce, and have the form `Module-Requirement-value` (e.g. `--GitHub-License-value "MIT License"`).
+
+Please run `uvx repoauditor --help` to get the list of all flags available.
+
+#### Examples
+
+For example, `RepoAuditor` by default checks that the setting `Allow rebase merging` is off. If you wish to check that this setting is turned on, you can run:
+
+```shell
+uvx repoauditor --GitHub-RebaseMergeCommit
+```
+
+Similarly, `RepoAuditor` checks if `Issues` are enabled. You can set `RepoAuditor` to check if `Issues` is disabled by specifying
+
+```shell
+uvx repoauditor --GitHub-no-SupportIssues
+```
+
+Finally, `RepoAuditor` by default enforces that the `MIT License` exists for the repository. If your organization requires another license (such as `GPL`), you can enforce that by specifying the license keyword such as:
+
+```shell
+uvx repoauditor --GitHub-License-value "GNU General Public License v2.0"
+```
+
+The types of licenses supported by GitHub can be found [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type). Be sure to specify the full license name, e.g. `GNU General Public License v2.0`.
+
 ### Config File
 
 `RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
 
 The configuration (or config) file can make usage easier by recording preferences as well as facilitating sharing of enforced requirements within an organization.
 We have provided a sample configuration file called [default_config.yaml](https://github.com/gt-sse-center/RepoAuditor/blob/main/default_config.yaml), which can be used as:
+
 ```shell
 uvx run RepoAuditor --config default_config.yaml
 ```
@@ -144,4 +180,4 @@ Additional information can be found at these locations.
 
 ## License
 
-RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.79 → repoauditor-0.2.81}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 requires-python = ">= 3.10"
 dependencies = [
-    "dbrownell-common>=0.14.10",
+    "dbrownell-common>=0.16.0",
     "gitpython>=3.1.44",
     "pluggy>=1.5.0",
     "requests>=2.32.3",
@@ -36,7 +36,7 @@ Repository = "https://github.com/gt-sse-center/RepoAuditor"
 
 [project.scripts]
 RepoAuditor = "RepoAuditor:EntryPoint.app"
-repo_auditor = "RepoAuditor:EntryPoint.app"
+repoauditor = "RepoAuditor:EntryPoint.app"
 
 [project.entry-points.RepoAuditor]
 GitHubPlugin = "RepoAuditor.Plugins.GitHubPlugin"
@@ -61,7 +61,7 @@ dev = [
 path = "src/RepoAuditor/__init__.py"
 
 [tool.pytest.ini_options]
-addopts = "--verbose -vv --capture=no --cov=RepoAuditor --cov-fail-under=95.0"
+addopts = "--verbose -vv --capture=no --cov=RepoAuditor --cov-fail-under=95.0 --cov-report html --cov-report term --cov-report xml:coverage.xml"
 python_files = [
     "**/*Test.py",
 ]

{repoauditor-0.2.79 → repoauditor-0.2.81}/src/RepoAuditor/EntryPoint.py

@@ -166,7 +166,7 @@ def _HelpEpilog() -> str:
 
         Command Line Examples
         =====================
-        repo_auditor --include GitHub --GitHub-url https://github.com/gt-sse-center/RepoAuditor --GitHub-pat <PAT or path to file containing PAT>
+        RepoAuditor --include GitHub --GitHub-url https://github.com/gt-sse-center/RepoAuditor --GitHub-pat <PAT or path to file containing PAT>
 
         """,
         )

{repoauditor-0.2.79 → repoauditor-0.2.81}/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.79"
+__version__ = "0.2.81"

{repoauditor-0.2.79 → repoauditor-0.2.81}/uv.lock

@@ -193,7 +193,7 @@ toml = [
 
 [[package]]
 name = "dbrownell-common"
-version = "0.14.12"
+version = "0.16.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "inflect" },
@@ -201,9 +201,9 @@ dependencies = [
     { name = "typer" },
     { name = "typer-config" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/d9/41/2a0f0f8fb7985755fc9678564215a971d5beabb50c4a47be9b4717935338/dbrownell_common-0.14.12.tar.gz", hash = "sha256:2359536fcf418a2f35497c2082209c067e141ed5538a05a20d73bb04b927e938", size = 97337, upload-time = "2025-06-18T13:41:35.339Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/72/e1/3b95222dd52b010b62b7e93d7f7983acf1fe0d1ccb07a3185c9ea9b366ee/dbrownell_common-0.16.0.tar.gz", hash = "sha256:45a46ede7e575e28ba906b5489a671092f429b46b998a5b10d06c09523a20c2f", size = 96133, upload-time = "2025-07-21T14:12:16.596Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/f2/b1/5d7806492892d37dc1b2220f7b10edcfcdc701a5c4fd0bab897025544981/dbrownell_common-0.14.12-py3-none-any.whl", hash = "sha256:9e11370a94bdf546d0f25c8de346dccaf145474dd213bc0f940f1bdbd7c080d1", size = 43027, upload-time = "2025-06-18T13:41:34.47Z" },
+    { url = "https://files.pythonhosted.org/packages/48/54/63aed9214a1e1fdfd84265a7eaef5feed6d7da24fc78ff131fe2f6f825e0/dbrownell_common-0.16.0-py3-none-any.whl", hash = "sha256:5fc4b0f584aad21d5ccc1ca89415803f3f429407f6518d6b0212b44663a29711", size = 43409, upload-time = "2025-07-21T14:12:15.274Z" },
 ]
 
 [[package]]
@@ -537,7 +537,7 @@ dev = [
 
 [package.metadata]
 requires-dist = [
-    { name = "dbrownell-common", specifier = ">=0.14.10" },
+    { name = "dbrownell-common", specifier = ">=0.16.0" },
     { name = "gitpython", specifier = ">=3.1.44" },
     { name = "pluggy", specifier = ">=1.5.0" },
     { name = "requests", specifier = ">=2.32.3" },