pyOpenSourceProjects 0.3.0__tar.gz → 0.4.0__tar.gz

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/.github/workflows/build.yml

@@ -20,8 +20,8 @@ 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.10"]
+        #python-version: [ '3.11', '3.12', '3.13' ]
+        python-version: ["3.12"]
 
     steps:
     - uses: actions/checkout@v4

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyOpenSourceProjects
-Version: 0.3.0
+Version: 0.4.0
 Dynamic: Summary
 Project-URL: Home, https://github.com/WolfgangFahl/pyOpenSourceProjects
 Project-URL: Documentation, http://wiki.bitplan.com/index.php/pyOpenSourceProjects
@@ -10,14 +10,14 @@ 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-Python: >=3.11
+Requires-Dist: beautifulsoup4>=4.14.2
 Requires-Dist: gitpython
 Requires-Dist: packaging>=24.1
-Requires-Dist: py-3rdparty-mediawiki>=0.17.0
+Requires-Dist: py-3rdparty-mediawiki>=0.18.1
 Requires-Dist: pylodstorage>=0.17.0
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: requests
@@ -26,13 +26,15 @@ 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/) |
+| **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/) [![format](https://img.shields.io/pypi/format/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) [![downloads](https://img.shields.io/pypi/dd/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) |
+| **GitHub** | [![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml) [![Release](https://img.shields.io/github/v/release/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/releases) [![Contributors](https://img.shields.io/github/contributors/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/graphs/contributors) [![Last Commit](https://img.shields.io/github/last-commit/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/commits/) [![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) |
+| **Code** | [![style-black](https://img.shields.io/badge/%20style-black-000000.svg)](https://github.com/psf/black) [![imports-isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/) |
+| **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/) [![formatter-docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter) [![style-google](https://img.shields.io/badge/%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) |
 
 ## Documentation
 [Wiki](https://wiki.bitplan.com/index.php/PyOpenSourceProjects)

pyopensourceprojects-0.4.0/README.md

@@ -0,0 +1,17 @@
+# pyOpenSourceProjects
+
+Helper Library to organize open source Projects
+
+| | |
+| :--- | :--- |
+| **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/) [![format](https://img.shields.io/pypi/format/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) [![downloads](https://img.shields.io/pypi/dd/pyOpenSourceProjects)](https://pypi.org/project/pyOpenSourceProjects/) |
+| **GitHub** | [![Github Actions Build](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/pyOpenSourceProjects/actions/workflows/build.yml) [![Release](https://img.shields.io/github/v/release/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/releases) [![Contributors](https://img.shields.io/github/contributors/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/graphs/contributors) [![Last Commit](https://img.shields.io/github/last-commit/WolfgangFahl/pyOpenSourceProjects)](https://github.com/WolfgangFahl/pyOpenSourceProjects/commits/) [![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) |
+| **Code** | [![style-black](https://img.shields.io/badge/%20style-black-000000.svg)](https://github.com/psf/black) [![imports-isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/) |
+| **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://WolfgangFahl.github.io/pyOpenSourceProjects/) [![formatter-docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter) [![style-google](https://img.shields.io/badge/%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) |
+
+## 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.4.0/osprojects/__init__.py

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

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/osprojects/check_project.py

@@ -1,5 +1,4 @@
-"""
-Created on 2024-08-28
+"""Created on 2024-08-28.
 
 @author: wf
 """
@@ -13,10 +12,9 @@ from git import Repo
 from git.exc import InvalidGitRepositoryError, NoSuchPathError
 from packaging import version
 
-from osprojects.github_api import GitHubAction
-
 # original at ngwidgets - use redundant local copy ...
 from osprojects.editor import Editor
+from osprojects.github_api import GitHubAction
 
 
 @dataclass
@@ -42,9 +40,7 @@ class Check:
 
 
 class CheckProject:
-    """
-    Checker for an individual open source project
-    """
+    """Checker for an individual open source project."""
 
     def __init__(self, parent, project, args):
         self.parent = parent
@@ -101,14 +97,28 @@ class CheckProject:
         self.checks.append(path_exists)
         return path_exists
 
+    def generate_badge_markdown(self) -> str:
+        """Generate README.md badge table markup."""
+        project_name = self.project_name
+        owner = self.project.owner
+        project_id = self.project.project_id
+
+        markup= f"""| | |
+    | :--- | :--- |
+    | **PyPi** | [![PyPI Status](https://img.shields.io/pypi/v/{project_name}.svg)](https://pypi.python.org/pypi/{project_name}/) [![License](https://img.shields.io/github/license/{owner}/{project_id}.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![pypi](https://img.shields.io/pypi/pyversions/{project_name})](https://pypi.org/project/{project_name}/) [![format](https://img.shields.io/pypi/format/{project_name})](https://pypi.org/project/{project_name}/) [![downloads](https://img.shields.io/pypi/dd/{project_name})](https://pypi.org/project/{project_name}/) |
+    | **GitHub** | [![Github Actions Build](https://github.com/{owner}/{project_id}/actions/workflows/build.yml/badge.svg)](https://github.com/{owner}/{project_id}/actions/workflows/build.yml) [![Release](https://img.shields.io/github/v/release/{owner}/{project_id})](https://github.com/{owner}/{project_id}/releases) [![Contributors](https://img.shields.io/github/contributors/{owner}/{project_id})](https://github.com/{owner}/{project_id}/graphs/contributors) [![Last Commit](https://img.shields.io/github/last-commit/{owner}/{project_id})](https://github.com/{owner}/{project_id}/commits/) [![GitHub issues](https://img.shields.io/github/issues/{owner}/{project_id}.svg)](https://github.com/{owner}/{project_id}/issues) [![GitHub closed issues](https://img.shields.io/github/issues-closed/{owner}/{project_id}.svg)](https://github.com/{owner}/{project_id}/issues/?q=is%3Aissue+is%3Aclosed) |
+    | **Code** | [![style-black](https://img.shields.io/badge/%20style-black-000000.svg)](https://github.com/psf/black) [![imports-isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/) |
+    | **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://{owner}.github.io/{project_id}/) [![formatter-docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter) [![style-google](https://img.shields.io/badge/%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) |"""
+        return markup
+
+
+
     def check_local(self) -> Check:
         local = Check.file_exists(self.project_path)
         return local
 
     def check_github_workflows(self):
-        """
-        check the github workflow files
-        """
+        """Check the github workflow files."""
         workflows_path = os.path.join(self.project_path, ".github", "workflows")
         workflows_exist = self.add_path_check(workflows_path)
 
@@ -231,9 +241,7 @@ class CheckProject:
             )
 
     def check_pyproject_toml(self) -> bool:
-        """
-        pyproject.toml
-        """
+        """pyproject.toml."""
         toml_path = os.path.join(self.project_path, "pyproject.toml")
         toml_exists = self.add_path_check(toml_path)
         if toml_exists.ok:
@@ -274,8 +282,7 @@ class CheckProject:
         return toml_exists.ok
 
     def check_git(self) -> bool:
-        """
-        Check git repository information using GitHub class
+        """Check git repository information using GitHub class.
 
         Returns:
             bool: True if git owner matches project owner and the repo is not a fork
@@ -335,9 +342,7 @@ class CheckProject:
         return owner_match and not is_fork
 
     def check(self, title: str):
-        """
-        Check the given project and print results
-        """
+        """Check the given project and print results."""
         self.check_local()
         self.check_git()
         if self.check_pyproject_toml():

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/osprojects/checkos.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
-"""
-Created on 2024-07-30
+"""Created on 2024-07-30.
 
 @author: wf
 """
@@ -15,9 +14,7 @@ from osprojects.osproject import OsProjects
 
 
 class CheckOS:
-    """
-    checker for a set of open source projects
-    """
+    """Checker for a set of open source projects."""
 
     def __init__(
         self, args: Namespace, osprojects: OsProjects, max_python_version_minor=12
@@ -67,9 +64,8 @@ class CheckOS:
             self.osprojects.filter_projects(local_only=True)
 
     def check_projects(self):
-        """
-        Select, filter, and check all projects based on the provided arguments.
-        """
+        """Select, filter, and check all projects based on the provided
+        arguments."""
         self.select_projects()
         self.filter_projects()
 
@@ -78,6 +74,9 @@ class CheckOS:
         ):
             checker = CheckProject(self, project, self.args)
             checker.check(f"{i:3}:")
+            if self.args.badges:
+                print(checker.generate_badge_markdown())
+
 
     def handle_exception(self, ex: Exception):
         CheckOS.show_exception(ex, self.args.debug)
@@ -91,9 +90,7 @@ class CheckOS:
 
 
 def main(_argv=None):
-    """
-    main command line entry point
-    """
+    """Main command line entry point."""
     parser = argparse.ArgumentParser(description="Check open source projects")
     parser.add_argument(
         "-d",
@@ -101,6 +98,12 @@ def main(_argv=None):
         action="store_true",
         help="add debug output",
     )
+    parser.add_argument(
+        "-b",
+        "--badges",
+        action="store_true",
+        help="create and output standard README.md badges markup",
+    )
     parser.add_argument(
         "-e",
         "--editor",

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/osprojects/editor.py

@@ -1,5 +1,4 @@
-"""
-Created on 2022-11-27
+"""Created on 2022-11-27.
 
 @author: wf
 """
@@ -15,10 +14,10 @@ from bs4 import BeautifulSoup
 
 
 class Editor:
-    """
-    helper class to open the system defined editor
+    """Helper class to open the system defined editor.
 
-    see https://stackoverflow.com/questions/1442841/lauch-default-editor-like-webbrowser-module
+    see
+    https://stackoverflow.com/questions/1442841/lauch-default-editor-like-webbrowser-module
     """
 
     @classmethod
@@ -32,8 +31,7 @@ class Editor:
 
     @classmethod
     def extract_text(cls, html_text: str) -> str:
-        """
-        extract the text from the given html_text
+        """Extract the text from the given html_text.
 
         Args:
             html_text(str): the input for the html text
@@ -65,8 +63,7 @@ class Editor:
         extract_text: bool = True,
         default_editor_cmd: str = "/usr/local/bin/atom",
     ) -> str:
-        """
-        open an editor for the given file_source
+        """Open an editor for the given file_source.
 
         Args:
             file_source(str): the path to the file
@@ -104,8 +101,7 @@ class Editor:
 
     @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
+        """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

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/osprojects/github_api.py

@@ -1,5 +1,4 @@
-"""
-Created on 2024-08-27
+"""Created on 2024-08-27.
 
 @author: wf
 """
@@ -25,17 +24,13 @@ class GitHubApi:
 
     @classmethod
     def get_instance(cls) -> "GitHubApi":
-        """
-        singleton access
-        """
+        """Singleton access."""
         if cls.githubapi_instance is None:
             cls.githubapi_instance = cls()
         return cls.githubapi_instance
 
     def __init__(self):
-        """
-        constructor
-        """
+        """constructor."""
         home_dir = os.path.expanduser("~")
         self.base_dir = os.path.join(home_dir, ".github")
         os.makedirs(self.base_dir, exist_ok=True)
@@ -50,9 +45,8 @@ class GitHubApi:
         self.api_url = "https://api.github.com"
 
     def load_access_token(self) -> str:
-        """
-        if $HOME/.github/access_token.json exists read the token from there
-        """
+        """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(self.base_dir, "access_token.json")
 
@@ -66,8 +60,7 @@ class GitHubApi:
         return None
 
     def get_response(self, title: str, url: str, params={}, allow_redirects=True):
-        """
-        Get response from GitHub API or Google Docs API
+        """Get response from GitHub API or Google Docs API.
 
         Args:
             title (str): Description of the request
@@ -95,8 +88,8 @@ class GitHubApi:
         return response
 
     def repos_for_owner(self, owner: str, cache_expiry: int = 300) -> list[dict]:
-        """
-        Retrieve all repositories for the given owner, using cache if available and valid, or via API otherwise.
+        """Retrieve all repositories for the given owner, using cache if
+        available and valid, or via API otherwise.
 
         This method first checks if the repository data is available in the cache. If not, it fetches the
         data from the GitHub API and caches it for future use.
@@ -129,8 +122,7 @@ class GitHubApi:
     def repos_for_owner_from_cache(
         self, owner: str
     ) -> tuple[str, list[dict] | None, float | None]:
-        """
-        Retrieve repositories for the given owner from the cache.
+        """Retrieve repositories for the given owner from the cache.
 
         Args:
             owner (str): The username of the owner whose repositories are being retrieved.
@@ -154,8 +146,8 @@ class GitHubApi:
         return cache_file, cache_content, cache_age
 
     def repos_for_owner_via_api(self, owner: str) -> list[dict]:
-        """
-        Retrieve all repositories for the given owner directly from the GitHub API.
+        """Retrieve all repositories for the given owner directly from the
+        GitHub API.
 
         Args:
             owner (str): The username of the owner whose repositories are being retrieved.
@@ -187,8 +179,7 @@ class GitHubApi:
 
 @dataclass
 class GitHubRepo:
-    """
-    Represents a GitHub Repository
+    """Represents a GitHub Repository.
 
     Attributes:
         owner (str): The owner of the repository.
@@ -203,8 +194,7 @@ class GitHubRepo:
 
     @classmethod
     def from_url(cls, url: str) -> (str, str):
-        """
-        Resolve project url to owner and project name
+        """Resolve project url to owner and project name.
 
         Returns:
             (owner, project)
@@ -257,8 +247,8 @@ class GitHubRepo:
 
 @dataclass
 class GitHubAction:
-    """
-    Represents a GitHub Action with its identifying information and log content.
+    """Represents a GitHub Action with its identifying information and log
+    content.
 
     Attributes:
         repo (GitHubRepo): The repository associated with this action.
@@ -287,8 +277,8 @@ class GitHubAction:
 
     @classmethod
     def from_url(cls, url: str) -> "GitHubAction":
-        """
-        Create a GitHubAction instance from a GitHub Actions URL and fetch its logs.
+        """Create a GitHubAction instance from a GitHub Actions URL and fetch
+        its logs.
 
         Args:
             url (str): The GitHub Actions URL.
@@ -313,8 +303,7 @@ class GitHubAction:
 
     @classmethod
     def get_latest_workflow_run(cls, project):
-        """
-        Get the latest GitHub Actions workflow run for a given project.
+        """Get the latest GitHub Actions workflow run for a given project.
 
         Args:
             project (OsProject): The project to check for the latest workflow run.
@@ -331,9 +320,7 @@ class GitHubAction:
         return run
 
     def fetch_logs(self):
-        """
-        Fetch the logs for this GitHub Action.
-        """
+        """Fetch the logs for this GitHub Action."""
         if self.log_content is None:
             api_url = f"https://api.github.com/repos/{self.repo.owner}/{self.repo.project_id}/actions/jobs/{self.job_id}/logs"
             log_response = self.repo.github.get_response(
@@ -344,9 +331,7 @@ class GitHubAction:
                 self.save_logs()
 
     def save_logs(self):
-        """
-        Save the log content to a local file.
-        """
+        """Save the log content to a local file."""
         if self.log_content is None:
             raise ValueError("No log content to save. Make sure to fetch logs first.")
         with open(self.log_file, "w", encoding="utf-8") as f:

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/osprojects/osproject.py

@@ -1,5 +1,4 @@
-"""
-Created on 2022-01-24
+"""Created on 2022-01-24.
 
 @author: wf
 """
@@ -21,9 +20,7 @@ from osprojects.github_api import GitHubApi, GitHubRepo
 
 
 class Ticket(object):
-    """
-    a Ticket
-    """
+    """A Ticket."""
 
     @staticmethod
     def getSamples():
@@ -46,18 +43,14 @@ class Ticket(object):
 
     @classmethod
     def init_from_dict(cls, **records):
-        """
-        inits Ticket from given args
-        """
+        """Inits Ticket from given args."""
         issue = Ticket()
         for k, v in records.items():
             setattr(issue, k, v)
         return issue
 
     def toWikiMarkup(self) -> str:
-        """
-        Returns Ticket in wiki markup
-        """
+        """Returns Ticket in wiki markup."""
         return f"""# {{{{Ticket
 |number={self.number}
 |title={self.title}
@@ -69,9 +62,7 @@ class Ticket(object):
 
 
 class Commit(object):
-    """
-    a commit
-    """
+    """A commit."""
 
     @staticmethod
     def getSamples():
@@ -89,9 +80,7 @@ class Commit(object):
         return samples
 
     def toWikiMarkup(self):
-        """
-        Returns Commit as wiki markup
-        """
+        """Returns Commit as wiki markup."""
         params = [
             f"{attr}={getattr(self, attr, '')}" for attr in self.getSamples()[0].keys()
         ]
@@ -100,14 +89,10 @@ class Commit(object):
 
 
 class OsProjects:
-    """
-    a set of open source projects
-    """
+    """A set of open source projects."""
 
     def __init__(self):
-        """
-        constructor
-        """
+        """constructor."""
         self.projects = {}
         self.projects_by_url = {}
         self.local_projects = {}
@@ -124,8 +109,7 @@ class OsProjects:
             self.selected_projects[project.projectUrl()] = project
 
     def select_projects(self, owners=None, project_id=None, local_only=False):
-        """
-        Select projects based on given criteria.
+        """Select projects based on given criteria.
 
         Args:
             owners (Optional[list[str]]): The owners of the projects to select.
@@ -169,8 +153,7 @@ class OsProjects:
         return self.selected_projects
 
     def filter_projects(self, language=None, local_only=False):
-        """
-        Filter the selected projects based on language and locality.
+        """Filter the selected projects based on language and locality.
 
         Args:
             language (str, optional): The programming language to filter by.
@@ -197,9 +180,7 @@ class OsProjects:
         return self.selected_projects
 
     def add_projects_of_owner(self, owner: str, cache_expiry: int = 300):
-        """
-        add the projects of the given owner
-        """
+        """Add the projects of the given owner."""
         if not owner in self.projects:
             self.projects[owner] = {}
             repo_infos = self.github.repos_for_owner(owner, cache_expiry)
@@ -222,8 +203,7 @@ class OsProjects:
 
     @classmethod
     def get_project_url_from_git_config(cls, project_path: str) -> Optional[str]:
-        """
-        Get the project URL from the git config file.
+        """Get the project URL from the git config file.
 
         Args:
             project_path (str): The path to the project directory.
@@ -248,8 +228,7 @@ class OsProjects:
 
     @classmethod
     def from_folder(cls, folder_path: str, with_progress: bool = False) -> "OsProjects":
-        """
-        Collect all github projects from the given folders.
+        """Collect all github projects from the given folders.
 
         Args:
             folder_path (str): The path to the folder containing projects.
@@ -285,8 +264,7 @@ class OsProjects:
     def github_repos_of_folder(
         cls, folder_path: str
     ) -> Tuple[Set[str], Dict[str, GitHubRepo]]:
-        """
-        Collect GitHub repositories from a given folder.
+        """Collect GitHub repositories from a given folder.
 
         Args:
             folder_path (str): The path to the folder to search for repositories.
@@ -316,9 +294,7 @@ class OsProjects:
 
 
 class OsProject:
-    """
-    a GitHub based opens source project
-    """
+    """A GitHub based opens source project."""
 
     def __init__(self, owner: str = None, project_id: str = None):
         self.repo_info = None  # might be fetched
@@ -328,9 +304,7 @@ class OsProject:
 
     @classmethod
     def fromUrl(cls, url: str) -> "OsProject":
-        """
-        Init OsProject from given url
-        """
+        """Init OsProject from given url."""
         if "github.com" in url:
             os_project = cls()
             os_project.repo = GitHubRepo.from_url(url)
@@ -340,12 +314,10 @@ class OsProject:
 
     @classmethod
     def fromRepo(cls):
-        """
-        Init OsProject from repo in current working directory
-        """
+        """Init OsProject from repo in current working directory."""
         url = subprocess.check_output(["git", "config", "--get", "remote.origin.url"])
         url = url.decode().strip("\n")
-        repo= cls.fromUrl(url)
+        repo = cls.fromUrl(url)
         return repo
 
     def getIssues(self, limit: int = None, **params) -> List[Ticket]:
@@ -402,9 +374,7 @@ class OsProject:
         return tickets_dict
 
     def getComments(self, issue_number: int) -> List[dict]:
-        """
-        Fetch all comments for a specific issue number from GitHub.
-        """
+        """Fetch all comments for a specific issue number from GitHub."""
         comments_url = self.commentUrl(issue_number)
         response = self.get_response("fetch comments", comments_url)
         return response.json()
@@ -416,9 +386,7 @@ class OsProject:
         return f"{self.projectUrl()}/commit/{commit_id}"
 
     def commentUrl(self, issue_number: int):
-        """
-        Construct the URL for accessing comments of a specific issue.
-        """
+        """Construct the URL for accessing comments of a specific issue."""
         return f"{self.repo.github.api_url}/repos/{self.repo.owner}/{self.repo.project_id}/issues/{issue_number}/comments"
 
     @property
@@ -530,9 +498,7 @@ class OsProject:
 
 
 def gitlog2wiki(_argv=None):
-    """
-    cmdline interface to get gitlog entries in wiki markup
-    """
+    """Cmdline interface to get gitlog entries in wiki markup."""
     parser = argparse.ArgumentParser(description="gitlog2wiki")
     if _argv:
         _args = parser.parse_args(args=_argv)
@@ -543,9 +509,7 @@ def gitlog2wiki(_argv=None):
 
 
 def main(_argv=None):
-    """
-    main command line entry point
-    """
+    """Main command line entry point."""
     parser = argparse.ArgumentParser(description="Issue2ticket")
     parser.add_argument("-o", "--owner", help="project owner")
     parser.add_argument("-p", "--project", help="name of the project")

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/pyproject.toml

@@ -15,13 +15,15 @@ readme = "README.md"
 license = "Apache-2.0"
 
 dependencies = [
+  # https://pypi.org/project/beautifulsoup4/
+  "beautifulsoup4>=4.14.2",
   # https://pypi.org/project/GitPython/
   "gitpython",
   # https://pypi.org/project/requests/
   "requests",
   "pyLodStorage>=0.17.0",
   # https://pypi.org/project/py-3rdparty-mediawiki/
-  'py-3rdparty-mediawiki>=0.17.0',
+  'py-3rdparty-mediawiki>=0.18.1',
   # https://pypi.org/project/python-dateutil/
   "python-dateutil>=2.8.2",
   # https://github.com/pypa/packaging
@@ -29,11 +31,10 @@ dependencies = [
   # https://pypi.org/project/tqdm/
   "tqdm>=4.66.5"
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 
 classifiers = [
   "Programming Language :: Python",
-  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13"

pyopensourceprojects-0.4.0/scripts/blackisort

@@ -0,0 +1,15 @@
+#!/bin/bash
+# WF 2024-01-10
+package=osprojects
+
+# Sort imports
+isort tests/*.py
+isort $package/*.py
+
+# Format code
+black tests/*.py
+black $package/*.py
+
+# Format docstrings
+docformatter --in-place tests/*.py
+docformatter --in-place $package/*.py

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/tests/basetest.py

@@ -1,5 +1,4 @@
-"""
-Created on 2021-08-19
+"""Created on 2021-08-19.
 
 @author: wf
 """
@@ -15,14 +14,10 @@ from unittest import TestCase
 
 
 class BaseTest(TestCase):
-    """
-    base test case
-    """
+    """Base test case."""
 
     def setUp(self, debug=False, profile=True):
-        """
-        setUp test environment
-        """
+        """SetUp test environment."""
         TestCase.setUp(self)
         self.debug = debug
         self.profile = profile
@@ -35,9 +30,7 @@ class BaseTest(TestCase):
 
     @staticmethod
     def inPublicCI():
-        """
-        are we running in a public Continuous Integration Environment?
-        """
+        """Are we running in a public Continuous Integration Environment?"""
         publicCI = getpass.getuser() in ["travis", "runner"]
         jenkins = "JENKINS_HOME" in os.environ
         return publicCI or jenkins
@@ -71,8 +64,7 @@ class BaseTest(TestCase):
 
     @staticmethod
     def captureOutput(fn: Callable, *args, **kwargs) -> str:
-        """
-        Captures stdout put of the given function
+        """Captures stdout put of the given function.
 
         Args:
             fn(callable): function to call
@@ -93,13 +85,10 @@ if __name__ == "__main__":
 
 
 class Profiler:
-    """
-    simple profiler
-    """
+    """Simple profiler."""
 
     def __init__(self, msg, profile=True):
-        """
-        construct me with the given msg and profile active flag
+        """Construct me with the given msg and profile active flag.
 
         Args:
             msg(str): the message to show if profiling is active
@@ -112,9 +101,7 @@ class Profiler:
             print(f"Starting {msg} ...")
 
     def time(self, extraMsg=""):
-        """
-        time the action and print if profile is active
-        """
+        """Time the action and print if profile is active."""
         elapsed = time.time() - self.starttime
         if self.profile:
             print(f"{self.msg}{extraMsg} took {elapsed:5.1f} s")

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/tests/test_github.py

@@ -1,5 +1,4 @@
-"""
-Created on 2024-08-27
+"""Created on 2024-08-27.
 
 @author: wf
 """
@@ -12,17 +11,13 @@ from tests.basetest import BaseTest
 
 
 class TestGitHub(BaseTest):
-    """
-    tests GitHub class
-    """
+    """Tests GitHub class."""
 
     def setUp(self, debug=True, profile=True):
         BaseTest.setUp(self, debug=debug, profile=profile)
 
     def test_GitHubRepo_from_url(self):
-        """
-        tests the creating GitHubRepos from the project url
-        """
+        """Tests the creating GitHubRepos from the project url."""
         urlCases = [
             {
                 "owner": "WolfgangFahl",
@@ -49,9 +44,7 @@ class TestGitHub(BaseTest):
                 self.assertEqual(expectedProject, github_repo.project_id)
 
     def testOsProjects(self):
-        """
-        tests the list_projects_as_os_projects method
-        """
+        """Tests the list_projects_as_os_projects method."""
         owner = "WolfgangFahl"
         project_id = "pyOpenSourceProjects"
         osprojects = OsProjects.from_owners([owner])
@@ -105,9 +98,7 @@ class TestGitHub(BaseTest):
         "Tests querying wikidata which is often blocked on public CI",
     )
     def test_projects_from_folder(self):
-        """
-        test projects from a specific folder
-        """
+        """Test projects from a specific folder."""
         debug = self.debug
         # debug=True
         home_dir = os.path.expanduser("~")
@@ -117,4 +108,4 @@ class TestGitHub(BaseTest):
         if debug:
             print(f"found {count} local projects")
         self.assertTrue(count > 30)
-        pass
+        pass

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/tests/test_github_api.py

@@ -1,5 +1,4 @@
-"""
-Created on 2024-08-27
+"""Created on 2024-08-27.
 
 @author: wf
 """
@@ -12,18 +11,15 @@ from tests.basetest import BaseTest
 
 
 class TestGitHubApi(BaseTest):
-    """
-    test the GithHubApi functionalities
-    """
+    """Test the GithHubApi functionalities."""
 
     def setUp(self, debug=False, profile=True):
         BaseTest.setUp(self, debug=debug, profile=profile)
         self.github = GitHubApi.get_instance()
 
     def test_repos_for_owner(self):
-        """
-        Test the repos_for_owner method for two owners, with caching in between.
-        """
+        """Test the repos_for_owner method for two owners, with caching in
+        between."""
         owners = ["WolfgangFahl", "BITPlan"]
         cache_expiry = 300  # 5 minutes
 
@@ -45,9 +41,7 @@ class TestGitHubApi(BaseTest):
 
     @unittest.skipIf(BaseTest.inPublicCI(), "missing admin rights in public CI")
     def test_github_action_from_url(self):
-        """
-        Test creating GitHubAction instances from URLs.
-        """
+        """Test creating GitHubAction instances from URLs."""
         test_cases = [
             (
                 "single_failure",

{pyopensourceprojects-0.3.0 → pyopensourceprojects-0.4.0}/tests/test_osproject.py

@@ -1,22 +1,22 @@
-"""
-Created on 2022-01-24
+"""Created on 2022-01-24.
 
 @author: wf
 """
 
+from argparse import Namespace
+
+from osprojects.check_project import CheckProject
 from osprojects.osproject import Commit, OsProject, Ticket, gitlog2wiki, main
+
 from tests.basetest import BaseTest
 
 
 class TestOsProject(BaseTest):
-    """
-    test the OsProject concepts
-    """
+    """Test the OsProject concepts."""
 
     def testOsProject(self):
-        """
-        tests if the projects details, commits and issues/tickets are correctly queried
-        """
+        """Tests if the projects details, commits and issues/tickets are
+        correctly queried."""
         osProject = OsProject(owner="WolfgangFahl", project_id="pyOpenSourceProjects")
         tickets = osProject.getAllTickets()
         sampleTicket = self.getSampleById(Ticket, "number", 2)
@@ -33,10 +33,25 @@ class TestOsProject(BaseTest):
         self.assertEqual(ticket2.project, sampleTicket.project)
         pass
 
+    def testBadgeMarkdown(self):
+        """Tests badge markdown generation."""
+        osProject = OsProject(owner="WolfgangFahl", project_id="pyOpenSourceProjects")
+
+        args = Namespace(badges=True, debug=False, editor=False)
+        checker = CheckProject(parent=None, project=osProject, args=args)
+        checker.project_name = "pyOpenSourceProjects"
+
+        markup = checker.generate_badge_markdown()
+
+        self.assertIn("| **PyPi** |", markup)
+        self.assertIn("| **GitHub** |", markup)
+        self.assertIn("| **Code** |", markup)
+        self.assertIn("| **Docs** |", markup)
+        self.assertIn("[![PyPI Status]", markup)
+        self.assertIn("WolfgangFahl/pyOpenSourceProjects", markup)
+
     def testGetCommits(self):
-        """
-        tests extraction of commits for a repository
-        """
+        """Tests extraction of commits for a repository."""
         if self.inPublicCI():
             return
         osProject = OsProject(owner="WolfgangFahl", project_id="pyOpenSourceProjects")
@@ -46,9 +61,7 @@ class TestOsProject(BaseTest):
         self.assertDictEqual(expectedCommit.__dict__, commits[0].__dict__)
 
     def testCmdLine(self):
-        """
-        tests cmdline of osproject
-        """
+        """Tests cmdline of osproject."""
         testParams = [
             ["-o", "WolfgangFahl", "-p", "pyOpenSourceProjects"],
             ["--repo"],
@@ -59,9 +72,7 @@ class TestOsProject(BaseTest):
             self.assertIn("{{Ticket", output)
 
     def testGitlog2IssueCmdline(self):
-        """
-        tests gitlog2issue
-        """
+        """Tests gitlog2issue."""
         if self.inPublicCI():
             return
         commit = self.getSampleById(Commit, "hash", "106254f")
@@ -72,14 +83,10 @@ class TestOsProject(BaseTest):
 
 
 class TestCommit(BaseTest):
-    """
-    Tests Commit class
-    """
+    """Tests Commit class."""
 
     def testToWikiMarkup(self):
-        """
-        tests toWikiMarkup
-        """
+        """Tests toWikiMarkup."""
         commit = self.getSampleById(Commit, "hash", "106254f")
         expectedMarkup = "{{commit|host=https://github.com/WolfgangFahl/pyOpenSourceProjects|path=|project=pyOpenSourceProjects|subject=Initial commit|name=GitHub|date=2022-01-24 07:02:55+01:00|hash=106254f|storemode=subobject|viewmode=line}}"
         self.assertEqual(expectedMarkup, commit.toWikiMarkup())

pyopensourceprojects-0.3.0/README.md

@@ -1,15 +0,0 @@
-# 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

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

pyopensourceprojects-0.3.0/scripts/blackisort

@@ -1,7 +0,0 @@
-#!/bin/bash
-# WF 2024-01-10
-package=osprojects
-isort tests/*.py
-black tests/*.py
-isort $package/*.py
-black $package/*.py