gitraze 0.2.6__tar.gz → 0.4.0__tar.gz

gitraze-0.4.0/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.4
+Name: gitraze
+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
+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 different:**
+-  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 (easy to extend and hack on)
+-  CLI-first workflow
+-  GitHub API integration through REST; GraphQL planned
+-  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
+-  Three data formats
+
+
+---
+
+## Installation
+
+### From PyPI using `pip`
+
+```bash
+pip install gitraze
+```
+
+### From source code
+
+> Read the `Development setup` section.
+
+---
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
+
+
+## Usage
+
+### Run directly from your terminal:
+
+Example: 
+```bash
+gitraze --version
+gitraze --help
+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!
+```
+
+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", data_format="compact")
+
+print(user["name"])
+print(user["followers"])
+```
+
+#### Repository:
+```python
+import gitraze as gz
+
+repo = gz.repo("torvalds", "linux", data_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, data_format="compact")
+
+for repo in results:
+    print(repo["full_name"])
+```
+
+### Data Formats:
+
+All three SDK functions support different data formats:
+
+```python
+import gitraze as gz
+
+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:
+
+* `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:
+
+```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, data_format="compact")`
+- `repo(owner, repo, data_format="compact")`
+- `search(category, query, limit=1, data_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 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 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.4.0/README.md

@@ -0,0 +1,270 @@
+# 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 different:**
+-  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 (easy to extend and hack on)
+-  CLI-first workflow
+-  GitHub API integration through REST; GraphQL planned
+-  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
+-  Three data formats
+
+
+---
+
+## Installation
+
+### From PyPI using `pip`
+
+```bash
+pip install gitraze
+```
+
+### From source code
+
+> Read the `Development setup` section.
+
+---
+> There may be some gaps between releases on GitHub and PyPI, as multiple commits are sometimes clustered into a single release on PyPI.
+
+
+## Usage
+
+### Run directly from your terminal:
+
+Example: 
+```bash
+gitraze --version
+gitraze --help
+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!
+```
+
+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", data_format="compact")
+
+print(user["name"])
+print(user["followers"])
+```
+
+#### Repository:
+```python
+import gitraze as gz
+
+repo = gz.repo("torvalds", "linux", data_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, data_format="compact")
+
+for repo in results:
+    print(repo["full_name"])
+```
+
+### Data Formats:
+
+All three SDK functions support different data formats:
+
+```python
+import gitraze as gz
+
+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:
+
+* `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:
+
+```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, data_format="compact")`
+- `repo(owner, repo, data_format="compact")`
+- `search(category, query, limit=1, data_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 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 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.2.6 → 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.2.6 → gitraze-0.4.0}/gitraze/cli.py

@@ -6,41 +6,46 @@ 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.2.6"
+        version="gitraze 0.4.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("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data 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("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data 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("--data-format", choices=["compact", "full", "raw"], default="compact", help="Data 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.6 → 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.2.6 → 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.2.6 → 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.2.6 → gitraze-0.4.0}/gitraze/handlers/repo.py

@@ -1,7 +1,10 @@
+import json
 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("/")
     
@@ -9,11 +12,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, data_format=args.data_format)
 
     if "error" in data:
         print(data["error"])
         return
 
     print("[✓] Done")
+
+    if args.data_format == "raw":
+        print(json.dumps(data, indent=2))
+        return
     pretty_print(data, title=f"User: {owner}, Repository: {repo}")