gitraze 0.3.0__tar.gz → 0.4.0__tar.gz

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.3.0
-Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
+Version: 0.4.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
@@ -17,9 +17,9 @@ Dynamic: license-file
 
 # Gitraze
 
-> A fast, hacker-style CLI for slicing through GitHub data like a blade.
+> A CLI and Python library for GitHub exploration, search, and analysis
 
-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.
+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.
 
@@ -45,7 +45,7 @@ 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)
+-  Deep GitHub data access through the REST API
 -  Modular and extensible architecture
 
 ---
@@ -54,7 +54,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 
 -  Modular system (easy to extend and hack on)
 -  CLI-first workflow
--  GitHub API integration (REST + GraphQL)
+-  GitHub API integration through REST; GraphQL planned
 -  Repository insights
 -  User analysis
 -  Filter PRs vs issues automatically
@@ -62,6 +62,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 -  Cleaned descriptions (HTML stripped)
 -  Analytics modules (in progress)
 -  Search users, repos, issues, PRs, and topics
+-  Three data formats
 
 
 ---
@@ -74,12 +75,12 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 pip install gitraze
 ```
 
-### Using source code from Repository
+### From source code
 
 > 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.
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
 
 
 ## Usage
@@ -90,9 +91,9 @@ 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 user octocat --data-format=raw 
+gitraze repo torvalds/linux --data-format=full
+gitraze search repos "machine learning" -n 5 --data-format=compact 
 gitraze analyze <target> # Coming soon!
 ```
 
@@ -133,7 +134,7 @@ Twitter_username : None
 ```python
 import gitraze as gz
 
-user = gz.user("octocat", output_format="compact")
+user = gz.user("octocat", data_format="compact")
 
 print(user["name"])
 print(user["followers"])
@@ -143,7 +144,7 @@ print(user["followers"])
 ```python
 import gitraze as gz
 
-repo = gz.repo("torvalds", "linux", output_format="full")
+repo = gz.repo("torvalds", "linux", data_format="full")
 
 print(repo["name"])
 print(repo["owner"])
@@ -156,29 +157,29 @@ print(repo["owner"])
 ```python
 import gitraze as gz
 
-results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
+results = gz.search(gz.REPOS, "machine learning", 3, data_format="compact")
 
 for repo in results:
     print(repo["full_name"])
 ```
 
-### Custom Output Format:
+### Data Formats:
 
-All three SDK functions support output customization:
+All three SDK functions support different data formats:
 
 ```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")
+user = gz.user("octocat", data_format="full")
+repo = gz.repo("torvalds", "linux", data_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, data_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.
+* `data_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `data_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `data_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
 
 
 ### Pretty-print results in terminal style:
@@ -218,9 +219,9 @@ Twitter_username : None
 
 ### Functions: 
 
-- `user(username, output_format="compact")`
-- `repo(owner, repo, output_format="compact")`
-- `search(category, query, limit=1, output_format="compact")`
+- `user(username, data_format="compact")`
+- `repo(owner, repo, data_format="compact")`
+- `search(category, query, limit=1, data_format="compact")`
 - `display(data)`
 
 ### Constants:
@@ -240,8 +241,7 @@ Twitter_username : None
 
 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.
+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.
 
@@ -262,7 +262,7 @@ 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.
+- GraphQL is not implemented yet; Gitraze is REST-focused for now.
 
 If you're here early — you're basically a beta tester.
 

{gitraze-0.3.0 → gitraze-0.4.0}/README.md

@@ -1,8 +1,8 @@
 # Gitraze
 
-> A fast, hacker-style CLI for slicing through GitHub data like a blade.
+> A CLI and Python library for GitHub exploration, search, and analysis
 
-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.
+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.
 
@@ -28,7 +28,7 @@ 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)
+-  Deep GitHub data access through the REST API
 -  Modular and extensible architecture
 
 ---
@@ -37,7 +37,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 
 -  Modular system (easy to extend and hack on)
 -  CLI-first workflow
--  GitHub API integration (REST + GraphQL)
+-  GitHub API integration through REST; GraphQL planned
 -  Repository insights
 -  User analysis
 -  Filter PRs vs issues automatically
@@ -45,6 +45,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 -  Cleaned descriptions (HTML stripped)
 -  Analytics modules (in progress)
 -  Search users, repos, issues, PRs, and topics
+-  Three data formats
 
 
 ---
@@ -57,12 +58,12 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 pip install gitraze
 ```
 
-### Using source code from Repository
+### From source code
 
 > 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.
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
 
 
 ## Usage
@@ -73,9 +74,9 @@ 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 user octocat --data-format=raw 
+gitraze repo torvalds/linux --data-format=full
+gitraze search repos "machine learning" -n 5 --data-format=compact 
 gitraze analyze <target> # Coming soon!
 ```
 
@@ -116,7 +117,7 @@ Twitter_username : None
 ```python
 import gitraze as gz
 
-user = gz.user("octocat", output_format="compact")
+user = gz.user("octocat", data_format="compact")
 
 print(user["name"])
 print(user["followers"])
@@ -126,7 +127,7 @@ print(user["followers"])
 ```python
 import gitraze as gz
 
-repo = gz.repo("torvalds", "linux", output_format="full")
+repo = gz.repo("torvalds", "linux", data_format="full")
 
 print(repo["name"])
 print(repo["owner"])
@@ -139,29 +140,29 @@ print(repo["owner"])
 ```python
 import gitraze as gz
 
-results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
+results = gz.search(gz.REPOS, "machine learning", 3, data_format="compact")
 
 for repo in results:
     print(repo["full_name"])
 ```
 
-### Custom Output Format:
+### Data Formats:
 
-All three SDK functions support output customization:
+All three SDK functions support different data formats:
 
 ```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")
+user = gz.user("octocat", data_format="full")
+repo = gz.repo("torvalds", "linux", data_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, data_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.
+* `data_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `data_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `data_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
 
 
 ### Pretty-print results in terminal style:
@@ -201,9 +202,9 @@ Twitter_username : None
 
 ### Functions: 
 
-- `user(username, output_format="compact")`
-- `repo(owner, repo, output_format="compact")`
-- `search(category, query, limit=1, output_format="compact")`
+- `user(username, data_format="compact")`
+- `repo(owner, repo, data_format="compact")`
+- `search(category, query, limit=1, data_format="compact")`
 - `display(data)`
 
 ### Constants:
@@ -223,8 +224,7 @@ Twitter_username : None
 
 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.
+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.
 
@@ -245,7 +245,7 @@ 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.
+- GraphQL is not implemented yet; Gitraze is REST-focused for now.
 
 If you're here early — you're basically a beta tester.
 

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

@@ -4,7 +4,7 @@ from .modules.search import get_search_rest as search
 
 from .utils.helpers import display
 
-__version__ = "0.2.5"
+__version__ = "0.4.0"
 
 USERS = "users"
 REPOS = "repos"

{gitraze-0.3.0 → gitraze-0.4.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.4.0"
     )
 
     subparsers = parser.add_subparsers(dest="command", required=True)
@@ -23,14 +25,14 @@ 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.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.set_defaults(func=handle_repo)
 
 
@@ -39,7 +41,7 @@ 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.set_defaults(func=handle_search)
 
 

{gitraze-0.3.0 → gitraze-0.4.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.4.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.4.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.3.0 → gitraze-0.4.0}/gitraze/handlers/repo.py

@@ -3,6 +3,8 @@ from gitraze.utils.helpers import 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("/")
     
@@ -10,7 +12,7 @@ def handle_repo(args):
         print("Invalid format. Use: owner/repo")
         return
     owner, repo = parts
-    data = get_repo_rest(owner, repo, output_format=args.format)
+    data = get_repo_rest(owner, repo, data_format=args.data_format)
 
     if "error" in data:
         print(data["error"])
@@ -18,7 +20,7 @@ def handle_repo(args):
 
     print("[✓] Done")
 
-    if args.format == "raw":
+    if args.data_format == "raw":
         print(json.dumps(data, indent=2))
         return
     pretty_print(data, title=f"User: {owner}, Repository: {repo}")

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

@@ -3,6 +3,8 @@ from gitraze.utils.helpers import 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)
@@ -12,7 +14,7 @@ def handle_search(args):
     print(f"[+] Searching {category} for {query}...")
 
 
-    data = get_search_rest(category, query, args.limit, output_format=args.format)
+    data = get_search_rest(category, query, args.limit, data_format=args.data_format)
 
     if "error" in data:
         print(data["error"])
@@ -20,7 +22,7 @@ def handle_search(args):
 
     print("[✓] Done")
 
-    if args.format == "raw":
+    if args.data_format == "raw":
         print(json.dumps(data, indent=2))
         return
 

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

@@ -3,8 +3,10 @@ from gitraze.utils.helpers import 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, output_format=args.format)
+    data = get_user_rest(args.username, data_format=args.data_format)
 
     if "error" in data:
         print(data["error"])
@@ -12,7 +14,7 @@ def handle_user(args):
 
     print("[✓] Done")
     
-    if args.format == "raw":
+    if args.data_format == "raw":
         print(json.dumps(data, indent=2))
         return
 

{gitraze-0.3.0 → gitraze-0.4.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.4.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.4.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 {

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

@@ -7,6 +7,8 @@ init(autoreset=True)
 
 
 def pretty_print(data, title=None):
+    """Print dictionary data as formatted key-value pairs."""
+
     if not isinstance(data, dict):
         print(Fore.RED + "Invalid data format")
         return
@@ -31,7 +33,8 @@ def pretty_print(data, title=None):
     print()  # spacing
 
 def display(data, title=None):
-
+    """Display dictionary or list data in a formatted terminal layout."""
+    
     if isinstance(data, list):
 
         if not data:
@@ -39,9 +42,7 @@ def display(data, title=None):
             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
@@ -49,6 +50,8 @@ def display(data, title=None):
     pretty_print(data, title=f"Result: ")
 
 def format_date(date_str):
+    """Format a GitHub API date string for display."""
+
     if not date_str:
         return None
 
@@ -58,11 +61,14 @@ def format_date(date_str):
         return date_str  # fallback (don’t crash)
 
 def clean_html(text):
+    """Remove HTML tags from text."""
+
     return re.sub(r"<.*?>", "", text) if text else text
 
 def normalize_api_data(data):
-    cleaned = {}
+    """Normalize API data for human-readable output."""
 
+    cleaned = {}
     for key, value in data.items():
 
         if key.endswith("_at") and isinstance(value, str):

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.3.0
-Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
+Version: 0.4.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
@@ -17,9 +17,9 @@ Dynamic: license-file
 
 # Gitraze
 
-> A fast, hacker-style CLI for slicing through GitHub data like a blade.
+> A CLI and Python library for GitHub exploration, search, and analysis
 
-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.
+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.
 
@@ -45,7 +45,7 @@ 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)
+-  Deep GitHub data access through the REST API
 -  Modular and extensible architecture
 
 ---
@@ -54,7 +54,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 
 -  Modular system (easy to extend and hack on)
 -  CLI-first workflow
--  GitHub API integration (REST + GraphQL)
+-  GitHub API integration through REST; GraphQL planned
 -  Repository insights
 -  User analysis
 -  Filter PRs vs issues automatically
@@ -62,6 +62,7 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 -  Cleaned descriptions (HTML stripped)
 -  Analytics modules (in progress)
 -  Search users, repos, issues, PRs, and topics
+-  Three data formats
 
 
 ---
@@ -74,12 +75,12 @@ Most GitHub tools are either slow, bloated, or UI-heavy.
 pip install gitraze
 ```
 
-### Using source code from Repository
+### From source code
 
 > 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.
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
 
 
 ## Usage
@@ -90,9 +91,9 @@ 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 user octocat --data-format=raw 
+gitraze repo torvalds/linux --data-format=full
+gitraze search repos "machine learning" -n 5 --data-format=compact 
 gitraze analyze <target> # Coming soon!
 ```
 
@@ -133,7 +134,7 @@ Twitter_username : None
 ```python
 import gitraze as gz
 
-user = gz.user("octocat", output_format="compact")
+user = gz.user("octocat", data_format="compact")
 
 print(user["name"])
 print(user["followers"])
@@ -143,7 +144,7 @@ print(user["followers"])
 ```python
 import gitraze as gz
 
-repo = gz.repo("torvalds", "linux", output_format="full")
+repo = gz.repo("torvalds", "linux", data_format="full")
 
 print(repo["name"])
 print(repo["owner"])
@@ -156,29 +157,29 @@ print(repo["owner"])
 ```python
 import gitraze as gz
 
-results = gz.search(gz.REPOS, "machine learning", 3, output_format="compact")
+results = gz.search(gz.REPOS, "machine learning", 3, data_format="compact")
 
 for repo in results:
     print(repo["full_name"])
 ```
 
-### Custom Output Format:
+### Data Formats:
 
-All three SDK functions support output customization:
+All three SDK functions support different data formats:
 
 ```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")
+user = gz.user("octocat", data_format="full")
+repo = gz.repo("torvalds", "linux", data_format="raw")
+results = gz.search(gz.REPOS, "machine learning", 3, data_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.
+* `data_format="compact"`: Returns a concise, human-friendly subset of the most useful fields.
+* `data_format="full"`: Returns all available processed fields exposed by Gitraze.
+* `data_format="raw"`: Returns the raw GitHub API response without filtering or formatting.
 
 
 ### Pretty-print results in terminal style:
@@ -218,9 +219,9 @@ Twitter_username : None
 
 ### Functions: 
 
-- `user(username, output_format="compact")`
-- `repo(owner, repo, output_format="compact")`
-- `search(category, query, limit=1, output_format="compact")`
+- `user(username, data_format="compact")`
+- `repo(owner, repo, data_format="compact")`
+- `search(category, query, limit=1, data_format="compact")`
 - `display(data)`
 
 ### Constants:
@@ -240,8 +241,7 @@ Twitter_username : None
 
 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.
+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.
 
@@ -262,7 +262,7 @@ 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.
+- GraphQL is not implemented yet; Gitraze is REST-focused for now.
 
 If you're here early — you're basically a beta tester.
 

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

@@ -1,7 +1,7 @@
 [project]
 name = "gitraze"
-version = "0.3.0"
-description = "A CLI and Python library for GitHub reconnaissance, search, and analysis"
+version = "0.4.0"
+description = "A CLI and Python library for GitHub exploration, search, and analysis"
 authors = [{ name = "AK Pandey" }]
 dependencies = ["requests", "colorama"]
 readme = "README.md"