webscout 8.3.6__py3-none-any.whl → 2025.10.11__py3-none-any.whl

webscout/Extra/GitToolkit/__init__.py

@@ -1,10 +1,10 @@
-from .gitapi import *
-
-__all__ = [
-    'Repository',
-    'User',
-    'GitError',
-    'RateLimitError', 
-    'NotFoundError',
-    'RequestError'
-]
+from .gitapi import *
+
+__all__ = [
+    'Repository',
+    'User',
+    'GitError',
+    'RateLimitError', 
+    'NotFoundError',
+    'RequestError'
+]

webscout/Extra/GitToolkit/gitapi/README.md

@@ -1,110 +1,110 @@
-# 🚀 GitAPI: GitHub Data Extraction Module
-
-## Overview
-
-GitAPI is a powerful, lightweight GitHub data extraction module within the Webscout Python package. It provides comprehensive tools for retrieving GitHub repository and user information without requiring authentication for public data access.
-
-## ✨ Features
-
-- **Repository Operations**
-  - Repository metadata retrieval
-  - Commit history tracking
-  - Pull request management
-  - Issue tracking
-  - Release information
-  - Branch management
-  - Repository statistics
-  - Workflow data
-
-- **User Operations**
-  - Profile information
-  - Repository listing
-  - Follower/Following data
-  - Organization membership
-  - Event tracking
-  - Gist management
-  - Star history
-
-- **Error Handling**
-  - Rate limit detection
-  - Resource not found handling
-  - Request retry mechanism
-  - Custom error types
-
-## 📦 Installation
-
-Install as part of the Webscout package:
-
-```bash
-pip install webscout
-```
-
-## 💡 Quick Examples
-
-### Repository Operations
-
-```python
-from webscout.Extra.GitToolkit.gitapi import Repository
-
-# Initialize repository client
-repo = Repository("OE-LUCIFER", "Webscout")
-
-# Get basic repository info
-info = repo.get_info()
-print(f"Repository: {info['full_name']}")
-print(f"Stars: {info['stargazers_count']}")
-
-# Get latest commits
-commits = repo.get_commits(per_page=5)
-for commit in commits:
-    print(f"Commit: {commit['commit']['message']}")
-```
-
-### User Operations
-
-```python
-from webscout.Extra.GitToolkit.gitapi import User
-
-# Initialize user client
-user = User("OE-LUCIFER")
-
-# Get user profile
-profile = user.get_profile()
-print(f"User: {profile['login']}")
-print(f"Followers: {profile['followers']}")
-
-# Get user's repositories
-repositories = user.get_repositories()
-for repo in repositories:
-    print(f"Repository: {repo['name']}")
-```
-
-## 🔧 Available Methods
-
-### Repository Class
-
-- `get_info()`: Basic repository information
-- `get_commits()`: Repository commit history
-- `get_pull_requests()`: Repository pull requests
-- `get_issues()`: Repository issues
-- `get_releases()`: Repository releases
-- `get_branches()`: Repository branches
-- And many more...
-
-### User Class
-
-- `get_profile()`: User profile information
-- `get_repositories()`: User's public repositories
-- `get_followers()`: User's followers
-- `get_following()`: Users being followed
-- `get_organizations()`: User's organizations
-- And many more...
-
-## ⚠️ Error Handling
-
-The module includes several custom exception types:
-
-- `GitError`: Base exception for all GitHub API errors
-- `RateLimitError`: Raised when hitting API rate limits
-- `NotFoundError`: Raised when resource is not found
-- `RequestError`: Raised for general request errors
+# 🚀 GitAPI: GitHub Data Extraction Module
+
+## Overview
+
+GitAPI is a powerful, lightweight GitHub data extraction module within the Webscout Python package. It provides comprehensive tools for retrieving GitHub repository and user information without requiring authentication for public data access.
+
+## ✨ Features
+
+- **Repository Operations**
+  - Repository metadata retrieval
+  - Commit history tracking
+  - Pull request management
+  - Issue tracking
+  - Release information
+  - Branch management
+  - Repository statistics
+  - Workflow data
+
+- **User Operations**
+  - Profile information
+  - Repository listing
+  - Follower/Following data
+  - Organization membership
+  - Event tracking
+  - Gist management
+  - Star history
+
+- **Error Handling**
+  - Rate limit detection
+  - Resource not found handling
+  - Request retry mechanism
+  - Custom error types
+
+## 📦 Installation
+
+Install as part of the Webscout package:
+
+```bash
+pip install webscout
+```
+
+## 💡 Quick Examples
+
+### Repository Operations
+
+```python
+from webscout.Extra.GitToolkit.gitapi import Repository
+
+# Initialize repository client
+repo = Repository("OE-LUCIFER", "Webscout")
+
+# Get basic repository info
+info = repo.get_info()
+print(f"Repository: {info['full_name']}")
+print(f"Stars: {info['stargazers_count']}")
+
+# Get latest commits
+commits = repo.get_commits(per_page=5)
+for commit in commits:
+    print(f"Commit: {commit['commit']['message']}")
+```
+
+### User Operations
+
+```python
+from webscout.Extra.GitToolkit.gitapi import User
+
+# Initialize user client
+user = User("OE-LUCIFER")
+
+# Get user profile
+profile = user.get_profile()
+print(f"User: {profile['login']}")
+print(f"Followers: {profile['followers']}")
+
+# Get user's repositories
+repositories = user.get_repositories()
+for repo in repositories:
+    print(f"Repository: {repo['name']}")
+```
+
+## 🔧 Available Methods
+
+### Repository Class
+
+- `get_info()`: Basic repository information
+- `get_commits()`: Repository commit history
+- `get_pull_requests()`: Repository pull requests
+- `get_issues()`: Repository issues
+- `get_releases()`: Repository releases
+- `get_branches()`: Repository branches
+- And many more...
+
+### User Class
+
+- `get_profile()`: User profile information
+- `get_repositories()`: User's public repositories
+- `get_followers()`: User's followers
+- `get_following()`: Users being followed
+- `get_organizations()`: User's organizations
+- And many more...
+
+## ⚠️ Error Handling
+
+The module includes several custom exception types:
+
+- `GitError`: Base exception for all GitHub API errors
+- `RateLimitError`: Raised when hitting API rate limits
+- `NotFoundError`: Raised when resource is not found
+- `RequestError`: Raised for general request errors

webscout/Extra/GitToolkit/gitapi/__init__.py

@@ -1,12 +1,12 @@
-from .repository import Repository
-from .user import User
-from .utils import GitError, RateLimitError, NotFoundError, RequestError
-
-__all__ = [
-    'Repository',
-    'User',
-    'GitError',
-    'RateLimitError', 
-    'NotFoundError',
-    'RequestError'
+from .repository import Repository
+from .user import User
+from .utils import GitError, RateLimitError, NotFoundError, RequestError
+
+__all__ = [
+    'Repository',
+    'User',
+    'GitError',
+    'RateLimitError', 
+    'NotFoundError',
+    'RequestError'
 ]

webscout/Extra/GitToolkit/gitapi/repository.py

@@ -1,195 +1,195 @@
-from typing import List, Dict, Any, Optional
-from .utils import request
-from urllib.parse import quote
-
-class Repository:
-    """Class for interacting with GitHub repositories"""
-    
-    def __init__(self, owner: str, repo: str):
-        """
-        Initialize repository client
-        
-        Args:
-            owner: Repository owner
-            repo: Repository name
-        """
-        self.owner = owner
-        self.repo = repo
-        self.base_url = f"https://api.github.com/repos/{owner}/{repo}"
-
-    def get_info(self) -> Dict[str, Any]:
-        """Get basic repository information"""
-        return request(self.base_url)
-
-    def get_commits(self, page: int = 1, per_page: int = 30, sha: str = None) -> List[Dict[str, Any]]:
-        """
-        Get repository commits
-        
-        Args:
-            page: Page number
-            per_page: Items per page
-            sha: SHA or branch name to start listing commits from
-        """
-        url = f"{self.base_url}/commits?page={page}&per_page={per_page}"
-        if sha:
-            url += f"&sha={sha}"
-        return request(url)
-
-    def get_commit(self, sha: str) -> Dict[str, Any]:
-        """Get a specific commit details"""
-        url = f"{self.base_url}/commits/{sha}"
-        return request(url)
-
-    def get_pull_requests(self, state: str = "all", page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
-        """
-        Get repository pull requests
-        
-        Args:
-            state: State of PRs to return (open/closed/all)
-            page: Page number
-            per_page: Items per page
-        """
-        url = f"{self.base_url}/pulls?state={state}&page={page}&per_page={per_page}"
-        return request(url)
-
-    def get_pull_request(self, pr_number: int) -> Dict[str, Any]:
-        """Get specific pull request details"""
-        url = f"{self.base_url}/pulls/{pr_number}"
-        return request(url)
-
-    def get_pull_request_commits(self, pr_number: int) -> List[Dict[str, Any]]:
-        """Get commits in a specific pull request"""
-        url = f"{self.base_url}/pulls/{pr_number}/commits"
-        return request(url)
-
-    def get_pull_request_files(self, pr_number: int) -> List[Dict[str, Any]]:
-        """Get files changed in a specific pull request"""
-        url = f"{self.base_url}/pulls/{pr_number}/files"
-        return request(url)
-
-    def get_issues(self, state: str = "all", page: int = 1, per_page: int = 30, labels: str = None) -> List[Dict[str, Any]]:
-        """
-        Get repository issues
-        
-        Args:
-            state: State of issues to return (open/closed/all)
-            page: Page number
-            per_page: Items per page
-            labels: Comma-separated list of label names
-        """
-        url = f"{self.base_url}/issues?state={state}&page={page}&per_page={per_page}"
-        if labels:
-            url += f"&labels={labels}"
-        return request(url)
-
-    def get_issue(self, issue_number: int) -> Dict[str, Any]:
-        """Get specific issue details"""
-        url = f"{self.base_url}/issues/{issue_number}"
-        return request(url)
-
-    def get_issue_comments(self, issue_number: int) -> List[Dict[str, Any]]:
-        """Get comments on a specific issue"""
-        url = f"{self.base_url}/issues/{issue_number}/comments"
-        return request(url)
-
-    def get_labels(self) -> List[Dict[str, Any]]:
-        """Get repository labels"""
-        url = f"{self.base_url}/labels"
-        return request(url)
-
-    def get_milestones(self, state: str = "all") -> List[Dict[str, Any]]:
-        """Get repository milestones"""
-        url = f"{self.base_url}/milestones?state={state}"
-        return request(url)
-
-    def get_contributors(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
-        """Get repository contributors"""
-        url = f"{self.base_url}/contributors?page={page}&per_page={per_page}"
-        return request(url)
-
-    def get_languages(self) -> Dict[str, int]:
-        """Get repository language breakdown"""
-        url = f"{self.base_url}/languages"
-        return request(url)
-
-    def get_teams(self) -> List[Dict[str, Any]]:
-        """Get teams with access to repository"""
-        url = f"{self.base_url}/teams"
-        return request(url)
-
-    def get_tags(self) -> List[Dict[str, Any]]:
-        """Get repository tags"""
-        url = f"{self.base_url}/tags"
-        return request(url)
-
-    def get_releases(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
-        """Get repository releases"""
-        url = f"{self.base_url}/releases?page={page}&per_page={per_page}"
-        return request(url)
-
-    def get_release(self, release_id: str) -> Dict[str, Any]:
-        """Get specific release details"""
-        url = f"{self.base_url}/releases/{release_id}"
-        return request(url)
-
-    def get_latest_release(self) -> Dict[str, Any]:
-        """Get latest release"""
-        url = f"{self.base_url}/releases/latest"
-        return request(url)
-
-    def get_branches(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
-        """Get repository branches"""
-        url = f"{self.base_url}/branches?page={page}&per_page={per_page}"
-        return request(url)
-
-    def get_branch(self, branch: str) -> Dict[str, Any]:
-        """Get specific branch details"""
-        url = f"{self.base_url}/branches/{branch}"
-        return request(url)
-
-    def get_contents(self, path: str = "", ref: Optional[str] = None) -> Dict[str, Any]:
-        """Get contents of file or directory"""
-        url = f"{self.base_url}/contents/{quote(path)}"
-        if ref:
-            url += f"?ref={ref}"
-        return request(url)
-
-    def get_collaborators(self) -> List[Dict[str, Any]]:
-        """Get repository collaborators"""
-        url = f"{self.base_url}/collaborators"
-        return request(url)
-
-    def get_workflows(self) -> List[Dict[str, Any]]:
-        """Get repository GitHub Actions workflows"""
-        url = f"{self.base_url}/actions/workflows"
-        return request(url)
-
-    def get_workflow_runs(self, workflow_id: str) -> List[Dict[str, Any]]:
-        """Get workflow runs for a specific workflow"""
-        url = f"{self.base_url}/actions/workflows/{workflow_id}/runs"
-        return request(url)
-
-    def get_deployments(self) -> List[Dict[str, Any]]:
-        """Get repository deployments"""
-        url = f"{self.base_url}/deployments"
-        return request(url)
-
-    def get_traffic(self) -> Dict[str, Any]:
-        """Get repository traffic data"""
-        url = f"{self.base_url}/traffic/views"
-        return request(url)
-
-    def get_code_frequency(self) -> List[List[int]]:
-        """Get weekly commit activity"""
-        url = f"{self.base_url}/stats/code_frequency"
-        return request(url)
-
-    def get_commit_activity(self) -> List[Dict[str, Any]]:
-        """Get last year of commit activity"""
-        url = f"{self.base_url}/stats/commit_activity"
-        return request(url)
-
-    def get_community_profile(self) -> Dict[str, Any]:
-        """Get community profile metrics"""
-        url = f"{self.base_url}/community/profile"
-        return request(url)
+from typing import List, Dict, Any, Optional
+from .utils import request
+from urllib.parse import quote
+
+class Repository:
+    """Class for interacting with GitHub repositories"""
+    
+    def __init__(self, owner: str, repo: str):
+        """
+        Initialize repository client
+        
+        Args:
+            owner: Repository owner
+            repo: Repository name
+        """
+        self.owner = owner
+        self.repo = repo
+        self.base_url = f"https://api.github.com/repos/{owner}/{repo}"
+
+    def get_info(self) -> Dict[str, Any]:
+        """Get basic repository information"""
+        return request(self.base_url)
+
+    def get_commits(self, page: int = 1, per_page: int = 30, sha: str = None) -> List[Dict[str, Any]]:
+        """
+        Get repository commits
+        
+        Args:
+            page: Page number
+            per_page: Items per page
+            sha: SHA or branch name to start listing commits from
+        """
+        url = f"{self.base_url}/commits?page={page}&per_page={per_page}"
+        if sha:
+            url += f"&sha={sha}"
+        return request(url)
+
+    def get_commit(self, sha: str) -> Dict[str, Any]:
+        """Get a specific commit details"""
+        url = f"{self.base_url}/commits/{sha}"
+        return request(url)
+
+    def get_pull_requests(self, state: str = "all", page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
+        """
+        Get repository pull requests
+        
+        Args:
+            state: State of PRs to return (open/closed/all)
+            page: Page number
+            per_page: Items per page
+        """
+        url = f"{self.base_url}/pulls?state={state}&page={page}&per_page={per_page}"
+        return request(url)
+
+    def get_pull_request(self, pr_number: int) -> Dict[str, Any]:
+        """Get specific pull request details"""
+        url = f"{self.base_url}/pulls/{pr_number}"
+        return request(url)
+
+    def get_pull_request_commits(self, pr_number: int) -> List[Dict[str, Any]]:
+        """Get commits in a specific pull request"""
+        url = f"{self.base_url}/pulls/{pr_number}/commits"
+        return request(url)
+
+    def get_pull_request_files(self, pr_number: int) -> List[Dict[str, Any]]:
+        """Get files changed in a specific pull request"""
+        url = f"{self.base_url}/pulls/{pr_number}/files"
+        return request(url)
+
+    def get_issues(self, state: str = "all", page: int = 1, per_page: int = 30, labels: str = None) -> List[Dict[str, Any]]:
+        """
+        Get repository issues
+        
+        Args:
+            state: State of issues to return (open/closed/all)
+            page: Page number
+            per_page: Items per page
+            labels: Comma-separated list of label names
+        """
+        url = f"{self.base_url}/issues?state={state}&page={page}&per_page={per_page}"
+        if labels:
+            url += f"&labels={labels}"
+        return request(url)
+
+    def get_issue(self, issue_number: int) -> Dict[str, Any]:
+        """Get specific issue details"""
+        url = f"{self.base_url}/issues/{issue_number}"
+        return request(url)
+
+    def get_issue_comments(self, issue_number: int) -> List[Dict[str, Any]]:
+        """Get comments on a specific issue"""
+        url = f"{self.base_url}/issues/{issue_number}/comments"
+        return request(url)
+
+    def get_labels(self) -> List[Dict[str, Any]]:
+        """Get repository labels"""
+        url = f"{self.base_url}/labels"
+        return request(url)
+
+    def get_milestones(self, state: str = "all") -> List[Dict[str, Any]]:
+        """Get repository milestones"""
+        url = f"{self.base_url}/milestones?state={state}"
+        return request(url)
+
+    def get_contributors(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
+        """Get repository contributors"""
+        url = f"{self.base_url}/contributors?page={page}&per_page={per_page}"
+        return request(url)
+
+    def get_languages(self) -> Dict[str, int]:
+        """Get repository language breakdown"""
+        url = f"{self.base_url}/languages"
+        return request(url)
+
+    def get_teams(self) -> List[Dict[str, Any]]:
+        """Get teams with access to repository"""
+        url = f"{self.base_url}/teams"
+        return request(url)
+
+    def get_tags(self) -> List[Dict[str, Any]]:
+        """Get repository tags"""
+        url = f"{self.base_url}/tags"
+        return request(url)
+
+    def get_releases(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
+        """Get repository releases"""
+        url = f"{self.base_url}/releases?page={page}&per_page={per_page}"
+        return request(url)
+
+    def get_release(self, release_id: str) -> Dict[str, Any]:
+        """Get specific release details"""
+        url = f"{self.base_url}/releases/{release_id}"
+        return request(url)
+
+    def get_latest_release(self) -> Dict[str, Any]:
+        """Get latest release"""
+        url = f"{self.base_url}/releases/latest"
+        return request(url)
+
+    def get_branches(self, page: int = 1, per_page: int = 30) -> List[Dict[str, Any]]:
+        """Get repository branches"""
+        url = f"{self.base_url}/branches?page={page}&per_page={per_page}"
+        return request(url)
+
+    def get_branch(self, branch: str) -> Dict[str, Any]:
+        """Get specific branch details"""
+        url = f"{self.base_url}/branches/{branch}"
+        return request(url)
+
+    def get_contents(self, path: str = "", ref: Optional[str] = None) -> Dict[str, Any]:
+        """Get contents of file or directory"""
+        url = f"{self.base_url}/contents/{quote(path)}"
+        if ref:
+            url += f"?ref={ref}"
+        return request(url)
+
+    def get_collaborators(self) -> List[Dict[str, Any]]:
+        """Get repository collaborators"""
+        url = f"{self.base_url}/collaborators"
+        return request(url)
+
+    def get_workflows(self) -> List[Dict[str, Any]]:
+        """Get repository GitHub Actions workflows"""
+        url = f"{self.base_url}/actions/workflows"
+        return request(url)
+
+    def get_workflow_runs(self, workflow_id: str) -> List[Dict[str, Any]]:
+        """Get workflow runs for a specific workflow"""
+        url = f"{self.base_url}/actions/workflows/{workflow_id}/runs"
+        return request(url)
+
+    def get_deployments(self) -> List[Dict[str, Any]]:
+        """Get repository deployments"""
+        url = f"{self.base_url}/deployments"
+        return request(url)
+
+    def get_traffic(self) -> Dict[str, Any]:
+        """Get repository traffic data"""
+        url = f"{self.base_url}/traffic/views"
+        return request(url)
+
+    def get_code_frequency(self) -> List[List[int]]:
+        """Get weekly commit activity"""
+        url = f"{self.base_url}/stats/code_frequency"
+        return request(url)
+
+    def get_commit_activity(self) -> List[Dict[str, Any]]:
+        """Get last year of commit activity"""
+        url = f"{self.base_url}/stats/commit_activity"
+        return request(url)
+
+    def get_community_profile(self) -> Dict[str, Any]:
+        """Get community profile metrics"""
+        url = f"{self.base_url}/community/profile"
+        return request(url)