pyOpenSourceProjects 0.2.1__tar.gz → 0.2.3__tar.gz

{pyopensourceprojects-0.2.1 → pyopensourceprojects-0.2.3}/.github/workflows/build.yml

@@ -18,10 +18,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        #os: [ubuntu-latest]
-        python-version: [ 3.9, '3.10', '3.11', '3.12' ]
-        #python-version: ["3.10"]
+        #os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest]
+        #python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+        python-version: ["3.10"]
 
     steps:
     - uses: actions/checkout@v4

{pyopensourceprojects-0.2.1 → pyopensourceprojects-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyOpenSourceProjects
-Version: 0.2.1
+Version: 0.2.3
 Dynamic: Summary
 Project-URL: Home, https://github.com/WolfgangFahl/pyOpenSourceProjects
 Project-URL: Documentation, http://wiki.bitplan.com/index.php/pyOpenSourceProjects
@@ -15,9 +15,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
+Requires-Dist: gitpython
 Requires-Dist: packaging>=24.1
-Requires-Dist: py-3rdparty-mediawiki>=0.11.3
-Requires-Dist: pylodstorage>=0.11.6
+Requires-Dist: py-3rdparty-mediawiki>=0.12.0
+Requires-Dist: pylodstorage>=0.12.2
 Requires-Dist: python-dateutil>=2.8.2
 Provides-Extra: test
 Description-Content-Type: text/markdown

pyopensourceprojects-0.2.3/osprojects/__init__.py

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

{pyopensourceprojects-0.2.1 → pyopensourceprojects-0.2.3}/osprojects/checkos.py

@@ -8,6 +8,8 @@ import argparse
 import os
 from argparse import Namespace
 from dataclasses import dataclass
+from git import Repo
+from git.exc import InvalidGitRepositoryError, NoSuchPathError
 from typing import List
 # original at ngwidgets - use redundant local copy ...
 from osprojects.editor import Editor
@@ -49,6 +51,8 @@ class CheckOS:
         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
 
     @property
     def total(self) -> int:
@@ -91,6 +95,9 @@ class CheckOS:
         return local
 
     def check_github_workflows(self):
+        """
+        check the github workflow files
+        """
         workflows_path = os.path.join(self.project_path, ".github", "workflows")
         workflows_exist = self.add_path_check(workflows_path)
 
@@ -104,8 +111,9 @@ class CheckOS:
                     content = file_exists.content
 
                     if file == "build.yml":
-                        min_version = int(self.requires_python.split('.')[-1])
-                        python_versions = f"""python-version: [ {', '.join([f"'3.{i}'" for i in range(min_version, 13)])} ]"""
+                        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,
                             python_versions,
@@ -159,12 +167,17 @@ class CheckOS:
                     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/docs -d", file_path, negative=True)
+                        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)
+            return
         if readme_exists.ok:
             readme_content = readme_exists.content
             badge_lines = [
@@ -185,7 +198,10 @@ class CheckOS:
                 )
             self.add_content_check(readme_content, "readthedocs", readme_path, negative=True)
 
-    def check_pyproject_toml(self):
+    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:
@@ -197,27 +213,78 @@ class CheckOS:
                 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"]
-                    self.min_python_version = version.parse(self.requires_python.replace(">=", ""))
+                    min_python_version = version.parse(self.requires_python.replace(">=", ""))
                     min_version_needed="3.9"
-                    version_ok=self.min_python_version >= version.parse(min_version_needed)
+                    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)
+        return toml_exists.ok
+
+    def check_git(self):
+        """
+        Check git repository information using gitpython
+        """
+        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)
 
-    def check(self):
+                    # 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)
+
+                except AttributeError:
+                    self.add_check(False, "No remote origin found", 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)
+
+            else:
+                self.add_check(False, "Not a valid git repository (bare repository)", self.project_path)
+
+        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)
+
+    def check(self, title:str):
         """
         Check the given project and print results
         """
         self.check_local()
-        self.check_pyproject_toml()
-        self.check_readme()
-        self.check_scripts()
-        self.check_github_workflows()
+        self.check_git()
+        if self.check_pyproject_toml():
+            self.check_github_workflows()
+            self.check_readme()
+            self.check_scripts()
 
         # ok_count=len(ok_checks)
         failed_count = len(self.failed_checks)
-        summary = f"❌ {failed_count}/{self.total}" if failed_count > 0 else f"✅ {self.total}/{self.total}"
-        print(f"{self.project} {summary}: {self.project.url}")
+        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
             sorted_checks = sorted(self.checks, key=lambda c: c.path or "")
@@ -308,9 +375,19 @@ def main(_argv=None):
                     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()
+            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())

{pyopensourceprojects-0.2.1 → pyopensourceprojects-0.2.3}/pyproject.toml

@@ -15,8 +15,10 @@ readme = "README.md"
 license = "Apache-2.0"
 
 dependencies = [
-  "pyLodStorage>=0.11.6",
-  "py-3rdparty-mediawiki>=0.11.3",
+  # https://pypi.org/project/GitPython/
+  "gitpython",
+  "pyLodStorage>=0.12.2",
+  "py-3rdparty-mediawiki>=0.12.0",
   # https://pypi.org/project/python-dateutil/
   "python-dateutil>=2.8.2",
   # https://github.com/pypa/packaging

pyopensourceprojects-0.2.3/scripts/test

@@ -0,0 +1,132 @@
+#!/bin/bash
+# WF 2022-08-20
+# WF 2024-08-03
+
+#ansi colors
+#http://www.csc.uvic.ca/~sae/seng265/fall04/tips/s265s047-tips/bash-using-colors.html
+blue='\033[0;34m'
+red='\033[0;31m'
+green='\033[0;32m' # '\e[1;32m' is too bright for white bg.
+endColor='\033[0m'
+
+#
+# a colored message
+#   params:
+#     1: l_color - the color of the message
+#     2: l_msg - the message to display
+#
+color_msg() {
+  local l_color="$1"
+  local l_msg="$2"
+  echo -e "${l_color}$l_msg${endColor}"
+}
+
+#
+# error
+#
+# show the given error message on stderr and exit
+#
+#   params:
+#     1: l_msg - the error message to display
+#
+error() {
+  local l_msg="$1"
+  # use ansi red for error
+  color_msg $red "Error:" 1>&2
+  color_msg $red "\t$l_msg" 1>&2
+  exit 1
+}
+
+#
+# show a negative message
+#
+negative() {
+  local l_msg="$1"
+  color_msg $red "❌:$l_msg"
+}
+
+#
+# show a positive message
+#
+positive() {
+  local l_msg="$1"
+  color_msg $green "✅:$l_msg"
+}
+
+# show usage
+#
+usage() {
+  echo "$0 [-g|--green|-m|--module|-t|--tox|-h|--help]"
+  echo "-t |--tox: run tests with tox"
+  echo "-g |--green: run tests with green"
+  echo "-m |--module: run modulewise test"
+  echo "-h  |--help:  show this usage"
+  echo "default is running tests with unittest discover"
+  exit 1
+}
+
+#
+# check and optional install the given package
+#
+check_package() {
+  local l_package="$1"
+  pip show $l_package > /dev/null
+  if [ $? -ne 0 ]
+  then
+    negative "$l_package"
+    color_msg $blue "installing $l_package"
+    pip install $l_package
+  else
+    positive "$l_package"
+  fi
+}
+
+#
+# test module by module
+#
+modulewise_test() {
+  foundErrors=0
+  foundTests=0
+  for testmodule in tests/test*.py
+  do
+    echo "testing $testmodule ..."
+    # see https://github.com/CleanCut/green/issues/263
+    #green $testmodule -s1
+    python -m unittest $testmodule
+    exit_code=$?
+    foundErrors=$((foundErrors+exit_code))
+    foundTests=$((foundTests+1))
+  done
+  echo "$foundErrors/$foundTests  module unit tests failed" 1>&2
+  if [[ $foundErrors -gt 0 ]]
+  then
+    exit 1
+  fi
+}
+
+export PYTHON_PATH="."
+while [  "$1" != ""  ]
+do
+  option="$1"
+  case $option in
+    -h|--help)
+      usage
+      exit 0
+      ;;
+    -g|--green)
+      check_package green
+      green tests -s 1
+      exit 0
+      ;;
+    -m|--module)
+      modulewise_test
+      exit 0
+      ;;
+    -t|--tox)
+      check_package tox
+      tox -e py
+      exit 0
+      ;;
+  esac
+done
+python3 -m unittest discover

pyopensourceprojects-0.2.1/osprojects/__init__.py

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

pyopensourceprojects-0.2.1/scripts/test

@@ -1,9 +0,0 @@
-#!/bin/bash
-# WF 2020-06-03
-#python3 -m unittest discover
-pip list | egrep "^green " 
-if [ $? -ne 0 ]
-then
-  pip install green
-fi
-green