gitraze 0.2.5__tar.gz → 0.3.0__tar.gz

{gitraze-0.2.5 → gitraze-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.2.5
+Version: 0.3.0
 Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
 Author: AK Pandey
 License-Expression: MIT
@@ -19,12 +19,22 @@ Dynamic: license-file
 
 > A fast, hacker-style CLI for slicing through GitHub data like a blade.
 
-Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using both REST and GraphQL APIs — all from your terminal.
+Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using REST, with GraphQL support coming soon; all from your terminal.
 
 ⚠️ **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)
+
 
 ---
 
@@ -58,10 +68,19 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 
 ## Installation
 
+### From PyPI using `pip`
+
 ```bash
 pip install gitraze
 ```
 
+### Using source code from Repository
+
+> Read the `Development setup` section.
+
+---
+> There may be some gap between releases on GitHub and PyPI, as more than one commits are sometimes clustered as a single release on PyPI.
+
 
 ## Usage
 
@@ -69,14 +88,16 @@ pip install gitraze
 
 Example: 
 ```bash
+gitraze --version
 gitraze --help
-gitraze user octocat
-gitraze repo torvalds/linux  
-gitraze search repos "machine learning" -n 5 # Will show top 5 results, but it is optional flag
-gitraze analyze github # Coming soon!
+gitraze user octocat --format=raw 
+gitraze repo torvalds/linux --format=full # Query format must match
+gitraze search repos "machine learning" -n 5 --format=compact 
+gitraze analyze <target> # Coming soon!
 ```
 
 Example output:
+
 ```bash
 $ gitraze user octocat
 
@@ -103,6 +124,7 @@ Email            : None
 Twitter_username : None
 
 ```
+
 > Commands prefixed with `$` should be run in your terminal.
 
 ### Gitraze can also be used as a lightweight Python SDK.
@@ -111,21 +133,54 @@ Twitter_username : None
 ```python
 import gitraze as gz
 
-user = gz.user("octocat")
+user = gz.user("octocat", output_format="compact")
 
 print(user["name"])
 print(user["followers"])
 ```
 
+#### Repository:
+```python
+import gitraze as gz
+
+repo = gz.repo("torvalds", "linux", output_format="full")
+
+print(repo["name"])
+print(repo["owner"])
+```
+
+> Note: Unlike the CLI, the SDK accepts owner and repository name as separate arguments.
+
 #### Search: 
 
 ```python
-results = gz.search(gz.REPOS, "machine learning", 3)
+import gitraze as gz
+
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
 
 for repo in results:
     print(repo["full_name"])
 ```
 
+### Custom Output Format:
+
+All three SDK functions support output customization:
+
+```python
+import gitraze as gz
+
+user = gz.user("octocat", output_format="full")
+repo = gz.repo("torvalds", "linux", output_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="full")
+```
+
+#### Available options are:
+
+* `output_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `output_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `output_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
+
+
 ### Pretty-print results in terminal style:
 
 ```python
@@ -157,14 +212,16 @@ Twitter_username : None
 
 > Note: **`import gitraze as gz`** is the recommended import.
 
+> Note: Exact fields and values may differ from the examples shown, depending on the GitHub API response.
+
 ## Available exports:
 
 ### Functions: 
 
-- `user()`
-- `repo()`
-- `search()`
-- `display()`
+- `user(username, output_format="compact")`
+- `repo(owner, repo, output_format="compact")`
+- `search(category, query, limit=1, output_format="compact")`
+- `display(data)`
 
 ### Constants:
 
@@ -174,9 +231,10 @@ Twitter_username : None
 - `ISSUES`
 - `TOPICS`
 
+> Constants depend on the module internals and may change without prior notice.
 
+> CLI commands and SDK APIs are still evolving and may change between releases.
 
-⚠️ CLI commands are still evolving and may change.
 
 ## Philosophy
 
@@ -204,14 +262,17 @@ Gitraze is in active development:
 - Expect breaking changes
 - Some commands may not work
 - Features are being added rapidly
-- GraphQL feature is basically absent now, but is coming soon
+- GraphQL feature is basically absent now, but integration is planned; currently REST-focused.
 
-If you're here early — you're basically a beta tester 😈
+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

gitraze-0.3.0/README.md

@@ -0,0 +1,270 @@
+# Gitraze
+
+> A fast, hacker-style CLI for slicing through GitHub data like a blade.
+
+Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using REST, with GraphQL support coming soon; all from your terminal.
+
+⚠️ **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 different:**
+-  Fast, minimal, no nonsense
+-  Built for developers who think in terminals
+-  Deep GitHub data access (REST + GraphQL)
+-  Modular and extensible architecture
+
+---
+
+## Features
+
+-  Modular system (easy to extend and hack on)
+-  CLI-first workflow
+-  GitHub API integration (REST + GraphQL)
+-  Repository insights
+-  User analysis
+-  Filter PRs vs issues automatically
+-  Human-readable timestamps
+-  Cleaned descriptions (HTML stripped)
+-  Analytics modules (in progress)
+-  Search users, repos, issues, PRs, and topics
+
+
+---
+
+## Installation
+
+### From PyPI using `pip`
+
+```bash
+pip install gitraze
+```
+
+### Using source code from Repository
+
+> Read the `Development setup` section.
+
+---
+> There may be some gap between releases on GitHub and PyPI, as more than one commits are sometimes clustered as a single release on PyPI.
+
+
+## Usage
+
+### Run directly from your terminal:
+
+Example: 
+```bash
+gitraze --version
+gitraze --help
+gitraze user octocat --format=raw 
+gitraze repo torvalds/linux --format=full # Query format must match
+gitraze search repos "machine learning" -n 5 --format=compact 
+gitraze analyze <target> # Coming soon!
+```
+
+Example output:
+
+```bash
+$ gitraze user octocat
+
+[+] Fetching user data...
+[✓] Done
+
+User: octocat
+-------------
+Name             : The Octocat
+Login            : octocat
+Id               : 583231
+Node_id          : MDQ6VXNlcjU4MzIzMQ==
+Type             : User
+User_view_type   : public
+Bio              : None
+Followers        : 22312
+Following        : 9
+Public_repos     : 8
+Public_gists     : 8
+Location         : San Francisco
+Profile_url      : https://github.com/octocat
+Created_at       : 25 Jan 2011
+Email            : None
+Twitter_username : None
+
+```
+
+> Commands prefixed with `$` should be run in your terminal.
+
+### Gitraze can also be used as a lightweight Python SDK.
+
+#### User:
+```python
+import gitraze as gz
+
+user = gz.user("octocat", output_format="compact")
+
+print(user["name"])
+print(user["followers"])
+```
+
+#### Repository:
+```python
+import gitraze as gz
+
+repo = gz.repo("torvalds", "linux", output_format="full")
+
+print(repo["name"])
+print(repo["owner"])
+```
+
+> Note: Unlike the CLI, the SDK accepts owner and repository name as separate arguments.
+
+#### Search: 
+
+```python
+import gitraze as gz
+
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
+
+for repo in results:
+    print(repo["full_name"])
+```
+
+### Custom Output Format:
+
+All three SDK functions support output customization:
+
+```python
+import gitraze as gz
+
+user = gz.user("octocat", output_format="full")
+repo = gz.repo("torvalds", "linux", output_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="full")
+```
+
+#### Available options are:
+
+* `output_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `output_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `output_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
+
+
+### Pretty-print results in terminal style:
+
+```python
+from gitraze import *
+
+display(user("octocat"))
+```
+
+Example output:
+
+```bash
+Name             : The Octocat
+Login            : octocat
+Id               : 583231
+Node_id          : MDQ6VXNlcjU4MzIzMQ==
+Type             : User
+User_view_type   : public
+Bio              : None
+Followers        : 22578
+Following        : 9
+Public_repos     : 8
+Public_gists     : 8
+Location         : San Francisco
+Profile_url      : https://github.com/octocat
+Created_at       : 25 Jan 2011
+Email            : None
+Twitter_username : None
+```
+
+> Note: **`import gitraze as gz`** is the recommended import.
+
+> Note: Exact fields and values may differ from the examples shown, depending on the GitHub API response.
+
+## Available exports:
+
+### Functions: 
+
+- `user(username, output_format="compact")`
+- `repo(owner, repo, output_format="compact")`
+- `search(category, query, limit=1, output_format="compact")`
+- `display(data)`
+
+### Constants:
+
+- `USERS`
+- `REPOS`
+- `PRS`
+- `ISSUES`
+- `TOPICS`
+
+> Constants depend on the module internals and may change without prior notice.
+
+> CLI commands and SDK APIs are still evolving and may change between releases.
+
+
+## Philosophy
+
+Gitraze is built for speed, clarity, and control.
+
+No GUI. 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.
+
+## Development Setup
+
+Clone the repo and install locally:
+
+```bash
+git clone https://github.com/akpandey-dev/gitraze.git
+cd gitraze
+pip install -e .
+```
+
+## Project Status
+
+Gitraze is in active development:
+
+- Expect breaking changes
+- Some commands may not work
+- Features are being added rapidly
+- GraphQL feature is basically absent now, but integration is planned; currently REST-focused.
+
+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.2.5 → gitraze-0.3.0}/gitraze/__init__.py

@@ -2,7 +2,7 @@ from .modules.user import get_user_rest as user
 from .modules.repo import get_repo_rest as repo
 from .modules.search import get_search_rest as search
 
-from .utils.helpers import pretty_print as display
+from .utils.helpers import display
 
 __version__ = "0.2.5"
 

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

@@ -15,32 +15,35 @@ def main():
     parser.add_argument(
         "--version",
         action="version",
-        version="gitraze 0.2.5"
+        version="gitraze 0.3.0"
     )
 
     subparsers = parser.add_subparsers(dest="command", required=True)
 
-    # --- USER ---
+    # 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.set_defaults(func=handle_user)
 
 
-    # --- REPO ---
+    # 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.set_defaults(func=handle_repo)
 
 
-    # --- SEARCH ---
+    # SEARCH 
     search_parser = subparsers.add_parser("search", help="Search GitHub")
     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.set_defaults(func=handle_search)
 
 
-    # --- ANALYZE ---
+    # ANALYZE 
     analyze_parser = subparsers.add_parser("analyze", help="Analyze target")
     analyze_parser.add_argument("target", nargs="+")
     analyze_parser.set_defaults(func=handle_analysis)

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze/handlers/repo.py

@@ -1,3 +1,4 @@
+import json
 from gitraze.utils.helpers import pretty_print
 from gitraze.modules.repo import get_repo_rest
 
@@ -9,11 +10,15 @@ def handle_repo(args):
         print("Invalid format. Use: owner/repo")
         return
     owner, repo = parts
-    data = get_repo_rest(owner, repo)
+    data = get_repo_rest(owner, repo, output_format=args.format)
 
     if "error" in data:
         print(data["error"])
         return
 
     print("[✓] Done")
+
+    if args.format == "raw":
+        print(json.dumps(data, indent=2))
+        return
     pretty_print(data, title=f"User: {owner}, Repository: {repo}")

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze/handlers/search.py

@@ -1,3 +1,4 @@
+import json
 from gitraze.utils.helpers import pretty_print
 from gitraze.modules.search import get_search_rest
 
@@ -11,7 +12,7 @@ def handle_search(args):
     print(f"[+] Searching {category} for {query}...")
 
 
-    data = get_search_rest(category, query, args.limit)
+    data = get_search_rest(category, query, args.limit, output_format=args.format)
 
     if "error" in data:
         print(data["error"])
@@ -19,6 +20,10 @@ def handle_search(args):
 
     print("[✓] Done")
 
+    if args.format == "raw":
+        print(json.dumps(data, indent=2))
+        return
+
     if isinstance(data, list):
         for i, item in enumerate(data, 1):
             pretty_print(item, title=f"{category} [{i}] -> {query}")

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze/handlers/user.py

@@ -1,13 +1,19 @@
+import json
 from gitraze.utils.helpers import pretty_print
 from gitraze.modules.user import get_user_rest
 
 def handle_user(args):
     print("[+] Fetching user data...")
-    data = get_user_rest(args.username)
+    data = get_user_rest(args.username, output_format=args.format)
 
     if "error" in data:
         print(data["error"])
         return
 
     print("[✓] Done")
+    
+    if args.format == "raw":
+        print(json.dumps(data, indent=2))
+        return
+
     pretty_print(data, title=f"User: {args.username}")

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

@@ -1,13 +1,19 @@
 # repo.py
 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):
+def get_repo_rest(owner, repo, output_format="compact"):
     data = rest_get_repo(owner, repo)
 
     if "error" in data:
         return data
-    
+
+    if output_format == "raw":
+        return data
+    if output_format == "full":
+        return normalize_api_data(data)
+        
     return {
         "name": data.get("name"),
         "full_name": data.get("full_name"),

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

@@ -1,12 +1,16 @@
 # search.py
 from gitraze.utils.helpers import format_date 
 from gitraze.utils.helpers import clean_html
+from gitraze.utils.helpers import normalize_api_data
 from gitraze.core.api_rest import get_search
 
 
-def get_search_rest(category, query,  limit=1):
+def get_search_rest(category, query,  limit=1, output_format="compact"):
     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"}
+
     data = get_search(category, query)
     if "error" in data:
         return data
@@ -20,6 +24,12 @@ def get_search_rest(category, query,  limit=1):
     if not items:
         return {"error": "No results found"}
     items = items[:limit]
+
+    if output_format == "raw":
+        return items
+    if output_format == "full":
+        return [normalize_api_data(item) for item in items]
+
     results = []
 
     for item in items:
@@ -41,7 +51,6 @@ def get_search_rest(category, query,  limit=1):
                 "visibility": item.get("visibility"),
                 "default_branch": item.get("default_branch"),
                 "owner": item.get("owner", {}).get("login"),
-                "For More, use": "$ gitraze repo <owner/repo>"
             })
 
             case "users":
@@ -55,7 +64,6 @@ def get_search_rest(category, query,  limit=1):
                 "followers_url": item.get("followers_url"),
                 "following_url": item.get("following_url"),
                 "organizations_url": item.get("organizations_url"),
-                "For More, use": "$ gitraze user <username>"
             })
 
             case "issues":

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

@@ -1,13 +1,20 @@
 # user.py
 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):
+def get_user_rest(username, output_format="compact"):
     data = rest_get_user(username)
 
     if "error" in data:
         return data
 
+
+    if output_format == "raw":
+        return data
+    if output_format == "full":
+        return normalize_api_data(data)
+
     return {
         "name": data.get("name"),
         "login": data.get("login"),

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze/utils/helpers.py

@@ -30,6 +30,24 @@ def pretty_print(data, title=None):
 
     print()  # spacing
 
+def display(data, title=None):
+
+    if isinstance(data, list):
+
+        if not data:
+            print(Fore.RED + "No results found")
+            return
+
+        for i, item in enumerate(data, 1):
+
+            item_title = f"{title} [{i}]" if title else f"Result [{i}]"
+
+            pretty_print(item, title=item_title)
+
+        return
+
+    pretty_print(data, title=f"Result: ")
+
 def format_date(date_str):
     if not date_str:
         return None
@@ -40,4 +58,19 @@ def format_date(date_str):
         return date_str  # fallback (don’t crash)
 
 def clean_html(text):
-    return re.sub(r"<.*?>", "", text) if text else text
+    return re.sub(r"<.*?>", "", text) if text else text
+
+def normalize_api_data(data):
+    cleaned = {}
+
+    for key, value in data.items():
+
+        if key.endswith("_at") and isinstance(value, str):
+            value = format_date(value)
+
+        if isinstance(value, str):
+            value = clean_html(value)
+
+        cleaned[key] = value
+
+    return cleaned

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.2.5
+Version: 0.3.0
 Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
 Author: AK Pandey
 License-Expression: MIT
@@ -19,12 +19,22 @@ Dynamic: license-file
 
 > A fast, hacker-style CLI for slicing through GitHub data like a blade.
 
-Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using both REST and GraphQL APIs — all from your terminal.
+Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using REST, with GraphQL support coming soon; all from your terminal.
 
 ⚠️ **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)
+
 
 ---
 
@@ -58,10 +68,19 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 
 ## Installation
 
+### From PyPI using `pip`
+
 ```bash
 pip install gitraze
 ```
 
+### Using source code from Repository
+
+> Read the `Development setup` section.
+
+---
+> There may be some gap between releases on GitHub and PyPI, as more than one commits are sometimes clustered as a single release on PyPI.
+
 
 ## Usage
 
@@ -69,14 +88,16 @@ pip install gitraze
 
 Example: 
 ```bash
+gitraze --version
 gitraze --help
-gitraze user octocat
-gitraze repo torvalds/linux  
-gitraze search repos "machine learning" -n 5 # Will show top 5 results, but it is optional flag
-gitraze analyze github # Coming soon!
+gitraze user octocat --format=raw 
+gitraze repo torvalds/linux --format=full # Query format must match
+gitraze search repos "machine learning" -n 5 --format=compact 
+gitraze analyze <target> # Coming soon!
 ```
 
 Example output:
+
 ```bash
 $ gitraze user octocat
 
@@ -103,6 +124,7 @@ Email            : None
 Twitter_username : None
 
 ```
+
 > Commands prefixed with `$` should be run in your terminal.
 
 ### Gitraze can also be used as a lightweight Python SDK.
@@ -111,21 +133,54 @@ Twitter_username : None
 ```python
 import gitraze as gz
 
-user = gz.user("octocat")
+user = gz.user("octocat", output_format="compact")
 
 print(user["name"])
 print(user["followers"])
 ```
 
+#### Repository:
+```python
+import gitraze as gz
+
+repo = gz.repo("torvalds", "linux", output_format="full")
+
+print(repo["name"])
+print(repo["owner"])
+```
+
+> Note: Unlike the CLI, the SDK accepts owner and repository name as separate arguments.
+
 #### Search: 
 
 ```python
-results = gz.search(gz.REPOS, "machine learning", 3)
+import gitraze as gz
+
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
 
 for repo in results:
     print(repo["full_name"])
 ```
 
+### Custom Output Format:
+
+All three SDK functions support output customization:
+
+```python
+import gitraze as gz
+
+user = gz.user("octocat", output_format="full")
+repo = gz.repo("torvalds", "linux", output_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, output_format="full")
+```
+
+#### Available options are:
+
+* `output_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `output_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `output_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
+
+
 ### Pretty-print results in terminal style:
 
 ```python
@@ -157,14 +212,16 @@ Twitter_username : None
 
 > Note: **`import gitraze as gz`** is the recommended import.
 
+> Note: Exact fields and values may differ from the examples shown, depending on the GitHub API response.
+
 ## Available exports:
 
 ### Functions: 
 
-- `user()`
-- `repo()`
-- `search()`
-- `display()`
+- `user(username, output_format="compact")`
+- `repo(owner, repo, output_format="compact")`
+- `search(category, query, limit=1, output_format="compact")`
+- `display(data)`
 
 ### Constants:
 
@@ -174,9 +231,10 @@ Twitter_username : None
 - `ISSUES`
 - `TOPICS`
 
+> Constants depend on the module internals and may change without prior notice.
 
+> CLI commands and SDK APIs are still evolving and may change between releases.
 
-⚠️ CLI commands are still evolving and may change.
 
 ## Philosophy
 
@@ -204,14 +262,17 @@ Gitraze is in active development:
 - Expect breaking changes
 - Some commands may not work
 - Features are being added rapidly
-- GraphQL feature is basically absent now, but is coming soon
+- GraphQL feature is basically absent now, but integration is planned; currently REST-focused.
 
-If you're here early — you're basically a beta tester 😈
+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

{gitraze-0.2.5 → gitraze-0.3.0}/gitraze.egg-info/SOURCES.txt

@@ -11,7 +11,6 @@ gitraze.egg-info/entry_points.txt
 gitraze.egg-info/requires.txt
 gitraze.egg-info/top_level.txt
 gitraze/core/__init__.py
-gitraze/core/api_graphql.py
 gitraze/core/api_rest.py
 gitraze/handlers/__init__.py
 gitraze/handlers/analyze.py

{gitraze-0.2.5 → gitraze-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitraze"
-version = "0.2.5"
+version = "0.3.0"
 description = "A CLI and Python library for GitHub reconnaissance, search, and analysis"
 authors = [{ name = "AK Pandey" }]
 dependencies = ["requests", "colorama"]

gitraze-0.2.5/README.md

@@ -1,209 +0,0 @@
-# Gitraze
-
-> A fast, hacker-style CLI for slicing through GitHub data like a blade.
-
-Gitraze is a powerful command-line tool designed to explore, analyze, and extract insights from GitHub using both REST and GraphQL APIs — all from your terminal.
-
-⚠️ **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.
-
-
----
-
-## Why Gitraze?
-
-Most GitHub tools are either slow, bloated, or UI-heavy.
-
-**Gitraze is different:**
--  Fast, minimal, no nonsense
--  Built for developers who think in terminals
--  Deep GitHub data access (REST + GraphQL)
--  Modular and extensible architecture
-
----
-
-## Features
-
--  Modular system (easy to extend and hack on)
--  CLI-first workflow
--  GitHub API integration (REST + GraphQL)
--  Repository insights
--  User analysis
--  Filter PRs vs issues automatically
--  Human-readable timestamps
--  Cleaned descriptions (HTML stripped)
--  Analytics modules (in progress)
--  Search users, repos, issues, PRs, and topics
-
-
----
-
-## Installation
-
-```bash
-pip install gitraze
-```
-
-
-## Usage
-
-### Run directly from your terminal:
-
-Example: 
-```bash
-gitraze --help
-gitraze user octocat
-gitraze repo torvalds/linux  
-gitraze search repos "machine learning" -n 5 # Will show top 5 results, but it is optional flag
-gitraze analyze github # Coming soon!
-```
-
-Example output:
-```bash
-$ gitraze user octocat
-
-[+] Fetching user data...
-[✓] Done
-
-User: octocat
--------------
-Name             : The Octocat
-Login            : octocat
-Id               : 583231
-Node_id          : MDQ6VXNlcjU4MzIzMQ==
-Type             : User
-User_view_type   : public
-Bio              : None
-Followers        : 22312
-Following        : 9
-Public_repos     : 8
-Public_gists     : 8
-Location         : San Francisco
-Profile_url      : https://github.com/octocat
-Created_at       : 25 Jan 2011
-Email            : None
-Twitter_username : None
-
-```
-> Commands prefixed with `$` should be run in your terminal.
-
-### Gitraze can also be used as a lightweight Python SDK.
-
-#### User:
-```python
-import gitraze as gz
-
-user = gz.user("octocat")
-
-print(user["name"])
-print(user["followers"])
-```
-
-#### Search: 
-
-```python
-results = gz.search(gz.REPOS, "machine learning", 3)
-
-for repo in results:
-    print(repo["full_name"])
-```
-
-### Pretty-print results in terminal style:
-
-```python
-from gitraze import *
-
-display(user("octocat"))
-```
-
-Example output:
-
-```bash
-Name             : The Octocat
-Login            : octocat
-Id               : 583231
-Node_id          : MDQ6VXNlcjU4MzIzMQ==
-Type             : User
-User_view_type   : public
-Bio              : None
-Followers        : 22578
-Following        : 9
-Public_repos     : 8
-Public_gists     : 8
-Location         : San Francisco
-Profile_url      : https://github.com/octocat
-Created_at       : 25 Jan 2011
-Email            : None
-Twitter_username : None
-```
-
-> Note: **`import gitraze as gz`** is the recommended import.
-
-## Available exports:
-
-### Functions: 
-
-- `user()`
-- `repo()`
-- `search()`
-- `display()`
-
-### Constants:
-
-- `USERS`
-- `REPOS`
-- `PRS`
-- `ISSUES`
-- `TOPICS`
-
-
-
-⚠️ CLI commands are still evolving and may change.
-
-## Philosophy
-
-Gitraze is built for speed, clarity, and control.
-
-No GUI. 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.
-
-## Development Setup
-
-Clone the repo and install locally:
-
-```bash
-git clone https://github.com/akpandey-dev/gitraze.git
-cd gitraze
-pip install -e .
-```
-
-## Project Status
-
-Gitraze is in active development:
-
-- Expect breaking changes
-- Some commands may not work
-- Features are being added rapidly
-- GraphQL feature is basically absent now, but is coming soon
-
-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.
-
-```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.2.5/gitraze/core/api_graphql.py

@@ -1 +0,0 @@
-# api_graphql.py