pyOpenSourceProjects 0.4.1__tar.gz → 0.5.1__tar.gz

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/.github/workflows/build.yml

@@ -20,13 +20,13 @@ jobs:
       matrix:
         #os: [ubuntu-latest, macos-latest, windows-latest]
         os: [ubuntu-latest]
-        #python-version: [ '3.11', '3.12', '3.13' ]
-        python-version: ["3.12"]
+        #python-version: [ '3.10', '3.11', '3.12', '3.13' ]
+        python-version: ["3.10"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/.github/workflows/upload-to-pypi.yml

@@ -11,9 +11,9 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: '3.x'
     - name: Install dependencies

pyopensourceprojects-0.5.1/AGENTS.md

@@ -0,0 +1,210 @@
+# Agent Guidelines for pyOpenSourceProjects
+
+This file provides guidelines and commands for agentic coding agents working in this repository.
+
+## Project Overview
+
+Python library for checking open source projects for standard compliance (README, GitHub workflow, pyproject.toml). Creates badges for projects.
+
+- **Main package**: `osprojects/`
+- **Tests**: `tests/`
+- **Python**: 3.10+
+
+## Build & Installation
+
+```bash
+# Install package in development mode
+pip install . -U
+
+# Install with test dependencies
+pip install . -U[test]
+```
+
+## Testing
+
+### Run All Tests
+
+```bash
+# Using unittest discover (default)
+python3 -m unittest discover
+
+# Using the test script
+./scripts/test
+```
+
+### Run Single Test
+
+```bash
+# Run a specific test file
+python -m unittest tests.test_github
+
+# Run a specific test class
+python -m unittest tests.test_github.GitHubTest
+
+# Run a specific test method
+python -m unittest tests.test_github.GitHubTest.test_example
+
+# Module-wise testing (runs each test file separately)
+./scripts/test --module
+```
+
+### Other Test Runners
+
+```bash
+# Using green
+./scripts/test --green
+
+# Using tox
+./scripts/test --tox
+```
+
+## Code Formatting
+
+This project uses multiple formatters. Run all before committing:
+
+```bash
+# Format code with black, sort imports with isort, format docstrings with docformatter
+./scripts/blackisort
+```
+
+Individual commands:
+```bash
+# Sort imports
+isort tests/*.py osprojects/*.py
+
+# Format code
+black tests/*.py osprojects/*.py
+
+# Format docstrings
+docformatter --in-place tests/*.py osprojects/*.py
+```
+
+## Code Style Guidelines
+
+### General
+
+- Follow [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
+- Use type hints where appropriate
+- Maximum line length: 88 characters (Black default)
+
+### Imports
+
+- Use `isort` for import sorting
+- Order: standard library, third-party, local
+- Example:
+```python
+import os
+import time
+from typing import Any, Optional
+
+import requests
+from git import Repo
+
+from osprojects import __version__
+from osprojects.github_api import GitHubAPI
+```
+
+### Docstrings
+
+- Use Google-style docstrings
+- Run `docformatter` before committing
+- Example:
+```python
+def fetch_data(url: str, timeout: int = 30) -> dict:
+    """Fetch data from the given URL.
+
+    Args:
+        url: The URL to fetch data from.
+        timeout: Request timeout in seconds.
+
+    Returns:
+        A dictionary containing the response data.
+
+    Raises:
+        requests.RequestException: If the request fails.
+    """
+```
+
+### Naming Conventions
+
+- **Functions/methods**: `snake_case` (e.g., `fetch_data`, `get_project_info`)
+- **Classes**: `PascalCase` (e.g., `GitHubAPI`, `ProjectChecker`)
+- **Constants**: `UPPER_SNAKE_CASE` (e.g., `DEFAULT_TIMEOUT`, `API_VERSION`)
+- **Private methods**: prefix with `_` (e.g., `_internal_method`)
+
+### Error Handling
+
+- Use specific exception types
+- Include informative error messages
+- Example:
+```python
+try:
+    result = api.request(endpoint)
+except requests.RequestException as e:
+    raise APIError(f"Failed to fetch {endpoint}: {e}") from e
+```
+
+### Testing Guidelines
+
+- Test files: `tests/test_*.py`
+- Test classes: `Test*` (e.g., `GitHubTest`)
+- Test methods: `test_*` (e.g., `test_fetch_projects`)
+- Use the `BaseTest` class from `tests/basetest.py` for common functionality
+- Include docstrings in tests explaining what is being tested
+
+### Type Hints
+
+- Use type hints for function signatures
+- Prefer `Optional[X]` over `X | None`
+- Use `Any` sparingly
+- Example:
+```python
+def process_items(items: list[dict], filter_key: str) -> Optional[list[str]]:
+    """Process items and return filtered values."""
+    values = [item.get(filter_key) for item in items if filter_key in item]
+    return values if values else None
+```
+
+## Version Bumping
+
+The package version is stored in `osprojects/__init__.py` and mirrored in `osprojects/version.py`.
+
+To bump the version:
+
+1. Edit `osprojects/__init__.py` and update `__version__`
+2. Edit `osprojects/version.py` and update the `version`, `updated` fields in the `Version` class
+
+```python
+# osprojects/__init__.py
+__version__ = "0.5.1"
+
+# osprojects/version.py  — Version class fields to update:
+version = osprojects.__version__   # reads from __init__.py automatically
+updated = "2026-02-22"             # set to today's date
+```
+
+Then run formatters, tests, commit and push (or use `scripts/release`).
+
+## Git Workflow
+
+1. Create a feature branch
+2. Make changes following the code style guidelines
+3. Run formatters: `./scripts/blackisort`
+4. Run tests: `./scripts/test`
+5. Commit with a descriptive message
+6. Push and create a pull request
+
+## Release
+
+```bash
+# Builds docs and commits + pushes
+./scripts/release
+```
+
+## CLI Commands
+
+The package provides these CLI entry points:
+
+- `checkos`: Main CLI for checking open source projects
+- `issue2ticket`: Convert issues to tickets
+- `gitlog2wiki`: Convert git log to wiki format

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pyOpenSourceProjects
-Version: 0.4.1
-Dynamic: Summary
+Version: 0.5.1
+Summary: Check python OpenSource Projects to follow standards for README, github workflow and pyprojec.toml - creates badges
 Project-URL: Home, https://github.com/WolfgangFahl/pyOpenSourceProjects
 Project-URL: Documentation, http://wiki.bitplan.com/index.php/pyOpenSourceProjects
 Project-URL: Source, https://github.com/WolfgangFahl/pyOpenSourceProjects
@@ -10,17 +10,21 @@ 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.11
+Requires-Python: >=3.10
+Requires-Dist: backoff
 Requires-Dist: beautifulsoup4>=4.14.2
 Requires-Dist: gitpython
 Requires-Dist: packaging>=24.1
 Requires-Dist: py-3rdparty-mediawiki>=0.18.1
 Requires-Dist: pylodstorage>=0.17.0
 Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: ratelimit>=2.2.1
 Requires-Dist: requests
+Requires-Dist: tomli>=2.3.0; python_version < '3.11'
 Requires-Dist: tqdm>=4.66.5
 Provides-Extra: test
 Description-Content-Type: text/markdown

pyopensourceprojects-0.5.1/osprojects/__init__.py

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

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/osprojects/check_project.py

@@ -4,7 +4,7 @@
 """
 
 import os
-import tomllib
+import sys
 from dataclasses import dataclass
 from typing import List
 
@@ -103,7 +103,7 @@ class CheckProject:
         owner = self.project.owner
         project_id = self.project.project_id
 
-        markup= f"""| | |
+        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) |
@@ -111,8 +111,6 @@ class CheckProject:
     | **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
@@ -140,7 +138,7 @@ class CheckProject:
                             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)])} ]"""
+                        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,
@@ -152,11 +150,11 @@ class CheckProject:
                             file_path,
                         )
                         self.add_content_check(
-                            content, "uses: actions/checkout@v4", file_path
+                            content, "uses: actions/checkout@v6", file_path
                         )
                         self.add_content_check(
                             content,
-                            "uses: actions/setup-python@v5",
+                            "uses: actions/setup-python@v6",
                             file_path,
                         )
 
@@ -173,11 +171,11 @@ class CheckProject:
                     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
+                            content, "uses: actions/checkout@v6", file_path
                         )
                         self.add_content_check(
                             content,
-                            "uses: actions/setup-python@v5",
+                            "uses: actions/setup-python@v6",
                             file_path,
                         )
                         self.add_content_check(
@@ -240,13 +238,13 @@ class CheckProject:
                 readme_content, "readthedocs", readme_path, negative=True
             )
 
-    def check_pyproject_toml(self) -> bool:
-        """pyproject.toml."""
+    def check_pyproject_toml_vialib(self, toml_module) -> bool:
+        """Check pyproject.toml using the given toml_module."""
         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)
+            toml_dict = toml_module.loads(content)
             project_check = self.add_check(
                 "project" in toml_dict, "[project]", toml_path
             )
@@ -281,6 +279,25 @@ class CheckProject:
             )
         return toml_exists.ok
 
+    def check_pyproject_toml_py311(self) -> bool:
+        """Python 3.11+ implementation (uses stdlib tomllib)."""
+        import tomllib
+
+        return self.check_pyproject_toml_vialib(tomllib)
+
+    def check_pyproject_toml_py310(self) -> bool:
+        """Python 3.10 implementation (uses third-party tomli)."""
+        import tomli as tomllib  # @UnresolvedImport
+
+        return self.check_pyproject_toml_vialib(tomllib)
+
+    def check_pyproject_toml(self) -> bool:
+        """Delegator that picks the correct implementation based on Python
+        version."""
+        if sys.version_info >= (3, 11):
+            return self.check_pyproject_toml_py311()
+        return self.check_pyproject_toml_py310()
+
     def check_git(self) -> bool:
         """Check git repository information using GitHub class.
 

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/osprojects/checkos.py

@@ -3,6 +3,7 @@
 
 @author: wf
 """
+
 import argparse
 import logging
 import os
@@ -29,7 +30,11 @@ class CheckOS:
 
     @classmethod
     def from_args(cls, args: Namespace):
-        osprojects = OsProjects.from_folder(args.workspace, with_progress=True)
+        # Optimize: if --project and --local are both specified, pass project_id to avoid scanning all owners
+        project_id = args.project if (args.project and args.local) else None
+        osprojects = OsProjects.from_folder(
+            args.workspace, with_progress=True, project_id=project_id
+        )
         return cls(args, osprojects)
 
     def select_projects(self):
@@ -77,7 +82,6 @@ class CheckOS:
             if self.args.badges:
                 print(checker.generate_badge_markdown())
 
-
     def handle_exception(self, ex: Exception):
         CheckOS.show_exception(ex, self.args.debug)
 

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/osprojects/github_api.py

@@ -1,6 +1,14 @@
 """Created on 2024-08-27.
 
 @author: wf
+
+Request limits
+see https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28
+
+    Authenticated Requests (Core API): 5,000 requests per hour.
+    Unauthenticated Requests (Core API): 60 requests per hour.
+    Search API (Authenticated): 30 requests per minute.
+    Search API (Unauthenticated): 10 requests per minute.
 """
 
 import json
@@ -8,10 +16,14 @@ import os
 import re
 import time
 from dataclasses import dataclass, field
-from typing import Dict, List
+from datetime import datetime
+from typing import Dict, List, Optional
 from urllib.parse import urlparse
 
 import requests
+from backoff import expo, on_exception
+from basemkit.yamlable import lod_storable
+from ratelimit import RateLimitException, limits
 
 
 class GitHubApi:
@@ -31,8 +43,8 @@ class GitHubApi:
 
     def __init__(self):
         """constructor."""
-        home_dir = os.path.expanduser("~")
-        self.base_dir = os.path.join(home_dir, ".github")
+        self.home_dir = os.path.expanduser("~")
+        self.base_dir = os.path.join(self.home_dir, ".github")
         os.makedirs(self.base_dir, exist_ok=True)
         self.cache_dir = os.path.join(self.base_dir, "cache")
         os.makedirs(self.cache_dir, exist_ok=True)
@@ -44,21 +56,28 @@ class GitHubApi:
         )
         self.api_url = "https://api.github.com"
 
+    def get_cache_path(self, file_name: str):
+        """Get the cache path for the given file_name."""
+        cache_path = os.path.join(self.cache_dir, file_name)
+        return cache_path
+
     def load_access_token(self) -> 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(self.base_dir, "access_token.json")
-
+        token = None
         # 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:
                 token_data = json.load(token_file)
-                return token_data.get("access_token")
+                token = token_data.get("access_token")
 
         # Return None if no token file is found
-        return None
+        return token
 
+    @on_exception(expo, RateLimitException, max_tries=8)
+    @limits(calls=5000, period=3600)
     def get_response(self, title: str, url: str, params={}, allow_redirects=True):
         """Get response from GitHub API or Google Docs API.
 
@@ -83,6 +102,9 @@ class GitHubApi:
             err_msg = (
                 f"Failed to {title} for {url}: {response.status_code} - {response.text}"
             )
+            # Raise RateLimitException explicitly if server returns 429 or 403 to trigger backoff
+            if response.status_code in [403, 429]:
+                raise RateLimitException(err_msg, period_remaining=60)
             raise Exception(err_msg)
 
         return response
@@ -245,6 +267,121 @@ class GitHubRepo:
         return all_issues_records
 
 
+@lod_storable
+class GitHubFile:
+    """A single Github file."""
+
+    repo_name: str
+    path: str
+    sha: str
+    html_url: str
+    # Note: Code Search API does not return a date.
+    # We add this field here so it can be populated later if we do specific lookups.
+    created_at: Optional[datetime] = None
+
+    @property
+    def month_key(self) -> str:
+        """Returns 'YYYY-MM' or 'Unknown'."""
+        month_key = None
+        if self.created_at:
+            month_key = self.created_at.strftime("%Y-%m")
+        return month_key
+
+
+@lod_storable
+class GitHubFileSet:
+    """A set of GitHubFiles."""
+
+    # map files by sha
+    files: Dict[str, GitHubFile] = field(default_factory=dict)
+    _sha_set: set = field(default_factory=set)
+
+    def add(self, api_item: dict) -> Optional[GitHubFile]:
+        """Parses a raw API item and adds it to cache if unique.
+
+        Returns the item if added, None if duplicate.
+        """
+        gh_file = None
+        sha = api_item.get("sha")
+
+        # Deduplication check
+        if sha and not sha in self._sha_set:
+
+            # Extract fields
+            repo_info = api_item.get("repository", {})
+
+            # Attempt to find date (usually not in search/code results, but parsing if present)
+            date_obj = None
+            raw_date = repo_info.get("created_at")
+            if raw_date:
+                try:
+                    date_obj = datetime.fromisoformat(raw_date.replace("Z", "+00:00"))
+                except ValueError:
+                    pass
+
+            # Create the instance
+            gh_file = GitHubFile(
+                repo_name=repo_info.get("full_name", "unknown/repo"),
+                path=api_item.get("path", ""),
+                sha=sha,
+                html_url=api_item.get("html_url", ""),
+                created_at=date_obj,
+            )
+
+            # Store in dict
+            self.files[sha] = gh_file
+            self._sha_set.add(sha)
+
+        return gh_file
+
+    @classmethod
+    def from_query(
+        cls, query: str, limit: int = 1000, verbose: bool = False
+    ) -> "GitHubFileSet":
+        """Factory function to query GitHub Code Search and populate a
+        GitHubFileSet.
+
+        Handles pagination and rate limiting.
+        """
+        github_api = GitHubApi.get_instance()
+        file_set = GitHubFileSet()
+        per_page = 100
+
+        # Calculate max pages (API usually limits code search results to 1000)
+        max_pages = (limit // per_page) + 1
+
+        if verbose:
+            print(f"Searching up to {limit} files for query: {query}")
+
+        for page in range(1, max_pages + 1):
+            if len(file_set.files) >= limit:
+                break
+
+            url = "https://api.github.com/search/code"
+            params = {"q": query, "per_page": per_page, "page": page}
+
+            try:
+                # Using the existing github_api instance passed in
+                response = github_api.get_response("search code", url, params=params)
+                search_data = response.json()
+
+                items = search_data.get("items", [])
+                if not items:
+                    break
+
+                for item in items:
+                    file_set.add(item)
+
+                # Sleep to respect rate limits
+                time.sleep(2.0)
+
+            except Exception as e:
+                print(f"Error fetching page {page}: {e}")
+                break
+
+        return file_set
+
+
 @dataclass
 class GitHubAction:
     """Represents a GitHub Action with its identifying information and log

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/osprojects/osproject.py

@@ -227,12 +227,18 @@ class OsProjects:
         return url
 
     @classmethod
-    def from_folder(cls, folder_path: str, with_progress: bool = False) -> "OsProjects":
+    def from_folder(
+        cls,
+        folder_path: str,
+        with_progress: bool = False,
+        project_id: Optional[str] = None,
+    ) -> "OsProjects":
         """Collect all github projects from the given folders.
 
         Args:
             folder_path (str): The path to the folder containing projects.
             with_progress (bool): Whether to display a progress bar. Defaults to True.
+            project_id (Optional[str]): If specified, optimize for finding this specific project.
 
         Returns:
             OsProjects: An instance of OsProjects with collected projects.
@@ -240,16 +246,37 @@ class OsProjects:
         osp = cls()
         owners, repos_by_folder = cls.github_repos_of_folder(folder_path)
 
+        # Optimization: If a specific project_id is requested, only fetch data for relevant owners
+        if project_id:
+            # Find which owner(s) have this project locally
+            relevant_owners = set()
+            for folder, repo in repos_by_folder.items():
+                if repo.project_id == project_id:
+                    relevant_owners.add(repo.owner)
+
+            # Only process relevant owners (no need for progress bar when optimized)
+            if relevant_owners:
+                owners_to_process = relevant_owners
+                # Don't show progress bar for optimized single-project lookup
+                with_progress = False
+            else:
+                # Project not found locally, fall back to processing all owners
+                owners_to_process = owners
+        else:
+            owners_to_process = owners
+
         def process_owners(owners_iterable: Iterable[str]):
             for owner in owners_iterable:
                 osp.add_projects_of_owner(owner)
 
         if with_progress:
-            process_owners(tqdm(owners, desc="Processing owners"))
+            process_owners(tqdm(owners_to_process, desc="Processing owners"))
         else:
-            process_owners(owners)
+            process_owners(owners_to_process)
 
         for folder, repo in repos_by_folder.items():
+            if project_id and repo.project_id != project_id:
+                continue
             project_url = repo.projectUrl()
             if project_url not in osp.projects_by_url:
                 logging.warning(f"{project_url} not found in projects_by_url")
@@ -321,7 +348,6 @@ class OsProject:
         return repo
 
     def getIssues(self, limit: int = None, **params) -> List[Ticket]:
-
         # Fetch the raw issue records using the new getIssueRecords method
         issue_records = self.repo.getIssueRecords(limit=limit, **params)
 
@@ -376,7 +402,7 @@ class OsProject:
     def getComments(self, issue_number: int) -> List[dict]:
         """Fetch all comments for a specific issue number from GitHub."""
         comments_url = self.commentUrl(issue_number)
-        gihub_api=GitHubApi.get_instance()
+        gihub_api = GitHubApi.get_instance()
         response = gihub_api.get_response("fetch comments", comments_url)
         return response.json()
 

pyopensourceprojects-0.5.1/osprojects/version.py

@@ -0,0 +1,16 @@
+"""Created on 2024-07-31.
+
+@author: wf
+"""
+
+import osprojects
+
+
+class Version(object):
+    """Version handling for pyOpenSourceProjects."""
+
+    name = "pyOpenSourceProjects"
+    version = osprojects.__version__
+    date = "2024-07-31"
+    updated = "2026-03-14"  # keeping date; version now aligns to 0.5.1
+    description = "Check python OpenSource Projects to follow standards for README, github workflow and pyproject.toml - creates badges"

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/pyproject.toml

@@ -4,6 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyOpenSourceProjects"
+description ="Check python OpenSource Projects to follow standards for README, github workflow and pyprojec.toml - creates badges"
 
 authors = [
   { name = "Wolfgang Fahl", email = "wf@bitplan.com" }
@@ -29,18 +30,25 @@ dependencies = [
   # https://github.com/pypa/packaging
   "packaging>=24.1",
   # https://pypi.org/project/tqdm/
-  "tqdm>=4.66.5"
+  "tqdm>=4.66.5",
+  # https://pypi.org/project/ratelimit/
+  "ratelimit>=2.2.1",
+  # https://pypi.org/project/backoff/
+  "backoff",
+  # https://github.com/hukkin/tomli
+  "tomli>=2.3.0; python_version < '3.11'",
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 
 classifiers = [
   "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13"
 ]
 
-dynamic = ["version", "description"]
+dynamic = ["version"]
 
 [project.urls]
 Home = "https://github.com/WolfgangFahl/pyOpenSourceProjects"

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/tests/test_github_api.py

@@ -3,10 +3,11 @@
 @author: wf
 """
 
+import os
 import time
 import unittest
 
-from osprojects.github_api import GitHubAction, GitHubApi
+from osprojects.github_api import GitHubAction, GitHubApi, GitHubFileSet
 from tests.basetest import BaseTest
 
 
@@ -39,6 +40,47 @@ class TestGitHubApi(BaseTest):
                         repos[0], repos[trial], f"Cache was not used for {owner}"
                     )
 
+    @unittest.skipIf(
+        BaseTest.inPublicCI(), "Must be authenticated to access the code search API"
+    )
+    def test_github_cff(self):
+        """Retrieves cff files via untargeted search."""
+        limit = 100 if self.inPublicCI() else 1000
+        debug = self.debug
+        debug = True
+        verbose = True
+        github_api = GitHubApi.get_instance()
+        yaml_file = github_api.get_cache_path(f"git_cff_fileset{limit}.yaml")
+        query = "filename:CITATION.cff"
+
+        file_set = None
+
+        # Check if cache exists
+        if os.path.isfile(yaml_file):
+            print(f"Loading cached file set from: {yaml_file}")
+            # Ensure your class has a load_from_yaml_file or similar method (standard for lod_storable)
+            file_set = GitHubFileSet.load_from_yaml_file(
+                yaml_file
+            )  # @UndefinedVariable
+        else:
+            print(f"Cache not found. Querying GitHub API: {query}")
+            try:
+                # Limit max_results if your code supports it to prevent future 403s on fresh runs
+                file_set = GitHubFileSet.from_query(query, verbose=verbose)
+                file_set.save_to_yaml_file(yaml_file)
+            except Exception as e:
+                print(f"Warning: API fetch failed or was incomplete: {e}")
+                # If the file was partially created/in-memory before crash,
+                # you might handle partial saves here, but usually we just fail the test
+                # or rely on whatever logic wrote the file before the crash.
+
+        # Assertions to ensure we actually have data
+        self.assertIsNotNone(file_set)
+        # Check if we have files (based on your wc -l output, you expect ~1000)
+        if debug:
+            print(f"github CFF File references loaded: {len(file_set.files)}")
+        self.assertGreater(len(file_set.files), 0)
+
     @unittest.skipIf(BaseTest.inPublicCI(), "missing admin rights in public CI")
     def test_github_action_from_url(self):
         """Test creating GitHubAction instances from URLs."""

{pyopensourceprojects-0.4.1 → pyopensourceprojects-0.5.1}/tests/test_osproject.py

@@ -7,7 +7,6 @@ from argparse import Namespace
 
 from osprojects.check_project import CheckProject
 from osprojects.osproject import Commit, OsProject, Ticket, gitlog2wiki, main
-
 from tests.basetest import BaseTest
 
 

pyopensourceprojects-0.4.1/osprojects/__init__.py

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