gitraze 0.2.4__tar.gz → 0.2.6__tar.gz

{gitraze-0.2.4 → gitraze-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.2.4
+Version: 0.2.6
 Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
 Author: AK Pandey
 License-Expression: MIT
@@ -65,7 +65,7 @@ pip install gitraze
 
 ## Usage
 
-Run directly from your terminal:
+### Run directly from your terminal:
 
 Example: 
 ```bash
@@ -103,14 +103,79 @@ Email            : None
 Twitter_username : None
 
 ```
-> 💡 Commands prefixed with `$` should be run in your terminal.
+> Commands prefixed with `$` should be run in your terminal.
 
-You can also use it inside Python:
+### Gitraze can also be used as a lightweight Python SDK.
 
+#### User:
 ```python
-import gitraze
+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
@@ -143,6 +208,18 @@ Gitraze is in active development:
 
 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.4 → gitraze-0.2.6}/README.md

@@ -48,7 +48,7 @@ pip install gitraze
 
 ## Usage
 
-Run directly from your terminal:
+### Run directly from your terminal:
 
 Example: 
 ```bash
@@ -86,14 +86,79 @@ Email            : None
 Twitter_username : None
 
 ```
-> 💡 Commands prefixed with `$` should be run in your terminal.
+> Commands prefixed with `$` should be run in your terminal.
 
-You can also use it inside Python:
+### Gitraze can also be used as a lightweight Python SDK.
 
+#### User:
 ```python
-import gitraze
+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
@@ -126,6 +191,18 @@ Gitraze is in active development:
 
 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.6/gitraze/__init__.py

@@ -0,0 +1,25 @@
+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 display
+
+__version__ = "0.2.5"
+
+USERS = "users"
+REPOS = "repos"
+PRS = "prs"
+ISSUES = "issues"
+TOPICS = "topics"
+
+__all__ = [
+    "display",
+    "user",
+    "repo",
+    "search",
+    "USERS",
+    "REPOS",
+    "PRS",
+    "ISSUES",
+    "TOPICS",
+]

{gitraze-0.2.4 → gitraze-0.2.6}/gitraze/cli.py

@@ -15,7 +15,7 @@ def main():
     parser.add_argument(
         "--version",
         action="version",
-        version="gitraze 0.2.4"
+        version="gitraze 0.2.6"
     )
 
     subparsers = parser.add_subparsers(dest="command", required=True)

{gitraze-0.2.4 → gitraze-0.2.6}/gitraze/modules/search.py

@@ -41,7 +41,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 +54,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.4 → gitraze-0.2.6}/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

{gitraze-0.2.4 → gitraze-0.2.6}/gitraze.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitraze
-Version: 0.2.4
+Version: 0.2.6
 Summary: A CLI and Python library for GitHub reconnaissance, search, and analysis
 Author: AK Pandey
 License-Expression: MIT
@@ -65,7 +65,7 @@ pip install gitraze
 
 ## Usage
 
-Run directly from your terminal:
+### Run directly from your terminal:
 
 Example: 
 ```bash
@@ -103,14 +103,79 @@ Email            : None
 Twitter_username : None
 
 ```
-> 💡 Commands prefixed with `$` should be run in your terminal.
+> Commands prefixed with `$` should be run in your terminal.
 
-You can also use it inside Python:
+### Gitraze can also be used as a lightweight Python SDK.
 
+#### User:
 ```python
-import gitraze
+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
@@ -143,6 +208,18 @@ Gitraze is in active development:
 
 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.4 → gitraze-0.2.6}/pyproject.toml

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