gitraze 0.3.0__tar.gz → 0.5.0__tar.gz

gitraze-0.5.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: gitraze
+Version: 0.5.0
+Summary: A CLI and Python library for GitHub exploration, search, and analysis
+Author: AK Pandey
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/akpandey-dev/gitraze
+Keywords: github,cli,api,recon,search,github-user,repository
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: colorama
+Dynamic: license-file
+
+# Gitraze
+
+> A CLI and Python library for GitHub exploration, search, and analysis
+
+Gitraze is a CLI and Python library for exploring, analyzing, and extracting insights from GitHub through the REST API, with GraphQL planned.
+
+**Status:** Early development — expect bugs, missing features, and rapid changes. APIs and CLI may change without notice.
+
+> Built for developers who prefer terminals over tabs.
+
+[![PyPI](https://img.shields.io/pypi/v/gitraze)](https://pypi.org/project/gitraze/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gitraze)](https://pypi.org/project/gitraze/)
+[![Downloads](https://img.shields.io/pypi/dm/gitraze)](https://pypi.org/project/gitraze/)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/akpandey-dev/gitraze/ci.yml?branch=main)](https://github.com/akpandey-dev/gitraze/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Issues](https://img.shields.io/github/issues/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/issues)
+[![Stars](https://img.shields.io/github/stars/akpandey-dev/gitraze?style=social)](https://github.com/akpandey-dev/gitraze)
+[![Last Commit](https://img.shields.io/github/last-commit/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/commits/main)
+[![Contributors](https://img.shields.io/github/contributors/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/graphs/contributors)
+
+
+---
+
+## Why Gitraze?
+
+Most GitHub tools are either slow, bloated, or UI-heavy.
+
+Gitraze is built around a simpler approach:
+
+* Fast, minimal, no nonsense
+* Built for developers who think in terminals
+* Deep GitHub data access through the REST API
+* Modular and extensible architecture
+
+---
+
+## Features
+
+* Modular system
+* GitHub REST API integration
+* CLI-first workflow
+* SDK support
+* Repository insights
+* User analysis
+* Search users, repositories, issues, pull requests, and topics
+* Automatic filtering of pull requests and issues
+* Human-readable timestamps
+* Cleaned descriptions
+* Three data formats
+* Save or display output
+* Analytics modules in progress
+* GraphQL planned
+
+---
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install gitraze
+```
+
+### From source
+
+```bash
+git clone https://github.com/akpandey-dev/gitraze.git
+cd gitraze
+pip install -e .
+```
+
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
+
+
+---
+
+## Usage
+
+Gitraze can be used from the command line or as a Python library.
+
+### CLI
+
+```bash
+gitraze --help
+```
+
+Example:
+
+```bash
+gitraze --version
+gitraze --help
+gitraze user octocat --data-format=raw --output-action=save
+gitraze repo torvalds/linux --data-format=full # Query format must match
+gitraze search repos "machine learning" -n 5 --data-format=compact
+gitraze analyze <target> # Coming soon!
+```
+
+### Python
+
+```python
+import gitraze as gz
+```
+
+For example:
+```python
+import gitraze as gz
+user = gz.user("octocat", data_format="compact")
+print(user["name"])
+print(user["followers"])
+```
+
+For command usage, API reference, output formats, and examples, see the **[documentation](docs/)**.
+
+---
+
+## Philosophy
+
+Gitraze is built for speed, clarity, and control.
+
+No clutter, no distractions — just raw access to GitHub data, the way it should be.
+
+If you live in the terminal, Gitraze lives with you.
+
+---
+
+## Project Status
+
+Gitraze is in active development:
+
+* Expect breaking changes
+* Some commands may not work
+* Features are being added rapidly
+* GraphQL is not implemented yet; Gitraze is REST-focused for now
+
+If you're here early — you're basically a beta tester.
+
+---
+
+## Contributing
+
+PRs, ideas, bug reports, and feature suggestions are welcome.
+
+If you want to improve or modify Gitraze, go ahead.
+
+* Fork the repository
+* Create a feature branch
+* Submit a PR with clean commit messages
+
+```bash
+git checkout -b feature/cool-thing
+```
+
+Just keep the code clean and the terminal fast.
+
+---
+
+## License
+
+MIT License — do whatever you want, just don't blame me if you break stuff.

gitraze-0.5.0/README.md

@@ -0,0 +1,159 @@
+# Gitraze
+
+> A CLI and Python library for GitHub exploration, search, and analysis
+
+Gitraze is a CLI and Python library for exploring, analyzing, and extracting insights from GitHub through the REST API, with GraphQL planned.
+
+**Status:** Early development — expect bugs, missing features, and rapid changes. APIs and CLI may change without notice.
+
+> Built for developers who prefer terminals over tabs.
+
+[![PyPI](https://img.shields.io/pypi/v/gitraze)](https://pypi.org/project/gitraze/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gitraze)](https://pypi.org/project/gitraze/)
+[![Downloads](https://img.shields.io/pypi/dm/gitraze)](https://pypi.org/project/gitraze/)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/akpandey-dev/gitraze/ci.yml?branch=main)](https://github.com/akpandey-dev/gitraze/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Issues](https://img.shields.io/github/issues/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/issues)
+[![Stars](https://img.shields.io/github/stars/akpandey-dev/gitraze?style=social)](https://github.com/akpandey-dev/gitraze)
+[![Last Commit](https://img.shields.io/github/last-commit/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/commits/main)
+[![Contributors](https://img.shields.io/github/contributors/akpandey-dev/gitraze)](https://github.com/akpandey-dev/gitraze/graphs/contributors)
+
+
+---
+
+## Why Gitraze?
+
+Most GitHub tools are either slow, bloated, or UI-heavy.
+
+Gitraze is built around a simpler approach:
+
+* Fast, minimal, no nonsense
+* Built for developers who think in terminals
+* Deep GitHub data access through the REST API
+* Modular and extensible architecture
+
+---
+
+## Features
+
+* Modular system
+* GitHub REST API integration
+* CLI-first workflow
+* SDK support
+* Repository insights
+* User analysis
+* Search users, repositories, issues, pull requests, and topics
+* Automatic filtering of pull requests and issues
+* Human-readable timestamps
+* Cleaned descriptions
+* Three data formats
+* Save or display output
+* Analytics modules in progress
+* GraphQL planned
+
+---
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install gitraze
+```
+
+### From source
+
+```bash
+git clone https://github.com/akpandey-dev/gitraze.git
+cd gitraze
+pip install -e .
+```
+
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
+
+
+---
+
+## Usage
+
+Gitraze can be used from the command line or as a Python library.
+
+### CLI
+
+```bash
+gitraze --help
+```
+
+Example:
+
+```bash
+gitraze --version
+gitraze --help
+gitraze user octocat --data-format=raw --output-action=save
+gitraze repo torvalds/linux --data-format=full # Query format must match
+gitraze search repos "machine learning" -n 5 --data-format=compact
+gitraze analyze <target> # Coming soon!
+```
+
+### Python
+
+```python
+import gitraze as gz
+```
+
+For example:
+```python
+import gitraze as gz
+user = gz.user("octocat", data_format="compact")
+print(user["name"])
+print(user["followers"])
+```
+
+For command usage, API reference, output formats, and examples, see the **[documentation](docs/)**.
+
+---
+
+## Philosophy
+
+Gitraze is built for speed, clarity, and control.
+
+No clutter, no distractions — just raw access to GitHub data, the way it should be.
+
+If you live in the terminal, Gitraze lives with you.
+
+---
+
+## Project Status
+
+Gitraze is in active development:
+
+* Expect breaking changes
+* Some commands may not work
+* Features are being added rapidly
+* GraphQL is not implemented yet; Gitraze is REST-focused for now
+
+If you're here early — you're basically a beta tester.
+
+---
+
+## Contributing
+
+PRs, ideas, bug reports, and feature suggestions are welcome.
+
+If you want to improve or modify Gitraze, go ahead.
+
+* Fork the repository
+* Create a feature branch
+* Submit a PR with clean commit messages
+
+```bash
+git checkout -b feature/cool-thing
+```
+
+Just keep the code clean and the terminal fast.
+
+---
+
+## License
+
+MIT License — do whatever you want, just don't blame me if you break stuff.

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/__init__.py

@@ -3,8 +3,10 @@ from .modules.repo import get_repo_rest as repo
 from .modules.search import get_search_rest as search
 
 from .utils.helpers import display
+from .utils.helpers import save
+from .utils.helpers import output_action
 
-__version__ = "0.2.5"
+__version__ = "0.5.0"
 
 USERS = "users"
 REPOS = "repos"
@@ -13,7 +15,9 @@ ISSUES = "issues"
 TOPICS = "topics"
 
 __all__ = [
+    "output_action",
     "display",
+    "save",
     "user",
     "repo",
     "search",

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/cli.py

@@ -6,16 +6,18 @@ from gitraze.handlers.analyze import handle_analysis
 
 
 def main():
+    """Parse CLI arguments and dispatch the selected command."""
+    
     parser = argparse.ArgumentParser(
         prog="gitraze",
-        description="GitRaze CLI Tool"
+        description="Gitraze CLI Tool"
     )
 
     # Global flag
     parser.add_argument(
         "--version",
         action="version",
-        version="gitraze 0.3.0"
+        version="gitraze 0.5.0"
     )
 
     subparsers = parser.add_subparsers(dest="command", required=True)
@@ -23,14 +25,16 @@ def main():
     # USER 
     user_parser = subparsers.add_parser("user", help="Fetch user info (GitHub username)")
     user_parser.add_argument("username", help="Format: username")
-    user_parser.add_argument("--format", choices=["compact", "full", "raw"], default="compact", help="Output format (default: compact)")
+    user_parser.add_argument("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data format (default: compact)")
+    user_parser.add_argument("--output-action", choices=["display", "save"], default="display", help="Output action (default: display)")
     user_parser.set_defaults(func=handle_user)
 
 
     # REPO 
     repo_parser = subparsers.add_parser("repo", help="Fetch repo info (Repository in owner/repo format)")
     repo_parser.add_argument("repo", help="Format: owner/repo")
-    repo_parser.add_argument("--format", choices=["compact", "full", "raw"], default="compact", help="Output format (default: compact)")
+    repo_parser.add_argument("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data format (default: compact)")
+    repo_parser.add_argument("--output-action", choices=["display", "save"], default="display", help="Output action (default: display)")
     repo_parser.set_defaults(func=handle_repo)
 
 
@@ -39,7 +43,8 @@ def main():
     search_parser.add_argument("category",choices=["repos", "users", "issues", "prs", "topics"],help="repos | users | issues | prs | topics")
     search_parser.add_argument("query", nargs="+", help="Search category (repos, users, issues, topics)")
     search_parser.add_argument("-n", "--limit", type=int, default=1, help="Number of results to show")
-    search_parser.add_argument("--format", choices=["compact", "full", "raw"], default="compact", help="Output format (default: compact)")
+    search_parser.add_argument("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data format (default: compact)")
+    search_parser.add_argument("--output-action", choices=["display", "save"], default="display", help="Output action (default: display)")
     search_parser.set_defaults(func=handle_search)
 
 

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/config.py

@@ -1,15 +1,13 @@
-# config.py
 
-'''=============REST=============='''
 
-# --- BASE CONFIGS ---
+# BASE CONFIGS
 REST_BASE_URL = "https://api.github.com"
 GRAPHQL_URL = "https://api.github.com/graphql"
 DEFAULT_TIMEOUT = 10
 DEFAULT_HEADERS = {
     "Accept": "application/vnd.github+json"}
 
-# --- SEARCH CATEGORIES CONFIG  ---
+# SEARCH CATEGORIES CONFIG
 SEARCH_MAP = {
     "repos": "repositories",
     "users": "users",

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/core/api_rest.py

@@ -4,6 +4,8 @@ from gitraze.config import REST_BASE_URL, DEFAULT_HEADERS, DEFAULT_TIMEOUT
 from gitraze.config import SEARCH_MAP
 
 def get_user(username):
+    """Fetch raw user data from the GitHub REST API."""
+
     url = f"{REST_BASE_URL}/users/{username}"
 
     try:
@@ -23,6 +25,8 @@ def get_user(username):
 
 
 def get_repo(owner, repo):
+    """Fetch raw repository data from the GitHub REST API."""
+
     url = f"{REST_BASE_URL}/repos/{owner}/{repo}"
     try:
         response = requests.get(
@@ -40,6 +44,8 @@ def get_repo(owner, repo):
         return {"error": f"Request failed: {str(e)}"}
     
 def get_search(category, query):
+    """Fetch raw search results from the GitHub REST API."""
+
     url = f"{REST_BASE_URL}/search/{SEARCH_MAP.get(category)}"
 
     filters = []

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/handlers/analyze.py

@@ -2,6 +2,8 @@ from gitraze.utils.helpers import pretty_print
 
 
 def handle_analysis(args):
+    """Placeholder function for handling analysis commands."""
+    
     target = " ".join(args.target)
     print(f"[ANALYZE] Analyzing '{target}'")
     print("Not implemented yet")

gitraze-0.5.0/gitraze/handlers/repo.py

@@ -0,0 +1,31 @@
+import json
+from gitraze.utils.helpers import file_save, pretty_print
+from gitraze.modules.repo import get_repo_rest
+
+def handle_repo(args):
+    """Handle the repo CLI command."""
+
+    print("[+] Fetching repository data...")
+    parts = args.repo.split("/")
+    
+    if len(parts) != 2:
+        print("Invalid format. Use: owner/repo")
+        return
+    owner, repo = parts
+    data = get_repo_rest(owner, repo, data_format=args.data_format)
+
+    if "error" in data:
+        print(data["error"])
+        return
+
+    print("[✓] Done")
+
+    if args.output_action == "save":
+        file_save(data, f"{owner}-{repo}-data.json")
+        return
+    elif args.output_action == "display":
+        if args.data_format == "raw":
+            print(json.dumps(data, indent=2))
+            return
+        else:
+            pretty_print(data, title=f"User: {owner}, Repository: {repo}")

gitraze-0.5.0/gitraze/handlers/search.py

@@ -0,0 +1,37 @@
+import json
+from gitraze.utils.helpers import file_save, pretty_print
+from gitraze.modules.search import get_search_rest
+
+def handle_search(args):
+    """Handle the search CLI command."""
+
+    category = args.category
+
+    raw_query = " ".join(args.query)
+    clean_query = raw_query.replace('"', '')
+    query = f'"{clean_query}"'
+
+    print(f"[+] Searching {category} for {query}...")
+
+
+    data = get_search_rest(category, query, args.limit, data_format=args.data_format)
+
+    if "error" in data:
+        print(data["error"])
+        return
+
+    print("[✓] Done")
+
+    if args.output_action == "save":
+        file_save(data, f"{category}-{clean_query}-data.json")
+        return
+    elif args.output_action == "display":
+        if args.data_format == "raw":
+            print(json.dumps(data, indent=2))
+            return
+        else:
+            if isinstance(data, list):
+                for i, item in enumerate(data, 1):
+                    pretty_print(item, title=f"{category} [{i}] -> {query}")
+            else:
+                pretty_print(data, title=f"Search: {category} -> {query}")

gitraze-0.5.0/gitraze/handlers/user.py

@@ -0,0 +1,25 @@
+import json
+from gitraze.utils.helpers import file_save, pretty_print
+from gitraze.modules.user import get_user_rest
+
+def handle_user(args):
+    """Handle the user CLI command."""
+
+    print("[+] Fetching user data...")
+    data = get_user_rest(args.username, data_format=args.data_format)
+
+    if "error" in data:
+        print(data["error"])
+        return
+
+    print("[✓] Done")
+    
+    if args.output_action == "save":
+        file_save(data, f"{args.username}-data.json")
+        return
+    elif args.output_action == "display":
+        if args.data_format == "raw":
+            print(json.dumps(data, indent=2))
+            return
+        else:
+            pretty_print(data, title=f"User: {args.username}")

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/modules/repo.py

@@ -3,15 +3,26 @@ from gitraze.utils.helpers import format_date
 from gitraze.utils.helpers import normalize_api_data
 from gitraze.core.api_rest import get_repo as rest_get_repo
 
-def get_repo_rest(owner, repo, output_format="compact"):
+def get_repo_rest(owner, repo, data_format="compact"):
+    """Fetch GitHub repository data in the requested data format.
+
+    Args:
+        owner: GitHub repository owner's username or organization name.
+        repo: GitHub repository name.
+        data_format: Data format: "compact", "full", or "raw".
+
+    Returns:
+        Repository data in the requested format, or an error dictionary.
+    """
+    
     data = rest_get_repo(owner, repo)
 
     if "error" in data:
         return data
 
-    if output_format == "raw":
+    if data_format == "raw":
         return data
-    if output_format == "full":
+    if data_format == "full":
         return normalize_api_data(data)
         
     return {

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/modules/search.py

@@ -5,11 +5,23 @@ from gitraze.utils.helpers import normalize_api_data
 from gitraze.core.api_rest import get_search
 
 
-def get_search_rest(category, query,  limit=1, output_format="compact"):
+def get_search_rest(category, query,  limit=1, data_format="compact"):
+    """Search GitHub and return results in the requested data format.
+
+    Args:
+        category: Search category: "repos", "users", "issues", "prs", or "topics".
+        query: Search query passed to GitHub.
+        limit: Maximum number of results to return.
+        data_format: Data format: "compact", "full", or "raw".
+
+    Returns:
+        Search results in the requested format, or an error dictionary.
+    """
+        
     if category not in ["repos", "users", "issues", "prs", "topics"]:
         return {"error": "Invalid category"}
-    if output_format not in ["compact", "full", "raw"]:
-        return {"error": "Invalid output format"}
+    if data_format not in ["compact", "full", "raw"]:
+        return {"error": "Invalid data format"}
 
     data = get_search(category, query)
     if "error" in data:
@@ -25,9 +37,9 @@ def get_search_rest(category, query,  limit=1, output_format="compact"):
         return {"error": "No results found"}
     items = items[:limit]
 
-    if output_format == "raw":
+    if data_format == "raw":
         return items
-    if output_format == "full":
+    if data_format == "full":
         return [normalize_api_data(item) for item in items]
 
     results = []

{gitraze-0.3.0 → gitraze-0.5.0}/gitraze/modules/user.py

@@ -3,16 +3,26 @@ from gitraze.utils.helpers import format_date
 from gitraze.utils.helpers import normalize_api_data
 from gitraze.core.api_rest import get_user as rest_get_user
 
-def get_user_rest(username, output_format="compact"):
+def get_user_rest(username, data_format="compact"):
+    """Fetch GitHub user data in the requested data format.
+
+    Args:
+        username: GitHub username to fetch.
+        data_format: Data format: "compact", "full", or "raw".
+
+    Returns:
+        User data in the requested format, or an error dictionary.
+    """
+    
     data = rest_get_user(username)
 
     if "error" in data:
         return data
 
 
-    if output_format == "raw":
+    if data_format == "raw":
         return data
-    if output_format == "full":
+    if data_format == "full":
         return normalize_api_data(data)
 
     return {