github-org-manager 0.7.6__tar.gz → 0.7.8__tar.gz

{github_org_manager-0.7.6 → github_org_manager-0.7.8}/PKG-INFO

@@ -1,35 +1,29 @@
 Metadata-Version: 2.4
 Name: github-org-manager
-Version: 0.7.6
+Version: 0.7.8
 Summary: Manage a GitHub Organization, its teams, repository permissions, and more
-License: Apache-2.0
-License-File: LICENSE.txt
-License-File: LICENSES/Apache-2.0.txt
-License-File: LICENSES/CC-BY-4.0.txt
-License-File: LICENSES/CC0-1.0.txt
-License-File: LICENSES/MIT.txt
 Keywords: github,github-management,permissions,access-control
 Author: Max Mehl
-Author-email: max.mehl@deutschebahn.com
-Requires-Python: >=3.10,<4.0
+Author-email: Max Mehl <max.mehl@deutschebahn.com>
+License-Expression: Apache-2.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Utilities
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Software Development :: Version Control :: Git
-Classifier: Topic :: Utilities
-Requires-Dist: jsonschema (>=4.25.1,<5.0.0)
-Requires-Dist: pygithub (>=2.8.1,<3.0.0)
-Requires-Dist: python-slugify (>=8.0.4,<9.0.0)
-Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
-Requires-Dist: requests (>=2.32.5,<3.0.0)
+Requires-Dist: pygithub>=2.8.1,<3
+Requires-Dist: pyyaml>=6.0.3,<7
+Requires-Dist: requests>=2.32.5,<3
+Requires-Dist: python-slugify>=8.0.4,<9
+Requires-Dist: jsonschema>=4.25.1,<5
+Requires-Python: >=3.10, <4
 Project-URL: Repository, https://github.com/OpenRailAssociation/github-org-manager
 Description-Content-Type: text/markdown
 
@@ -125,4 +119,3 @@ The content of this repository is licensed under the [Apache 2.0 license](https:
 There may be components under different, but compatible licenses or from different copyright holders. The project is REUSE compliant which makes these portions transparent. You will find all used licenses in the [LICENSES](./LICENSES/) directory.
 
 The project is has been started by the [OpenRail Association](https://openrailassociation.org). You are welcome to [contribute](./CONTRIBUTING.md)!
-

{github_org_manager-0.7.6 → github_org_manager-0.7.8}/gh_org_mgr/__init__.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Global init file"""
+"""Global init file."""
 
 from importlib.metadata import version
 

{github_org_manager-0.7.6 → github_org_manager-0.7.8}/gh_org_mgr/_config.py

@@ -2,12 +2,12 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Handling the private and organisation configuration"""
+"""Handling the private and organisation configuration."""
 
 import logging
-import os
 import re
 import sys
+from pathlib import Path
 from typing import Any
 
 import yaml
@@ -100,21 +100,22 @@ TEAM_CONFIG_SCHEMA = {
 
 
 def _find_matching_files(directory: str, pattern: str, only_one: bool = False) -> list[str]:
-    """
-    Get all files in a directory matching a regex pattern.
+    """Get all files in a directory matching a regex pattern.
 
     Args:
-    - directory: Path to the directory
-    - pattern: Regular expression pattern to match filenames
-    - only_one: Whether only the first match shall be returned.
+        directory: Path to the directory.
+        pattern: Regular expression pattern to match filenames.
+        only_one: Whether only the first match shall be returned.
 
     Returns:
-    - List of filenames matching the pattern
+        List of filenames matching the pattern.
     """
     matching_files: list[str] = []
 
+    dir_path = Path(directory)
+
     # Validate directory existence
-    if not os.path.isdir(directory):
+    if not dir_path.is_dir():
         logging.error("'%s' is not a valid directory", directory)
 
     else:
@@ -122,16 +123,15 @@ def _find_matching_files(directory: str, pattern: str, only_one: bool = False) -
         regex_pattern = re.compile(pattern + "$")
 
         # Traverse the directory and find matching files
-        for file_name in os.listdir(directory):
-            if regex_pattern.match(file_name):
-                file_path = os.path.join(directory, file_name)
-                if os.path.isfile(file_path):
-                    matching_files.append(file_path)
+        for entry in dir_path.iterdir():
+            if regex_pattern.match(entry.name):
+                if entry.is_file():
+                    matching_files.append(str(entry))
                 else:
                     logging.warning(
                         "'%s' looks like a file we searched for, but it's not. "
                         "Will not consider its contents",
-                        file_path,
+                        entry,
                     )
 
         if only_one and len(matching_files) > 1:
@@ -154,7 +154,7 @@ def _find_matching_files(directory: str, pattern: str, only_one: bool = False) -
 
 
 def _read_config_file(file: str) -> dict:
-    """Return dict of a YAML file"""
+    """Return dict of a YAML file."""
     logging.debug("Attempting to parse YAML file %s", file)
     with open(file, encoding="UTF-8") as yamlfile:
         config: dict = yaml.safe_load(yamlfile)
@@ -166,7 +166,7 @@ def _read_config_file(file: str) -> dict:
 
 
 def _validate_config_schema(file: str, cfg: dict, schema: dict) -> None:
-    """Validate the config against a JSON schema"""
+    """Validate the config against a JSON schema."""
     try:
         validate(instance=cfg, schema=schema, format_checker=FormatChecker())
     except ValidationError as e:
@@ -177,11 +177,12 @@ def _validate_config_schema(file: str, cfg: dict, schema: dict) -> None:
 
 def parse_config_files(path: str) -> tuple[dict[str, str | dict[str, str]], dict, dict]:
     """Parse all relevant files in the configuration directory. Returns a tuple
-    of org config, app config, and merged teams config"""
+    of org config, app config, and merged teams config.
+    """
     # Find the relevant config files for app, org, and teams
     cfg_app_files = _find_matching_files(path, APP_CONFIG_FILE, only_one=True)
     cfg_org_files = _find_matching_files(path, ORG_CONFIG_FILE, only_one=True)
-    cfg_teams_files = _find_matching_files(os.path.join(path, TEAM_CONFIG_DIR), TEAM_CONFIG_FILES)
+    cfg_teams_files = _find_matching_files(str(Path(path) / TEAM_CONFIG_DIR), TEAM_CONFIG_FILES)
 
     # Read and parse config files for app and org
     cfg_app = _read_config_file(cfg_app_files[0])

{github_org_manager-0.7.6 → github_org_manager-0.7.8}/gh_org_mgr/_gh_api.py

@@ -2,20 +2,21 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""
-Functions for interacting with the GitHub API
-"""
+"""Functions for interacting with the GitHub API."""
 
+import contextlib
 import logging
 import os
 import sys
+from http import HTTPStatus
+from typing import Any
 
 import requests
 
 
 def get_github_secrets_from_env(env_variable: str, secret: str | int) -> str:
-    """Get GitHub secrets from config or environment, while environment overrides"""
-    if env_variable in os.environ and os.environ[env_variable]:
+    """Get GitHub secrets from config or environment, while environment overrides."""
+    if os.environ.get(env_variable):
         logging.debug("GitHub secret taken from environment variable %s", env_variable)
         secret = os.environ[env_variable]
     elif secret:
@@ -25,8 +26,8 @@ def get_github_secrets_from_env(env_variable: str, secret: str | int) -> str:
 
 
 # Function to execute GraphQL query
-def run_graphql_query(query, variables, token):
-    """Run a query against the GitHub GraphQL API"""
+def run_graphql_query(query: str, variables: dict[str, Any], token: str) -> dict | str:
+    """Run a query against the GitHub GraphQL API."""
     headers = {"Authorization": f"Bearer {token}"}
     request = requests.post(
         "https://api.github.com/graphql",
@@ -37,12 +38,10 @@ def run_graphql_query(query, variables, token):
 
     # Get JSON result
     json_return = "No valid JSON return"
-    try:
+    with contextlib.suppress(requests.exceptions.JSONDecodeError):
         json_return = request.json()
-    except requests.exceptions.JSONDecodeError:
-        pass
 
-    if request.status_code == 200:
+    if request.status_code == HTTPStatus.OK:
         return json_return
 
     # Debug information in case of errors