pyOpenSourceProjects 0.1.2__tar.gz → 0.2.1__tar.gz

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

@@ -20,7 +20,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         #os: [ubuntu-latest]
-        python-version: [3.9, "3.10", "3.11", "3.12"]
+        python-version: [ 3.9, '3.10', '3.11', '3.12' ]
         #python-version: ["3.10"]
 
     steps:
@@ -32,10 +32,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install sphinx
-        pip install sphinx_rtd_theme
         scripts/install
         scripts/doc
     - name: Run tests
       run: |
-        scripts/installAndTest
+        scripts/test

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyOpenSourceProjects
-Version: 0.1.2
+Version: 0.2.1
 Dynamic: Summary
 Project-URL: Home, https://github.com/WolfgangFahl/pyOpenSourceProjects
 Project-URL: Documentation, http://wiki.bitplan.com/index.php/pyOpenSourceProjects
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
+Requires-Dist: packaging>=24.1
 Requires-Dist: py-3rdparty-mediawiki>=0.11.3
 Requires-Dist: pylodstorage>=0.11.6
 Requires-Dist: python-dateutil>=2.8.2
@@ -25,10 +26,11 @@ Description-Content-Type: text/markdown
 Helper Library to organize open source Projects
 
 [![pypi](https://img.shields.io/pypi/pyversions/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/)
-[![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/workflows/Build/badge.svg?branch=main)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions?query=workflow%3ABuild+branch%3Amain)
+[![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml)
 [![PyPI Status](https://img.shields.io/pypi/v/pyOpenSourceProjects.svg)](https://pypi.python.org/pypi/pyOpenSourceProjects/)
 [![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)
+[![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/)
 [![License](https://img.shields.io/github/license/WolfgangFahl/pyOpenSourceProjects.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 

{pyopensourceprojects-0.1.2 → pyopensourceprojects-0.2.1}/README.md

@@ -2,10 +2,11 @@
 Helper Library to organize open source Projects
 
 [![pypi](https://img.shields.io/pypi/pyversions/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/)
-[![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/workflows/Build/badge.svg?branch=main)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions?query=workflow%3ABuild+branch%3Amain)
+[![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml)
 [![PyPI Status](https://img.shields.io/pypi/v/pyOpenSourceProjects.svg)](https://pypi.python.org/pypi/pyOpenSourceProjects/)
 [![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)
+[![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/)
 [![License](https://img.shields.io/github/license/WolfgangFahl/pyOpenSourceProjects.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 

pyopensourceprojects-0.2.1/mkdocs.yml

@@ -0,0 +1,18 @@
+site_name: pyOpenSourceProjects API Documentation
+theme:
+  name: material
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          setup_commands:
+            - import sys
+            - import os
+            - sys.path.insert(0, os.path.abspath("."))
+          selection:
+            docstring_style: google
+          rendering:
+            show_source: true
+nav:
+  - API: index.md

pyopensourceprojects-0.2.1/osprojects/__init__.py

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

pyopensourceprojects-0.2.1/osprojects/checkos.py

@@ -0,0 +1,320 @@
+#!/usr/bin/env python
+"""
+Created on 2024-07-30
+
+@author: wf
+"""
+import argparse
+import os
+from argparse import Namespace
+from dataclasses import dataclass
+from typing import List
+# 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:
+    ok: bool = False
+    path: str = None
+    msg: str = ""
+    content: str = None
+
+    @property
+    def marker(self) -> str:
+        return f"✅" if self.ok else f"❌"
+
+    @classmethod
+    def file_exists(cls, path) -> "Check":
+        ok = os.path.exists(path)
+        content = None
+        if ok and os.path.isfile(path):
+            with open(path, "r") as f:
+                content = f.read()
+        check = Check(ok, path, msg=path, content=content)
+        return check
+
+class CheckOS:
+    """
+    check the open source projects
+    """
+
+    def __init__(self, args: Namespace, project: OsProject):
+        self.args = args
+        self.verbose = args.verbose
+        self.workspace = args.workspace
+        self.project = project
+        self.project_path = os.path.join(self.workspace, project.id)
+        self.checks = []
+
+    @property
+    def total(self) -> int:
+        return len(self.checks)
+
+    @property
+    def ok_checks(self) -> List[Check]:
+        ok_checks = [check for check in self.checks if check.ok]
+        return ok_checks
+
+    @property
+    def failed_checks(self) -> List[Check]:
+        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:
+        if not path:
+            raise ValueError("path parameter missing")
+        marker=""
+        if negative:
+            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)
+        return check
+
+    def add_path_check(self, path) -> Check:
+        # Check if path exists
+        path_exists = Check.file_exists(path)
+        self.checks.append(path_exists)
+        return path_exists
+
+    def check_local(self) -> Check:
+        local = Check.file_exists(self.project_path)
+        return local
+
+    def check_github_workflows(self):
+        workflows_path = os.path.join(self.project_path, ".github", "workflows")
+        workflows_exist = self.add_path_check(workflows_path)
+
+        if workflows_exist.ok:
+            required_files = ["build.yml", "upload-to-pypi.yml"]
+            for file in required_files:
+                file_path = os.path.join(workflows_path, file)
+                file_exists = self.add_path_check(file_path)
+
+                if file_exists.ok:
+                    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)])} ]"""
+                        self.add_content_check(
+                            content,
+                            python_versions,
+                            file_path,
+                        )
+                        self.add_content_check(
+                            content,
+                            "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/setup-python@v5",
+                            file_path,
+                        )
+
+                        self.add_content_check(
+                            content,
+                            "sphinx",
+                            file_path,
+                            negative=True
+                        )
+                        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)
+
+                    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/setup-python@v5",
+                            file_path,
+                        )
+                        self.add_content_check(
+                            content,
+                            "uses: pypa/gh-action-pypi-publish@release/v1",
+                            file_path,
+                        )
+
+    def check_scripts(self):
+        scripts_path = os.path.join(self.project_path, "scripts")
+        scripts_exist = self.add_path_check(scripts_path)
+        if scripts_exist.ok:
+            required_files = ["blackisort", "test", "install", "doc", "release"]
+            for file in required_files:
+                file_path = os.path.join(scripts_path, file)
+                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=="release":
+                        self.add_content_check(content, "scripts/docs -d", file_path, negative=True)
+
+    def check_readme(self):
+        readme_path = os.path.join(self.project_path, "README.md")
+        readme_exists = self.add_path_check(readme_path)
+        if readme_exists.ok:
+            readme_content = readme_exists.content
+            badge_lines = [
+                "[![pypi](https://img.shields.io/pypi/pyversions/{self.project_name})](https://pypi.org/project/{self.project_name}/)",
+                "[![Github Actions Build](https://github.com/{self.project.fqid}/actions/workflows/build.yml/badge.svg)](https://github.com/{self.project.fqid}/actions/workflows/build.yml)",
+                "[![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}/)",
+                "[![License](https://img.shields.io/github/license/{self.project.fqid}.svg)](https://www.apache.org/licenses/LICENSE-2.0)",
+            ]
+            for line in badge_lines:
+                formatted_line = line.format(self=self)
+                self.add_content_check(
+                    content=readme_content,
+                    needle=formatted_line,
+                    path=readme_path,
+                )
+            self.add_content_check(readme_content, "readthedocs", readme_path, negative=True)
+
+    def check_pyproject_toml(self):
+        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
+            toml_dict = tomllib.loads(content)
+            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)
+                if requires_python_check.ok:
+                    self.requires_python = toml_dict["project"]["requires-python"]
+                    self.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)
+                    self.add_check(version_ok, f"requires-python>={min_version_needed}", toml_path)
+            self.add_content_check(content, "hatchling", toml_path)
+            self.add_content_check(content,"[tool.hatch.build.targets.wheel.sources]",toml_path)
+
+    def check(self):
+        """
+        Check the given project and print results
+        """
+        self.check_local()
+        self.check_pyproject_toml()
+        self.check_readme()
+        self.check_scripts()
+        self.check_github_workflows()
+
+        # 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}")
+        if failed_count > 0:
+            # Sort checks by path
+            sorted_checks = sorted(self.checks, key=lambda c: c.path or "")
+
+            # Group checks by path
+            checks_by_path = {}
+            for check in sorted_checks:
+                if check.path not in checks_by_path:
+                    checks_by_path[check.path] = []
+                checks_by_path[check.path].append(check)
+
+            # Display results
+            for path, path_checks in checks_by_path.items():
+                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
+                    for check in path_checks:
+                        show=not check.ok or self.args.debug
+                        if show:
+                            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")
+                        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
+
+        for project in projects:
+            checker = CheckOS(args=args, project=project)
+            checker.check()
+    except Exception as ex:
+        if args.debug:
+            print(traceback.format_exc())
+        raise ex
+
+if __name__ == "__main__":
+    main()

pyopensourceprojects-0.2.1/osprojects/editor.py

@@ -0,0 +1,132 @@
+"""
+Created on 2022-11-27
+
+@author: wf
+"""
+
+import os
+import platform
+import subprocess
+import tempfile
+from pathlib import Path
+from urllib.request import urlopen
+
+from bs4 import BeautifulSoup
+
+
+class Editor:
+    """
+    helper class to open the system defined editor
+
+    see https://stackoverflow.com/questions/1442841/lauch-default-editor-like-webbrowser-module
+    """
+
+    @classmethod
+    def open_filepath(cls, filepath: str):
+        if platform.system() == "Darwin":  # macOS
+            subprocess.call(("open", filepath))
+        elif platform.system() == "Windows":  # Windows
+            os.startfile(filepath, "open")
+        else:  # linux variants
+            subprocess.call(("xdg-open", filepath))
+
+    @classmethod
+    def extract_text(cls, html_text: str) -> str:
+        """
+        extract the text from the given html_text
+
+        Args:
+            html_text(str): the input for the html text
+
+        Returns:
+            str: the plain text
+        """
+        soup = BeautifulSoup(html_text, features="html.parser")
+
+        # kill all script and style elements
+        for script in soup(["script", "style"]):
+            script.extract()  # rip it out
+
+        # get text
+        text = soup.get_text()
+
+        # break into lines and remove leading and trailing space on each
+        lines = (line.strip() for line in text.splitlines())
+        # break multi-headlines into a line each
+        chunks = (phrase.strip() for line in lines for phrase in line.split("  "))
+        # drop blank lines
+        text = "\n".join(chunk for chunk in chunks if chunk)
+        return text
+
+    @classmethod
+    def open(
+        cls,
+        file_source: str,
+        extract_text: bool = True,
+        default_editor_cmd: str = "/usr/local/bin/atom",
+    ) -> str:
+        """
+        open an editor for the given file_source
+
+        Args:
+            file_source(str): the path to the file
+            extract_text(bool): if True extract the text from html sources
+
+        Returns:
+            str: the path to the file e.g. a temporary file if the file_source points to an url
+        """
+        # handle urls
+        # https://stackoverflow.com/a/45886824/1497139
+        if file_source.startswith("http"):
+            url_source = urlopen(file_source)
+            # https://stackoverflow.com/a/19156107/1497139
+            charset = url_source.headers.get_content_charset()
+            # if charset fails here you might want to set it to utf-8 as a default!
+            text = url_source.read().decode(charset)
+            if extract_text:
+                # https://stackoverflow.com/a/24618186/1497139
+                text = cls.extract_text(text)
+
+            return cls.open_tmp_text(text)
+
+        editor_cmd = None
+        editor_env = os.getenv("EDITOR")
+        if editor_env:
+            editor_cmd = editor_env
+        if platform.system() == "Darwin":
+            if not editor_env:
+                # https://stackoverflow.com/questions/22390709/how-can-i-open-the-atom-editor-from-the-command-line-in-os-x
+                editor_cmd = default_editor_cmd
+        if editor_cmd:
+            os_cmd = f"{editor_cmd} {file_source}"
+            os.system(os_cmd)
+        return file_source
+
+    @classmethod
+    def open_tmp_text(cls, text: str, file_name: str = None) -> str:
+        """
+        open an editor for the given text in a newly created temporary file
+
+        Args:
+            text(str): the text to write to a temporary file and then open
+            file_name(str): the name to use for the file
+
+        Returns:
+            str: the path to the temp file
+        """
+        # see https://stackoverflow.com/a/8577226/1497139
+        # https://stackoverflow.com/a/3924253/1497139
+        with tempfile.NamedTemporaryFile(delete=False) as tmp:
+            with open(tmp.name, "w") as tmp_file:
+                tmp_file.write(text)
+                tmp_file.close()
+            if file_name is None:
+                file_path = tmp.name
+            else:
+                # https://stackoverflow.com/questions/3167154/how-to-split-a-dos-path-into-its-components-in-python
+                path = Path(tmp.name)
+                # https://stackoverflow.com/a/49798311/1497139
+                file_path = path.parent / file_name
+                os.rename(tmp.name, file_path)
+
+            return cls.open(str(file_path))

{pyopensourceprojects-0.1.2 → pyopensourceprojects-0.2.1}/osprojects/osproject.py

@@ -3,15 +3,17 @@ Created on 2022-01-24
 
 @author: wf
 """
+
 from __future__ import annotations
-import os
+
 import argparse
 import datetime
 import json
+import os
 import re
 import subprocess
 import sys
-from typing import List, Type
+from typing import List, Optional, Type
 
 import requests
 from dateutil.parser import parse
@@ -55,23 +57,26 @@ class GitHub(TicketSystem):
     """
     wrapper for the GitHub api
     """
+
     @classmethod
-    def load_access_token(cls)->str:
+    def load_access_token(cls) -> str:
         """
         if $HOME/.github/access_token.json exists read the token from there
         """
         # Specify the path to the access token file
-        token_file_path = os.path.join(os.getenv('HOME'), '.github', 'access_token.json')
-        
+        token_file_path = os.path.join(
+            os.getenv("HOME"), ".github", "access_token.json"
+        )
+
         # Check if the file exists and read the token
         if os.path.exists(token_file_path):
-            with open(token_file_path, 'r') as token_file:
+            with open(token_file_path, "r") as token_file:
                 token_data = json.load(token_file)
-                return token_data.get('access_token')
-        
+                return token_data.get("access_token")
+
         # Return None if no token file is found
         return None
-    
+
     @classmethod
     def prepare_headers(cls, access_token: str = None) -> dict:
         """
@@ -80,15 +85,108 @@ class GitHub(TicketSystem):
         if access_token is None:
             access_token = cls.load_access_token()
 
-        headers = {'Authorization': f'token {access_token}'} if access_token else {}
+        headers = {"Authorization": f"token {access_token}"} if access_token else {}
         return headers
 
     @classmethod
-    def getIssues(cls, 
-        project: OsProject, 
-        access_token:str=None,
-        limit: int = None,
-        **params) -> List[Ticket]:
+    def list_projects_as_os_projects(
+        cls, owner: str, access_token: str = None, project_name: Optional[str] = None
+    ) -> List[OsProject]:
+        """
+        List all public repositories for a given owner and return them as OsProject instances.
+
+        Args:
+            owner (str): The GitHub username or organization name.
+            access_token (str, optional): GitHub personal access token for authentication.
+            project_name (str, optional): If provided, return only this specific project.
+
+        Returns:
+            List[OsProject]: A list of OsProject instances representing the repositories.
+        """
+        headers = cls.prepare_headers(access_token)
+
+        if project_name:
+            url = f"https://api.github.com/repos/{owner}/{project_name}"
+            response = requests.get(url, headers=headers)
+            if response.status_code != 200:
+                raise Exception(
+                    f"Failed to fetch repository: {response.status_code} - {response.text}"
+                )
+            repos = [response.json()]
+        else:
+            url = f"https://api.github.com/users/{owner}/repos"
+            params = {
+                "type": "all",
+                "per_page": 100,
+            }  # Include all repo types, 100 per page
+            all_repos = []
+            page = 1
+
+            while True:
+                params["page"] = page
+                response = requests.get(url, headers=headers, params=params)
+
+                if response.status_code != 200:
+                    raise Exception(
+                        f"Failed to fetch repositories: {response.status_code} - {response.text}"
+                    )
+
+                repos = response.json()
+                if not repos:
+                    break  # No more repositories to fetch
+
+                all_repos.extend(repos)
+                page += 1
+
+            repos = all_repos
+
+        return [
+            OsProject(
+                owner=owner,
+                id=repo["name"],
+                ticketSystem=cls,
+                title=repo["name"],
+                url=repo["html_url"],
+                description=repo["description"],
+                language=repo["language"],
+                created_at=datetime.datetime.fromisoformat(
+                    repo["created_at"].rstrip("Z")
+                ),
+                updated_at=datetime.datetime.fromisoformat(
+                    repo["updated_at"].rstrip("Z")
+                ),
+                stars=repo["stargazers_count"],
+                forks=repo["forks_count"],
+            )
+            for repo in repos
+        ]
+
+    @classmethod
+    def get_project(
+        cls, owner: str, project_id: str, access_token: str = None
+    ) -> OsProject:
+        """
+        Get a specific project as an OsProject instance.
+
+        Args:
+            owner (str): The GitHub username or organization name.
+            project_id (str): The name of the project.
+            access_token (str, optional): GitHub personal access token for authentication.
+
+        Returns:
+            OsProject: An OsProject instance representing the repository.
+        """
+        projects = cls.list_projects_as_os_projects(
+            owner, access_token, project_name=project_id
+        )
+        if projects:
+            return projects[0]
+        raise Exception(f"Project {owner}/{project_id} not found")
+
+    @classmethod
+    def getIssues(
+        cls, project: OsProject, access_token: str = None, limit: int = None, **params
+    ) -> List[Ticket]:
         payload = {}
         headers = cls.prepare_headers(access_token)
         issues = []
@@ -104,20 +202,24 @@ class GitHub(TicketSystem):
                 data=payload,
                 params=params,
             )
-            if response.status_code == 403 and 'rate limit' in response.text:
+            if response.status_code == 403 and "rate limit" in response.text:
                 raise Exception("rate limit - you might want to use an access token")
             issue_records = json.loads(response.text)
             for record in issue_records:
                 tr = {
                     "project": project,
                     "title": record.get("title"),
-                    "body": record.get("body", ""),  
-                    "createdAt": parse(record.get("created_at"))
-                    if record.get("created_at")
-                    else "",
-                    "closedAt": parse(record.get("closed_at"))
-                    if record.get("closed_at")
-                    else "",
+                    "body": record.get("body", ""),
+                    "createdAt": (
+                        parse(record.get("created_at"))
+                        if record.get("created_at")
+                        else ""
+                    ),
+                    "closedAt": (
+                        parse(record.get("closed_at"))
+                        if record.get("closed_at")
+                        else ""
+                    ),
                     "state": record.get("state"),
                     "number": record.get("number"),
                     "url": f"{cls.projectUrl(project)}/issues/{record.get('number')}",
@@ -126,7 +228,7 @@ class GitHub(TicketSystem):
                 fetched_count += 1
                 # Check if we have reached the limit
                 if limit is not None and fetched_count >= limit:
-                    nextResults=False
+                    nextResults = False
                     break
 
             if len(issue_records) < 100:
@@ -134,9 +236,11 @@ class GitHub(TicketSystem):
             else:
                 params["page"] += 1
         return issues
-    
+
     @classmethod
-    def getComments(cls, project: OsProject, issue_number: int, access_token: str = None) -> List[dict]:
+    def getComments(
+        cls, project: OsProject, issue_number: int, access_token: str = None
+    ) -> List[dict]:
         """
         Fetch all comments for a specific issue number from GitHub.
         """
@@ -146,7 +250,9 @@ class GitHub(TicketSystem):
         if response.status_code == 200:
             return response.json()
         else:
-            raise Exception(f"Failed to fetch comments: {response.status_code} - {response.text}")
+            raise Exception(
+                f"Failed to fetch comments: {response.status_code} - {response.text}"
+            )
         return []
 
     @staticmethod
@@ -160,7 +266,7 @@ class GitHub(TicketSystem):
     @staticmethod
     def commitUrl(project: OsProject, id: str):
         return f"{GitHub.projectUrl(project)}/commit/{id}"
-    
+
     @staticmethod
     def commentUrl(project: OsProject, issue_number: int):
         """
@@ -168,7 +274,6 @@ class GitHub(TicketSystem):
         """
         return f"https://api.github.com/repos/{project.owner}/{project.id}/issues/{issue_number}/comments"
 
-
     @staticmethod
     def resolveProjectUrl(url: str) -> (str, str):
         """
@@ -201,29 +306,53 @@ class OsProject(object):
         self,
         owner: str = None,
         id: str = None,
-        ticketSystem: Type[TicketSystem] = GitHub,
+        ticketSystem: Type[TicketSystem] = None,
+        title: str = None,
+        url: str = None,
+        description: str = None,
+        language: str = None,
+        created_at: datetime.datetime = None,
+        updated_at: datetime.datetime = None,
+        stars: int = 0,
+        forks: int = 0,
     ):
         """
         Constructor
         """
         self.owner = owner
         self.id = id
-        self.ticketSystem = ticketSystem
+        self.ticketSystem = ticketSystem or GitHub
+        self.title = title
+        self.url = url
+        self.description = description
+        self.language = language
+        self.created_at = created_at
+        self.updated_at = updated_at
+        self.stars = stars
+        self.forks = forks
+
+    @property
+    def fqid(self):
+        fqid = f"{self.owner}/{self.id}"
+        return fqid
+
+    def __str__(self):
+        return self.fqid
 
     @staticmethod
     def getSamples():
         samples = [
             {
                 "id": "pyOpenSourceProjects",
-                "state": "",
                 "owner": "WolfgangFahl",
                 "title": "pyOpenSourceProjects",
                 "url": "https://github.com/WolfgangFahl/pyOpenSourceProjects",
-                "version": "",
-                "desciption": "Helper Library to organize open source Projects",
-                "date": datetime.datetime(year=2022, month=1, day=24),
-                "since": "",
-                "until": "",
+                "description": "Helper Library to organize open source Projects",
+                "language": "Python",
+                "created_at": datetime.datetime(year=2022, month=1, day=24),
+                "updated_at": datetime.datetime(year=2022, month=1, day=24),
+                "stars": 5,
+                "forks": 2,
             }
         ]
         return samples
@@ -235,8 +364,7 @@ class OsProject(object):
         """
         url = subprocess.check_output(["git", "config", "--get", "remote.origin.url"])
         url = url.decode().strip("\n")
-        osProject = cls.fromUrl(url)
-        return osProject
+        return cls.fromUrl(url)
 
     @classmethod
     def fromUrl(cls, url: str) -> OsProject:
@@ -244,9 +372,11 @@ class OsProject(object):
         Init OsProject from given url
         """
         if "github.com" in url:
-            owner, project = GitHub.resolveProjectUrl(url)
-            if owner and project:
-                return OsProject(owner=owner, id=project, ticketSystem=GitHub)
+            owner, project_id = GitHub.resolveProjectUrl(url)
+            if owner and project_id:
+                github = GitHub()
+                project = github.get_project(owner, project_id)
+                return project
         raise Exception(f"Could not resolve the url '{url}' to a OsProject object")
 
     def getIssues(self, **params) -> list:
@@ -254,14 +384,14 @@ class OsProject(object):
         tickets.sort(key=lambda r: getattr(r, "number"), reverse=True)
         return tickets
 
-    def getAllTickets(self, limit:int=None,**params):
+    def getAllTickets(self, limit: int = None, **params):
         """
         Get all Tickets of the project -  closed and open ones
-        
+
         Args:
             limit(int): if set limit the number of tickets retrieved
         """
-        issues= self.getIssues(state="all",limit=limit, **params)
+        issues = self.getIssues(state="all", limit=limit, **params)
         return issues
 
     def getCommits(self) -> List[Commit]:

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

@@ -18,7 +18,9 @@ dependencies = [
   "pyLodStorage>=0.11.6",
   "py-3rdparty-mediawiki>=0.11.3",
   # https://pypi.org/project/python-dateutil/
-  "python-dateutil>=2.8.2"
+  "python-dateutil>=2.8.2",
+  # https://github.com/pypa/packaging
+  "packaging>=24.1"
 ]
 requires-python = ">=3.9"
 
@@ -44,10 +46,13 @@ path = "osprojects/__init__.py"
 test = []
 
 [tool.hatch.build.targets.wheel]
-packages = [
-  "osprojects",
-]
+only-include = ["osprojects"]
+
+[tool.hatch.build.targets.wheel.sources]
+"osprojects" = "osprojects"
+
 
 [project.scripts]
 issue2ticket = "osprojects.osproject:main"
 gitlog2wiki = "osprojects.osproject:gitlog2wiki"
+checkos = "osprojects.checkos:main"

pyopensourceprojects-0.2.1/scripts/doc

@@ -0,0 +1,88 @@
+#!/bin/bash
+# create docs for a configurable project
+# WF 2024-07-30 - updated
+
+# Extract project name from pyproject.toml
+PROJECT_NAME=$(grep "\[project\]" pyproject.toml -A1 | grep name | cut -d '=' -f2 | tr -d ' "')
+PACKAGE_NAME=$(grep "\[tool.hatch.build.targets.wheel.sources\]" pyproject.toml -A1 | tail -1 | cut -d '=' -f2 | tr -d ' "')
+
+
+# Function to print usage information
+print_usage() {
+    echo "Usage: $0 [OPTIONS]"
+    echo "Options:"
+    echo "  -pr, --project NAME    Set the project name (default: $PROJECT_NAME)"
+    echo "  -pa, --package NAME    Set the package name (default: $PACKAGE_NAME)"
+    echo "  -d, --deploy          Deploy the documentation after building"
+    echo "  -h, --help            Display this help message"
+}
+
+# Parse command line arguments
+DEPLOY=false
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        -pr|--project) PROJECT_NAME="$2"; shift ;;
+        -pa|--package) PACKAGE_NAME="$2"; shift ;;
+        -d|--deploy) DEPLOY=true ;;
+        -h|--help) print_usage; exit 0 ;;
+        *) echo "Unknown parameter: $1"; print_usage; exit 1 ;;
+    esac
+    shift
+done
+
+# Ensure we're in the correct directory
+if [[ ! -d "$PACKAGE_NAME" ]]; then
+    echo "Error: $PACKAGE_NAME package directory not found. Are you in the correct directory?"
+    exit 1
+fi
+
+# Check if mkdocs is installed
+if ! command -v mkdocs &> /dev/null; then
+    pip install mkdocs mkdocs-material mkdocstrings[python]
+fi
+
+# Create or update mkdocs.yml
+cat << EOF > mkdocs.yml
+site_name: $PROJECT_NAME API Documentation
+theme:
+  name: material
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          setup_commands:
+            - import sys
+            - import os
+            - sys.path.insert(0, os.path.abspath("."))
+          selection:
+            docstring_style: google
+          rendering:
+            show_source: true
+nav:
+  - API: index.md
+EOF
+
+# Create or update index.md
+index_md=docs/index.md
+mkdir -p docs
+cat << EOF > $index_md
+# $PROJECT_NAME API Documentation
+
+::: $PACKAGE_NAME
+    options:
+      show_submodules: true
+EOF
+
+# Ignore DeprecationWarnings during build
+export PYTHONWARNINGS="ignore::DeprecationWarning"
+
+# Build the documentation
+mkdocs build --config-file ./mkdocs.yml
+
+# Deploy if requested
+if [ "$DEPLOY" = true ]; then
+    mkdocs gh-deploy --force --config-file ./mkdocs.yml
+fi
+
+echo "Documentation process completed for $PROJECT_NAME."

pyopensourceprojects-0.2.1/scripts/release

@@ -0,0 +1,8 @@
+#!/bin/bash
+# WF 2024-07-31
+# prepare a release
+scripts/doc -d
+
+# Commit with a message that includes the current ISO timestamp
+git commit -a -m "release commit"
+git push

{pyopensourceprojects-0.1.2 → pyopensourceprojects-0.2.1}/tests/basetest.py

@@ -3,6 +3,7 @@ Created on 2021-08-19
 
 @author: wf
 """
+
 import getpass
 import io
 import os

{pyopensourceprojects-0.1.2 → pyopensourceprojects-0.2.1}/tests/test_osproject.py

@@ -3,6 +3,7 @@ Created on 2022-01-24
 
 @author: wf
 """
+
 import unittest
 
 from osprojects.osproject import Commit, GitHub, OsProject, Ticket, gitlog2wiki, main
@@ -23,7 +24,7 @@ class TestOsProject(BaseTest):
         expectedTicket = self.getSampleById(Ticket, "number", 2)
         expectedTicket.project = osProject
         comparison_ticket_dict = tickets[-2].__dict__
-        comparison_ticket_dict.pop('body', None)
+        comparison_ticket_dict.pop("body", None)
         self.assertDictEqual(expectedTicket.__dict__, comparison_ticket_dict)
         commit = Commit()
         ticket = Ticket()
@@ -102,6 +103,76 @@ class TestGitHub(BaseTest):
                 self.assertEqual(expectedOwner, owner)
                 self.assertEqual(expectedProject, project)
 
+    def testListProjects(self):
+        """
+        tests the list_projects_as_os_projects method
+        """
+        owner = "WolfgangFahl"
+        github = GitHub()
+
+        # Test list_projects_as_os_projects
+        projects = github.list_projects_as_os_projects(owner)
+        debug = self.debug
+        debug = True
+        if debug:
+            for project in projects:
+                print(project)
+        self.assertIsInstance(projects, list)
+        self.assertTrue(len(projects) > 0, "No projects found for WolfgangFahl")
+
+        # Check if pyOpenSourceProjects is in the list
+        pyosp_found = any(project.id == "pyOpenSourceProjects" for project in projects)
+        self.assertTrue(
+            pyosp_found, "pyOpenSourceProjects not found in the list of projects"
+        )
+
+        # Test a sample project's structure
+        sample_project = projects[0]
+        expected_attributes = {
+            "id",
+            "owner",
+            "title",
+            "url",
+            "description",
+            "language",
+            "created_at",
+            "updated_at",
+            "stars",
+            "forks",
+        }
+        self.assertTrue(
+            all(hasattr(sample_project, attr) for attr in expected_attributes),
+            "OsProject instance is missing expected attributes",
+        )
+
+        # Check if all items are OsProject instances
+        self.assertTrue(
+            all(isinstance(project, OsProject) for project in projects),
+            "Not all items are OsProject instances",
+        )
+
+        # Test a sample OsProject
+        sample_os_project = projects[0]
+        self.assertEqual(sample_os_project.owner, owner)
+        self.assertIsInstance(sample_os_project.id, str)
+        self.assertEqual(sample_os_project.ticketSystem, GitHub)
+
+    def testGetSpecificProject(self):
+        """
+        tests getting a specific project
+        """
+        owner = "WolfgangFahl"
+        project_name = "pyOpenSourceProjects"
+        github = GitHub()
+
+        project = github.list_projects_as_os_projects(owner, project_name=project_name)[
+            0
+        ]
+        self.assertIsInstance(project, OsProject)
+        self.assertEqual(project.id, project_name)
+        self.assertEqual(project.owner, owner)
+        self.assertEqual(project.ticketSystem, GitHub)
+
 
 class TestCommit(BaseTest):
     """

pyopensourceprojects-0.1.2/osprojects/__init__.py

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

pyopensourceprojects-0.1.2/scripts/doc

@@ -1,88 +0,0 @@
-#!/bin/bash
-# WF 2020-01-31
-
-#
-# check whether the given command is installed
-#
-checkinstalled() {
-  local l_cmd="$1"
-  which $l_cmd > /dev/null
-  if [ $? -ne 0 ]
-  then
-    echo "$l_cmd need to be installed" 1>&2
-    exit 1
-  fi
-}
-
-fixconf() {
-  local l_year="$1"
-  local l_author="$2"
-  conf=conf.py
-  # fix sys path
-  # https://stackoverflow.com/questions/10324393/sphinx-build-fail-autodoc-cant-import-find-module
-  grep "# sys.path" $conf
-  if [ $? -eq 0 ]
-  then
-    tmpconf=/tmp/conf$$.py
-    cat $conf | awk -v author="$l_author" -v year="$l_year" '
-    BEGIN {
-      quote="\x27"
-      squote="\047"
-    }
-    /# import os/ { next }
-    /# import sys/ { next }
-    /copyright/ {
-      printf "copyright = %s%s, %s%s\n",squote,year,author,squote
-      next
-    }
-    /author/ {
-      printf "author = %s%s%s\n",squote,author,squote
-      next
-    }
-    /html_theme = / {
-      # html_theme = 'alabaster'
-      printf "html_theme = %ssphinx_rtd_theme%s\n",squote,squote
-      printf "master_doc = %sindex%s\n",squote,squote
-      next
-    }
-    # add sphinx_rtd extension
-    /extensions = / {
-      print $0
-      printf "\t%ssphinx_rtd_theme%s,\n",squote,squote
-      printf "\t%ssphinx.ext.napoleon%s,\n",squote,squote
-      next
-    }
-    /# sys.path/ {
-      print("#https://stackoverflow.com/a/44980548/1497139")
-      print("import os")
-      print("import sys")
-      print("import sphinx_rtd_theme")
-      printf("basepath=os.path.abspath(%s../..%s)\n",squote,squote)
-      printf("print(%sadding basepath %%s%s %% (basepath))\n",squote,squote)
-      print("sys.path.insert(0, basepath)")
-      printf("print(%ssys.path is now: %%s%s %% (sys.path))\n",squote,squote)
-      next
-    }
-    { print }
-    END {
-      print ("#additional settings")
-      print ("#https://stackoverflow.com/a/5599712/1497139")
-      print ("autoclass_content = '\''both'\''")
-    }' > $tmpconf
-    #diff $tmpconf $conf
-    mv $tmpconf $conf
-    echo "$src/conf.py has been fixed"
-  fi
-}
-
-src=docs/source
-checkinstalled  sphinx-apidoc
-sphinx-apidoc --full -f -o $src .
-cd $src
-
-fixconf 2020-2021 "Wolfgang Fahl"
-make clean html
-if [ "$GHACTIONS" != "ACTIVE" ]
-then
-  open _build/html/index.html
-fi