pyOpenSourceProjects 0.2.3__tar.gz → 0.3.0__tar.gz

pyopensourceprojects-0.3.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: pyOpenSourceProjects
+Version: 0.3.0
+Dynamic: Summary
+Project-URL: Home, https://github.com/WolfgangFahl/pyOpenSourceProjects
+Project-URL: Documentation, http://wiki.bitplan.com/index.php/pyOpenSourceProjects
+Project-URL: Source, https://github.com/WolfgangFahl/pyOpenSourceProjects
+Author-email: Wolfgang Fahl <wf@bitplan.com>
+Maintainer-email: Wolfgang Fahl <wf@bitplan.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: gitpython
+Requires-Dist: packaging>=24.1
+Requires-Dist: py-3rdparty-mediawiki>=0.17.0
+Requires-Dist: pylodstorage>=0.17.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: requests
+Requires-Dist: tqdm>=4.66.5
+Provides-Extra: test
+Description-Content-Type: text/markdown
+
+# pyOpenSourceProjects
+Helper Library to organize open source Projects
+
+| | |
+| :--- | :--- |
+| **GitHub** | [![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml) [![GitHub issues](https://img.shields.io/github/issues/WolfgangFahl/pyOpenSourceProjects.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/issues) [![GitHub closed issues](https://img.shields.io/github/issues-closed/WolfgangFahl/pyOpenSourceProjects.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/issues/?q=is%3Aissue+is%3Aclosed) |
+| **PyPi** | [![PyPI Status](https://img.shields.io/pypi/v/pyOpenSourceProjects.svg)](https://pypi.python.org/pypi/pyOpenSourceProjects/) [![License](https://img.shields.io/github/license/WolfgangFahl/pyOpenSourceProjects.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![pypi](https://img.shields.io/pypi/pyversions/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) |
+| **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/) |
+
+## Documentation
+[Wiki](https://wiki.bitplan.com/index.php/PyOpenSourceProjects)
+
+### Authors
+* [Tim Holzheim](https://www.semantic-mediawiki.org/wiki/Tim_Holzheim)
+* [Wolfgang Fahl](http://www.bitplan.com/Wolfgang_Fahl)

pyopensourceprojects-0.3.0/README.md

@@ -0,0 +1,15 @@
+# pyOpenSourceProjects
+Helper Library to organize open source Projects
+
+| | |
+| :--- | :--- |
+| **GitHub** | [![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml) [![GitHub issues](https://img.shields.io/github/issues/WolfgangFahl/pyOpenSourceProjects.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/issues) [![GitHub closed issues](https://img.shields.io/github/issues-closed/WolfgangFahl/pyOpenSourceProjects.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/issues/?q=is%3Aissue+is%3Aclosed) |
+| **PyPi** | [![PyPI Status](https://img.shields.io/pypi/v/pyOpenSourceProjects.svg)](https://pypi.python.org/pypi/pyOpenSourceProjects/) [![License](https://img.shields.io/github/license/WolfgangFahl/pyOpenSourceProjects.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![pypi](https://img.shields.io/pypi/pyversions/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) |
+| **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/) |
+
+## Documentation
+[Wiki](https://wiki.bitplan.com/index.php/PyOpenSourceProjects)
+
+### Authors
+* [Tim Holzheim](https://www.semantic-mediawiki.org/wiki/Tim_Holzheim)
+* [Wolfgang Fahl](http://www.bitplan.com/Wolfgang_Fahl)

pyopensourceprojects-0.3.0/osprojects/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

pyopensourceprojects-0.2.3/osprojects/checkos.py → pyopensourceprojects-0.3.0/osprojects/check_project.py

@@ -1,22 +1,23 @@
-#!/usr/bin/env python
 """
-Created on 2024-07-30
+Created on 2024-08-28
 
 @author: wf
 """
-import argparse
+
 import os
-from argparse import Namespace
+import tomllib
 from dataclasses import dataclass
+from typing import List
+
 from git import Repo
 from git.exc import InvalidGitRepositoryError, NoSuchPathError
-from typing import List
+from packaging import version
+
+from osprojects.github_api import GitHubAction
+
 # original at ngwidgets - use redundant local copy ...
 from osprojects.editor import Editor
-from osprojects.osproject import GitHub, OsProject
-import tomllib
-import traceback
-from packaging import version
+
 
 @dataclass
 class Check:
@@ -39,20 +40,22 @@ class Check:
         check = Check(ok, path, msg=path, content=content)
         return check
 
-class CheckOS:
+
+class CheckProject:
     """
-    check the open source projects
+    Checker for an individual open source project
     """
 
-    def __init__(self, args: Namespace, project: OsProject):
-        self.args = args
-        self.verbose = args.verbose
-        self.workspace = args.workspace
+    def __init__(self, parent, project, args):
+        self.parent = parent
         self.project = project
-        self.project_path = os.path.join(self.workspace, project.id)
-        self.checks = []
-        # python 3.12 is max version
-        self.max_python_version_minor=12
+        self.args = args
+        self.checks: List[Check] = []
+        self.project_path = project.folder
+        self.project_name = None
+        self.requires_python = None
+        self.min_python_version_minor = None
+        self.max_python_version_minor = 13  # python 3.13 is max version
 
     @property
     def total(self) -> int:
@@ -68,20 +71,28 @@ class CheckOS:
         failed_checks = [check for check in self.checks if not check.ok]
         return failed_checks
 
-    def add_check(self, ok, msg:str="",path: str=None,negative:bool=False) -> Check:
+    def add_error(self, ex, path: str):
+        self.parent.handle_exception(ex)
+        self.add_check(False, msg=f"{str(ex)}", path=path)
+
+    def add_check(
+        self, ok, msg: str = "", path: str = None, negative: bool = False
+    ) -> Check:
         if not path:
             raise ValueError("path parameter missing")
-        marker=""
+        marker = ""
         if negative:
-            ok=not ok
-            marker="⚠ ️"
+            ok = not ok
+            marker = "⚠ ️"
         check = Check(ok=ok, path=path, msg=f"{marker}{msg}{path}")
         self.checks.append(check)
         return check
 
-    def add_content_check(self, content: str, needle: str, path: str, negative:bool=False) -> Check:
-        ok=needle in content
-        check=self.add_check(ok, msg=f"{needle} in ", path=path,negative=negative)
+    def add_content_check(
+        self, content: str, needle: str, path: str, negative: bool = False
+    ) -> Check:
+        ok = needle in content
+        check = self.add_check(ok, msg=f"{needle} in ", path=path, negative=negative)
         return check
 
     def add_path_check(self, path) -> Check:
@@ -111,8 +122,14 @@ class CheckOS:
                     content = file_exists.content
 
                     if file == "build.yml":
-                        min_python_version_minor = int(self.requires_python.split('.')[-1])
-                        self.add_check(min_python_version_minor==self.min_python_version_minor,msg=f"{min_python_version_minor} (build.yml)!={self.min_python_version_minor} (pyprojec.toml)",path=file_path)
+                        min_python_version_minor = int(
+                            self.requires_python.split(".")[-1]
+                        )
+                        self.add_check(
+                            min_python_version_minor == self.min_python_version_minor,
+                            msg=f"{min_python_version_minor} (build.yml)!={self.min_python_version_minor} (pyprojec.toml)",
+                            path=file_path,
+                        )
                         python_versions = f"""python-version: [ {', '.join([f"'3.{i}'" for i in range(self.min_python_version_minor, self.max_python_version_minor+1)])} ]"""
                         self.add_content_check(
                             content,
@@ -124,7 +141,9 @@ class CheckOS:
                             "os: [ubuntu-latest, macos-latest, windows-latest]",
                             file_path,
                         )
-                        self.add_content_check(content, "uses: actions/checkout@v4", file_path)
+                        self.add_content_check(
+                            content, "uses: actions/checkout@v4", file_path
+                        )
                         self.add_content_check(
                             content,
                             "uses: actions/setup-python@v5",
@@ -132,17 +151,20 @@ class CheckOS:
                         )
 
                         self.add_content_check(
-                            content,
-                            "sphinx",
-                            file_path,
-                            negative=True
+                            content, "sphinx", file_path, negative=True
+                        )
+                        scripts_ok = (
+                            "scripts/install" in content
+                            and "scripts/test" in content
+                            or "scripts/installAndTest" in content
                         )
-                        scripts_ok="scripts/install" in content and "scripts/test" in content or "scripts/installAndTest" in content
-                        self.add_check(scripts_ok,"install and test", file_path)
+                        self.add_check(scripts_ok, "install and test", file_path)
 
                     elif file == "upload-to-pypi.yml":
                         self.add_content_check(content, "id-token: write", file_path)
-                        self.add_content_check(content, "uses: actions/checkout@v4", file_path)
+                        self.add_content_check(
+                            content, "uses: actions/checkout@v4", file_path
+                        )
                         self.add_content_check(
                             content,
                             "uses: actions/setup-python@v5",
@@ -164,19 +186,27 @@ class CheckOS:
                 file_exists = self.add_path_check(file_path)
                 if file_exists.ok:
                     content = file_exists.content
-                    if file=="doc":
-                        self.add_content_check(content, "sphinx", file_path, negative=True)
-                        self.add_content_check(content,"WF 2024-07-30 - updated",file_path)
-                    if file=="test":
-                        self.add_content_check(content,"WF 2024-08-03",file_path)
-                    if file=="release":
+                    if file == "doc":
+                        self.add_content_check(
+                            content, "sphinx", file_path, negative=True
+                        )
+                        self.add_content_check(
+                            content, "WF 2024-07-30 - updated", file_path
+                        )
+                    if file == "test":
+                        self.add_content_check(content, "WF 2024-08-03", file_path)
+                    if file == "release":
                         self.add_content_check(content, "scripts/doc -d", file_path)
 
     def check_readme(self):
         readme_path = os.path.join(self.project_path, "README.md")
         readme_exists = self.add_path_check(readme_path)
         if not hasattr(self, "project_name"):
-            self.add_check(False, "project_name from pyproject.toml needed for README.md check", self.project_path)
+            self.add_check(
+                False,
+                "project_name from pyproject.toml needed for README.md check",
+                self.project_path,
+            )
             return
         if readme_exists.ok:
             readme_content = readme_exists.content
@@ -186,7 +216,7 @@ class CheckOS:
                 "[![PyPI Status](https://img.shields.io/pypi/v/{self.project_name}.svg)](https://pypi.python.org/pypi/{self.project_name}/)",
                 "[![GitHub issues](https://img.shields.io/github/issues/{self.project.fqid}.svg)](https://github.com/{self.project.fqid}/issues)",
                 "[![GitHub closed issues](https://img.shields.io/github/issues-closed/{self.project.fqid}.svg)](https://github.com/{self.project.fqid}/issues/?q=is%3Aissue+is%3Aclosed)",
-                "[![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://{self.project.owner}.github.io/{self.project.id}/)",
+                "[![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://{self.project.owner}.github.io/{self.project.project_id}/)",
                 "[![License](https://img.shields.io/github/license/{self.project.fqid}.svg)](https://www.apache.org/licenses/LICENSE-2.0)",
             ]
             for line in badge_lines:
@@ -196,81 +226,115 @@ class CheckOS:
                     needle=formatted_line,
                     path=readme_path,
                 )
-            self.add_content_check(readme_content, "readthedocs", readme_path, negative=True)
+            self.add_content_check(
+                readme_content, "readthedocs", readme_path, negative=True
+            )
 
-    def check_pyproject_toml(self)->bool:
+    def check_pyproject_toml(self) -> bool:
         """
         pyproject.toml
         """
         toml_path = os.path.join(self.project_path, "pyproject.toml")
         toml_exists = self.add_path_check(toml_path)
         if toml_exists.ok:
-            content=toml_exists.content
+            content = toml_exists.content
             toml_dict = tomllib.loads(content)
-            project_check=self.add_check("project" in toml_dict, "[project]", toml_path)
+            project_check = self.add_check(
+                "project" in toml_dict, "[project]", toml_path
+            )
             if project_check.ok:
-                self.project_name=toml_dict["project"]["name"]
-                requires_python_check=self.add_check("requires-python" in toml_dict["project"], "requires-python", toml_path)
+                self.project_name = toml_dict["project"]["name"]
+                requires_python_check = self.add_check(
+                    "requires-python" in toml_dict["project"],
+                    "requires-python",
+                    toml_path,
+                )
                 if requires_python_check.ok:
                     self.requires_python = toml_dict["project"]["requires-python"]
-                    min_python_version = version.parse(self.requires_python.replace(">=", ""))
-                    min_version_needed="3.9"
-                    version_ok=min_python_version >= version.parse(min_version_needed)
-                    self.add_check(version_ok, f"requires-python>={min_version_needed}", toml_path)
-                    self.min_python_version_minor=int(str(min_python_version).split('.')[-1])
-                    for minor_version in range(self.min_python_version_minor, self.max_python_version_minor+1):
-                        needle=f"Programming Language :: Python :: 3.{minor_version}"
+                    min_python_version = version.parse(
+                        self.requires_python.replace(">=", "")
+                    )
+                    min_version_needed = "3.9"
+                    version_ok = min_python_version >= version.parse(min_version_needed)
+                    self.add_check(
+                        version_ok, f"requires-python>={min_version_needed}", toml_path
+                    )
+                    self.min_python_version_minor = int(
+                        str(min_python_version).split(".")[-1]
+                    )
+                    for minor_version in range(
+                        self.min_python_version_minor, self.max_python_version_minor + 1
+                    ):
+                        needle = f"Programming Language :: Python :: 3.{minor_version}"
                         self.add_content_check(content, needle, toml_path)
             self.add_content_check(content, "hatchling", toml_path)
-            self.add_content_check(content,"[tool.hatch.build.targets.wheel.sources]",toml_path)
+            self.add_content_check(
+                content, "[tool.hatch.build.targets.wheel.sources]", toml_path
+            )
         return toml_exists.ok
 
-    def check_git(self):
+    def check_git(self) -> bool:
         """
-        Check git repository information using gitpython
+        Check git repository information using GitHub class
+
+        Returns:
+            bool: True if git owner matches project owner and the repo is not a fork
         """
+        owner_match = False
+        is_fork = False
         try:
-            repo = Repo(self.project_path)
-
-            # Check if it's actually a git repository
-            if not repo.bare:
-                self.add_check(True, "Is a git repository", self.project_path)
-
-                # Get the remote URL
-                try:
-                    remote_url = repo.remotes.origin.url
-                    self.add_check(True, "Has remote origin", self.project_path)
-
-                    # Extract owner and repository name from the URL
-                    parts = remote_url.split('/')
-                    git_owner = parts[-2]
-                    git_repo = parts[-1].replace('.git', '')
-
-                    # Compare with the project information we have
-                    owner_match = git_owner.lower() == self.project.owner.lower()
-                    self.add_check(owner_match, f"Git owner ({git_owner}) matches project owner ({self.project.owner})", self.project_path)
-
-                    repo_match = git_repo.lower() == self.project.id.lower()
-                    self.add_check(repo_match, f"Git repo name ({git_repo}) matches project id ({self.project.id})", self.project_path)
+            local_owner = self.project.owner
+            remote_owner = self.project.repo_info["owner"]["login"]
+            is_fork = self.project.repo_info["fork"]
+            owner_match = local_owner.lower() == remote_owner.lower() and not is_fork
+            self.add_check(
+                owner_match,
+                f"Git owner ({remote_owner}) matches project owner ({local_owner}) and is not a fork",
+                self.project_path,
+            )
 
-                except AttributeError:
-                    self.add_check(False, "No remote origin found", self.project_path)
+            local_project_id = self.project.project_id
+            remote_repo_name = self.project.repo_info["name"]
+            repo_match = local_project_id.lower() == remote_repo_name.lower()
+            self.add_check(
+                repo_match,
+                f"Git repo name ({remote_repo_name}) matches project id ({local_project_id})",
+                self.project_path,
+            )
 
-                # Check if there are uncommitted changes
-                if repo.is_dirty():
-                    self.add_check(False, "Repository has uncommitted changes", self.project_path)
-                else:
-                    self.add_check(True, "Repository is clean", self.project_path)
+            # Check if there are uncommitted changes (this still requires local git access)
+            local_repo = Repo(self.project_path)
+            self.add_check(
+                not local_repo.is_dirty(), "uncomitted changes for", self.project_path
+            )
 
+            # Check latest GitHub Actions workflow run
+            latest_run = GitHubAction.get_latest_workflow_run(self.project)
+            if latest_run:
+                self.add_check(
+                    latest_run["conclusion"] == "success",
+                    f"Latest GitHub Actions run: {latest_run['conclusion']}",
+                    latest_run["html_url"],
+                )
             else:
-                self.add_check(False, "Not a valid git repository (bare repository)", self.project_path)
+                self.add_check(
+                    False,
+                    "No GitHub Actions runs found",
+                    self.project.repo.ticketUrl(),
+                )
 
         except InvalidGitRepositoryError:
             self.add_check(False, "Not a valid git repository", self.project_path)
         except NoSuchPathError:
-            self.add_check(False, "Git repository path does not exist", self.project_path)
+            self.add_check(
+                False, "Git repository path does not exist", self.project_path
+            )
+        except Exception as ex:
+            self.add_error(ex, self.project_path)
 
-    def check(self, title:str):
+        return owner_match and not is_fork
+
+    def check(self, title: str):
         """
         Check the given project and print results
         """
@@ -283,7 +347,11 @@ class CheckOS:
 
         # ok_count=len(ok_checks)
         failed_count = len(self.failed_checks)
-        summary = f"❌ {failed_count:2}/{self.total:2}" if failed_count > 0 else f"✅ {self.total:2}/{self.total:2}"
+        summary = (
+            f"❌ {failed_count:2}/{self.total:2}"
+            if failed_count > 0
+            else f"✅ {self.total:2}/{self.total:2}"
+        )
         print(f"{title}{summary}:{self.project}→{self.project.url}")
         if failed_count > 0:
             # Sort checks by path
@@ -301,97 +369,16 @@ class CheckOS:
                 path_failed = sum(1 for c in path_checks if not c.ok)
                 if path_failed > 0 or self.args.debug:
                     print(f"❌ {path}: {path_failed}")
-                    i=0
+                    i = 0
                     for check in path_checks:
-                        show=not check.ok or self.args.debug
+                        show = not check.ok or self.args.debug
                         if show:
-                            i+=1
+                            i += 1
                             print(f"    {i:3}{check.marker}:{check.msg}")
 
                     if self.args.editor and path_failed > 0:
                         if os.path.isfile(path):
                             # @TODO Make editor configurable
-                            Editor.open(path,default_editor_cmd="/usr/local/bin/atom")
+                            Editor.open(path, default_editor_cmd="/usr/local/bin/atom")
                         else:
                             Editor.open_filepath(path)
-
-
-def main(_argv=None):
-    """
-    main command line entry point
-    """
-    parser = argparse.ArgumentParser(description="Check open source projects")
-    parser.add_argument(
-        "-d",
-        "--debug",
-        action="store_true",
-        help="add debug output",
-    )
-    parser.add_argument(
-        "-e",
-        "--editor",
-        action="store_true",
-        help="open default editor on failed files",
-    )
-    parser.add_argument(
-        "-o", "--owner", help="project owner or organization", required=True
-    )
-    parser.add_argument("-p", "--project", help="name of the project")
-    parser.add_argument("-l", "--language", help="filter projects by language")
-    parser.add_argument(
-        "--local", action="store_true", help="check only locally available projects"
-    )
-    parser.add_argument(
-        "-v", "--verbose", action="store_true", help="show verbose output"
-    )
-    parser.add_argument(
-        "-ws",
-        "--workspace",
-        help="(Eclipse) workspace directory",
-        default=os.path.expanduser("~/py-workspace"),
-    )
-
-    args = parser.parse_args(args=_argv)
-
-    try:
-        github = GitHub()
-        if args.project:
-            # Check specific project
-            projects = github.list_projects_as_os_projects(
-                args.owner, project_name=args.project
-            )
-        else:
-            # Check all projects
-            projects = github.list_projects_as_os_projects(args.owner)
-
-        if args.language:
-            projects = [p for p in projects if p.language == args.language]
-
-        if args.local:
-            local_projects = []
-            for project in projects:
-                checker = CheckOS(args=args, project=project)
-                if checker.check_local().ok:
-                    local_projects.append(project)
-            projects = local_projects
-
-        # filter for git ownership
-        filtered_projects = []
-        for project in projects:
-            checker = CheckOS(args=args, project=project)
-            checker.check_git()
-            git_owner_check = next((check for check in checker.checks if "Git owner" in check.msg), None)
-            if git_owner_check and git_owner_check.ok:
-                filtered_projects.append(project)
-        projects = filtered_projects
-
-        for i,project in enumerate(projects):
-            checker = CheckOS(args=args, project=project)
-            checker.check(f"{i+1:3}:")
-    except Exception as ex:
-        if args.debug:
-            print(traceback.format_exc())
-        raise ex
-
-if __name__ == "__main__":
-    main()