lazy-github 0.2.1__tar.gz → 0.2.2__tar.gz

{lazy_github-0.2.1 → lazy_github-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lazy-github
-Version: 0.2.1
+Version: 0.2.2
 Summary: A terminal UI for interacting with Github
 Author-email: Chris Chapline <gizmo385@users.noreply.github.com>
 Maintainer-email: Chris Chapline <gizmo385@users.noreply.github.com>
@@ -40,35 +40,34 @@ Requires-Dist: textual
 Requires-Dist: textual-dev
 Requires-Dist: click>=8.1.7
 
-# LazyGithub
-
-This is a **WIP** terminal UI client for interacting with [GitHub](https://github.com). It draws heavy
-inspiration from the [lazygit](https://github.com/jesseduffield/lazygit) project and uses
-[Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
+![PyPI - Version](https://img.shields.io/pypi/v/lazy-github) ![PyPI - Downloads](https://img.shields.io/pypi/dw/lazy-github)
 
+LazyGithub is a terminal UI client for interacting with [GitHub](https://github.com). It draws heavy inspiration from the
+[lazygit](https://github.com/jesseduffield/lazygit) project and uses [Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
 
 ![Example screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-conversation-ui.svg)
 
+## How to Use It
 
-Currently, it supports the following:
+You can run the [most recently built version](https://pypi.org/project/lazy-github/) by installing it from PyPI. If you have [uv installed](https://github.com/astral-sh/uv), you can do that easily with `uvx lazy-github`.
 
+When you first start LazyGithub, you will be prompted with a device login code and a link to GitHub
+where you will be able to authenticate the app against your account. This allows the app to act on
+your behalf and is necessary for LazyGithub to function.
+
+Currently, it supports the following:
 
 - Listing the repositories associated with your account 
-- Listing the issues and pull requests on those repositories
+- Listing the issues, pull requests, and actions on your repositories
 - Listing the details, diff, and reviews on any of those pull requests
-- Detailed issue views, including conversation participation
+- Detailed issue and pull request views, including conversation participation
 
-Planned features:
-- Local caching, improving reload times and making it easier to use within a terminal or editor
-  environment.
-- A more wholeistic summary view for the currently selected repository
-- The ability to list, view, and trigger actions on a repository
-- More fleshed out PR interactions, including commenting and eventually submitting full PR reviews
-  from within your terminal.
+If you wish to run it from a local clone of the repository, you can do so by running the `./start.sh` located in the root of the repo.
 
+## Customization
 
-## Running Locally
+LazyGithub supports a number of customization options, all of which are stored in `$HOME/.config/lazy-github/config.json`.
+These can be edited manually via changing the config or by opening the settings management UI within LazyGithub. That UI
+can be accessed via the command pallete (`CMD+p`) and then searching for settings.
 
-If you have [uv](https://github.com/astral-sh/uv) installed, then you can try LazyGithub by running
-`uvx lazy-github`. Alternatively, you can pull the repo and run it locally by running the
-`./start.sh` script in the root of the repo.
+![Settings screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-settings-ui.png)

lazy_github-0.2.2/README.md

@@ -0,0 +1,31 @@
+![PyPI - Version](https://img.shields.io/pypi/v/lazy-github) ![PyPI - Downloads](https://img.shields.io/pypi/dw/lazy-github)
+
+LazyGithub is a terminal UI client for interacting with [GitHub](https://github.com). It draws heavy inspiration from the
+[lazygit](https://github.com/jesseduffield/lazygit) project and uses [Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
+
+![Example screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-conversation-ui.svg)
+
+## How to Use It
+
+You can run the [most recently built version](https://pypi.org/project/lazy-github/) by installing it from PyPI. If you have [uv installed](https://github.com/astral-sh/uv), you can do that easily with `uvx lazy-github`.
+
+When you first start LazyGithub, you will be prompted with a device login code and a link to GitHub
+where you will be able to authenticate the app against your account. This allows the app to act on
+your behalf and is necessary for LazyGithub to function.
+
+Currently, it supports the following:
+
+- Listing the repositories associated with your account 
+- Listing the issues, pull requests, and actions on your repositories
+- Listing the details, diff, and reviews on any of those pull requests
+- Detailed issue and pull request views, including conversation participation
+
+If you wish to run it from a local clone of the repository, you can do so by running the `./start.sh` located in the root of the repo.
+
+## Customization
+
+LazyGithub supports a number of customization options, all of which are stored in `$HOME/.config/lazy-github/config.json`.
+These can be edited manually via changing the config or by opening the settings management UI within LazyGithub. That UI
+can be accessed via the command pallete (`CMD+p`) and then searching for settings.
+
+![Settings screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-settings-ui.png)

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/cli.py

@@ -6,8 +6,10 @@ from lazy_github.lib.config import _CONFIG_FILE_LOCATION, Config
 from lazy_github.lib.context import LazyGithubContext
 from lazy_github.ui.app import app
 
+_CLI_CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
-@click.group(invoke_without_command=True)
+
+@click.group(invoke_without_command=True, context_settings=_CLI_CONTEXT_SETTINGS)
 @click.pass_context
 def cli(ctx: click.Context) -> None:
     """A Terminal UI for interacting with Github"""

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/lib/config.py

@@ -16,11 +16,13 @@ ISSUE_OWNER_FILTER = Literal["mine"] | Literal["all"]
 
 
 class ApiConfig(BaseModel):
+    """Controlling how the GitHub API is accessed in LazyGithub"""
+
     base_url: str = "https://api.github.com"
 
 
 class PullRequestSettings(BaseModel):
-    """Changes how PRs are retrieved from the Github API"""
+    """Changes how pull requests are retrieved from the Github API"""
 
     state_filter: IssueStateFilter = IssueStateFilter.ALL
     owner_filter: IssueOwnerFilter = IssueOwnerFilter.ALL
@@ -34,10 +36,14 @@ class IssueSettings(BaseModel):
 
 
 class RepositorySettings(BaseModel):
+    """Repository-specific settings"""
+
     favorites: list[str] = []
 
 
 class CacheSettings(BaseModel):
+    """Settings that control how long data will be cached from the GitHub API"""
+
     cache_directory: Path = CONFIG_FOLDER / ".cache"
     default_ttl: int = int(timedelta(minutes=10).total_seconds())
     list_repos_ttl: int = int(timedelta(days=1).total_seconds())
@@ -45,6 +51,8 @@ class CacheSettings(BaseModel):
 
 
 class AppearanceSettings(BaseModel):
+    """Settings focused on altering the appearance of LazyGithub, including hiding or showing different sections."""
+
     theme: Theme = BUILTIN_THEMES["textual-dark"]
     # Settings to configure which UI elements to display by default
     show_command_log: bool = True
@@ -67,18 +75,25 @@ class CoreConfig(BaseModel):
     logfile_path: Path = CONFIG_FOLDER / "lazy_github.log"
 
 
+class NotificationSettings(BaseModel):
+    """Controls the settings for the optional notification feature, which relies on the standard GitHub CLI."""
+
+    enabled: bool = False
+    show_all_notifications: bool = True
+
+
 _CONFIG_INSTANCE: Optional["Config"] = None
 
 
 class Config(BaseModel):
-    # This field is aliased because I can't spell :)
     appearance: AppearanceSettings = AppearanceSettings()
+    notifications: NotificationSettings = NotificationSettings()
     repositories: RepositorySettings = RepositorySettings()
     pull_requests: PullRequestSettings = PullRequestSettings()
     issues: IssueSettings = IssueSettings()
     cache: CacheSettings = CacheSettings()
-    api: ApiConfig = ApiConfig()
     core: CoreConfig = CoreConfig()
+    api: ApiConfig = ApiConfig()
 
     @classmethod
     def load_config(cls) -> "Config":

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/lib/constants.py

@@ -15,6 +15,8 @@ IS_NOT_FAVORITED = "☆"
 IS_PRIVATE = "✔"
 IS_PUBLIC = "✘"
 
+NOTIFICATION_REFRESH_INTERVAL = 60
+
 CONFIG_FOLDER = Path.home() / ".config/lazy-github"
 
 

lazy_github-0.2.2/lazy_github/lib/github_cli.py

@@ -0,0 +1,37 @@
+import asyncio
+from asyncio.subprocess import Process, PIPE
+import json
+
+NOTIFICATIONS_PAGE_COUNT = 30
+
+
+async def _run_gh_cli_command(command: str) -> Process:
+    """Simple wrapper around running a Github CLI command"""
+    return await asyncio.create_subprocess_shell(f"gh {command}", stdout=PIPE, stderr=PIPE)
+
+
+async def is_logged_in() -> bool:
+    """Checks to see if the user is currently logged into the GitHub CLI"""
+    try:
+        result = await _run_gh_cli_command("auth status")
+        await result.wait()
+        return result.returncode == 0
+    except Exception:
+        return False
+
+
+async def fetch_notifications(all: bool) -> list[str]:
+    """Fetches notifications on GitHub. If all=True, then previously read notifications will also be returned"""
+    result = await _run_gh_cli_command(f'api "/notifications?all={str(all).lower()}"')
+    await result.wait()
+    notifications: list[str] = []
+    if result.stdout:
+        stdout = await result.stdout.read()
+        parsed = json.loads(stdout.decode())
+        notifications = [n["subject"]["title"] for n in parsed]
+    return notifications
+
+
+async def unread_notification_count() -> int:
+    """Returns the number of currently unread notifications on GitHub"""
+    return len(await fetch_notifications(all=False))

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/models/github.py

@@ -145,7 +145,7 @@ class WorkflowState(StrEnum):
     DELETED = "deleted"
     DISABLED_FORK = "disabled_fork"
     DISABLED_INACTIVITY = "disabled_inactivity"
-    DISABLED_MANUALLY = "disabled_manually "
+    DISABLED_MANUALLY = "disabled_manually"
 
 
 class Workflow(BaseModel):

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/ui/app.py

@@ -26,7 +26,7 @@ class LazyGithub(App):
     async def on_ready(self):
         await self.authenticate_with_github()
 
-    def on_settings_modal_dismissed(self, message: SettingsModalDismissed) -> None:
+    async def on_settings_modal_dismissed(self, message: SettingsModalDismissed) -> None:
         if not message.changed:
             return
 

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/ui/screens/primary.py

@@ -5,14 +5,17 @@ from httpx import HTTPError
 from textual import work
 from textual.app import ComposeResult
 from textual.command import Hit, Hits, Provider
-from textual.containers import Container
+from textual.containers import Container, Horizontal
+from textual.timer import Timer
 from textual.reactive import reactive
 from textual.screen import Screen
 from textual.types import IgnoreReturnCallbackType
 from textual.widget import Widget
 from textual.widgets import Footer, TabbedContent
 
+from lazy_github.lib.constants import NOTIFICATION_REFRESH_INTERVAL
 from lazy_github.lib.context import LazyGithubContext
+from lazy_github.lib.github_cli import is_logged_in, unread_notification_count
 from lazy_github.lib.logging import lg
 from lazy_github.lib.github.issues import list_issues
 from lazy_github.lib.github.pull_requests import get_full_pull_request
@@ -51,17 +54,46 @@ class CurrentlySelectedRepo(Widget):
             return "No repository selected"
 
 
+class UnreadNotifications(Widget):
+    notification_count: reactive[int | None] = reactive(None)
+
+    def render(self):
+        if self.notification_count is None:
+            return ""
+        elif self.notification_count == 0:
+            return "[green]No unread notifications[/green]"
+        else:
+            count = f"{self.notification_count}+" if self.notification_count >= 30 else str(self.notification_count)
+            return f"[red]• Unread Notifications: {count}[/red]"
+
+
 class LazyGithubStatusSummary(Container):
     DEFAULT_CSS = """
     LazyGithubStatusSummary {
         max-height: 3;
         width: 100%;
+        max-width: 100%;
+        layout: horizontal;
         border: solid $secondary;
     }
+
+    CurrentlySelectedRepo {
+        max-width: 50%;
+        height: 100%;
+        content-align: left middle;
+    }
+
+    UnreadNotifications {
+        height: 100%;
+        max-width: 50%;
+        content-align: right middle;
+    }
     """
 
     def compose(self):
-        yield CurrentlySelectedRepo(id="currently_selected_repo")
+        with Horizontal():
+            yield CurrentlySelectedRepo(id="currently_selected_repo")
+            yield UnreadNotifications(id="unread_notifications")
 
 
 class SelectionDetailsContainer(LazyGithubContainer):
@@ -128,7 +160,6 @@ class SelectionsPane(Container):
         yield workflows
 
     def update_displayed_sections(self) -> None:
-        lg.debug("Updating displayed UI components after settings update")
         self.pull_requests.display = LazyGithubContext.config.appearance.show_pull_requests
         self.issues.display = LazyGithubContext.config.appearance.show_issues
         self.workflows.display = LazyGithubContext.config.appearance.show_workflows
@@ -279,6 +310,16 @@ class MainScreenCommandProvider(Provider):
             ),
             LazyGithubCommand("Change Settings", self.screen.action_show_settings_modal, "Adjust LazyGithub settings"),
         ]
+
+        if LazyGithubContext.config.notifications.enabled:
+            _commands.append(
+                LazyGithubCommand(
+                    "Refresh notifications",
+                    self.screen.action_refresh_notifications,
+                    "Refresh the unread notifications count",
+                )
+            )
+
         return tuple(_commands)
 
     async def search(self, query: str) -> Hits:
@@ -295,6 +336,7 @@ class MainScreenCommandProvider(Provider):
 
 class LazyGithubMainScreen(Screen):
     COMMANDS = {MainScreenCommandProvider}
+    notification_refresh_timer: Timer | None = None
 
     def compose(self):
         with Container():
@@ -302,6 +344,33 @@ class LazyGithubMainScreen(Screen):
             yield MainViewPane()
             yield Footer()
 
+    async def on_mount(self) -> None:
+        if LazyGithubContext.config.notifications.enabled:
+            self.refresh_notification_count()
+            if self.notification_refresh_timer is None:
+                self.notification_refresh_timer = self.set_interval(
+                    NOTIFICATION_REFRESH_INTERVAL, self.refresh_notification_count
+                )
+
+    @work
+    async def refresh_notification_count(self) -> None:
+        widget = self.query_one("#unread_notifications", UnreadNotifications)
+        if LazyGithubContext.config.notifications.enabled:
+            if not await is_logged_in():
+                error_message = "Cannot load notifications - please login to the gh CLI: gh auth login"
+                self.notify(error_message, title="Failed to Load Notifiations", severity="error")
+                lg.error(error_message)
+                return
+
+            unread_count = await unread_notification_count()
+            widget.notification_count = unread_count
+        else:
+            widget.notification_count = None
+
+    async def action_refresh_notifications(self) -> None:
+        """Action handler that retriggers the notification loading"""
+        self.refresh_notification_count()
+
     async def action_toggle_ui(self, ui_to_hide: str):
         widget = self.query_one(f"#{ui_to_hide}", Widget)
         widget.display = not widget.display
@@ -312,5 +381,11 @@ class LazyGithubMainScreen(Screen):
     def handle_settings_update(self) -> None:
         self.query_one("#selections_pane", SelectionsPane).update_displayed_sections()
 
+        self.refresh_notification_count()
+        if self.notification_refresh_timer is None:
+            self.notification_refresh_timer = self.set_interval(
+                NOTIFICATION_REFRESH_INTERVAL, self.refresh_notification_count
+            )
+
     def on_repo_selected(self, message: RepoSelected) -> None:
         self.query_one("#currently_selected_repo", CurrentlySelectedRepo).current_repo_name = message.repo.full_name

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/ui/screens/settings.py

@@ -66,7 +66,7 @@ class FieldSetting(Container):
         self.value = value
 
     def compose(self) -> ComposeResult:
-        yield Label(f"{_field_name_to_readable_name(self.field_name)}:")
+        yield Label(f"[bold]{_field_name_to_readable_name(self.field_name)}:[/bold]")
         yield self._field_to_widget()
 
 
@@ -76,6 +76,10 @@ class SettingsSection(Vertical):
         border: blank white;
         height: auto;
     }
+
+    Markdown {
+        margin-bottom: 1;
+    }
     """
 
     def __init__(self, parent_field_name: str, model: BaseModel) -> None:
@@ -85,8 +89,11 @@ class SettingsSection(Vertical):
         self.fields = model.model_fields
 
     def compose(self) -> ComposeResult:
-        yield Markdown(f"## {_field_name_to_readable_name(self.parent_field_name)}")
+        setting_description = self.model.__doc__ or ""
+        yield Markdown(f"## {_field_name_to_readable_name(self.parent_field_name)}\n{setting_description}".strip())
         for field_name, field_info in self.fields.items():
+            if field_info.exclude:
+                continue
             current_value = getattr(self.model, field_name)
             yield FieldSetting(field_name, field_info, current_value)
 

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github/ui/widgets/info.py

@@ -13,15 +13,19 @@ retrieved and displayed below it.
 
 ## Pull Requests
 
-TODO
+You can interact with a PR by viewing its details, viewing the PR diff, and participating in any active conversations
+happening on the PR. You can also create a new PR for the currently selected repo. It doesn't currently support merging
+a PR from within LazyGithub.
 
 ## Issues
 
-TODO
+You can interact with an issue by viewing its details, partipcating in any activate conversations happening on the
+issue, and by editing the issue itself. This means that you can close an issue from within LazyGithub.
 
 ## Actions
 
-WIP
+Github action and workflow support is pretty limited. It currently only supports listing the workflows and the most
+recent runs across all actions on the currently selected repo.
 """.strip()
 
 

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lazy-github
-Version: 0.2.1
+Version: 0.2.2
 Summary: A terminal UI for interacting with Github
 Author-email: Chris Chapline <gizmo385@users.noreply.github.com>
 Maintainer-email: Chris Chapline <gizmo385@users.noreply.github.com>
@@ -40,35 +40,34 @@ Requires-Dist: textual
 Requires-Dist: textual-dev
 Requires-Dist: click>=8.1.7
 
-# LazyGithub
-
-This is a **WIP** terminal UI client for interacting with [GitHub](https://github.com). It draws heavy
-inspiration from the [lazygit](https://github.com/jesseduffield/lazygit) project and uses
-[Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
+![PyPI - Version](https://img.shields.io/pypi/v/lazy-github) ![PyPI - Downloads](https://img.shields.io/pypi/dw/lazy-github)
 
+LazyGithub is a terminal UI client for interacting with [GitHub](https://github.com). It draws heavy inspiration from the
+[lazygit](https://github.com/jesseduffield/lazygit) project and uses [Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
 
 ![Example screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-conversation-ui.svg)
 
+## How to Use It
 
-Currently, it supports the following:
+You can run the [most recently built version](https://pypi.org/project/lazy-github/) by installing it from PyPI. If you have [uv installed](https://github.com/astral-sh/uv), you can do that easily with `uvx lazy-github`.
 
+When you first start LazyGithub, you will be prompted with a device login code and a link to GitHub
+where you will be able to authenticate the app against your account. This allows the app to act on
+your behalf and is necessary for LazyGithub to function.
+
+Currently, it supports the following:
 
 - Listing the repositories associated with your account 
-- Listing the issues and pull requests on those repositories
+- Listing the issues, pull requests, and actions on your repositories
 - Listing the details, diff, and reviews on any of those pull requests
-- Detailed issue views, including conversation participation
+- Detailed issue and pull request views, including conversation participation
 
-Planned features:
-- Local caching, improving reload times and making it easier to use within a terminal or editor
-  environment.
-- A more wholeistic summary view for the currently selected repository
-- The ability to list, view, and trigger actions on a repository
-- More fleshed out PR interactions, including commenting and eventually submitting full PR reviews
-  from within your terminal.
+If you wish to run it from a local clone of the repository, you can do so by running the `./start.sh` located in the root of the repo.
 
+## Customization
 
-## Running Locally
+LazyGithub supports a number of customization options, all of which are stored in `$HOME/.config/lazy-github/config.json`.
+These can be edited manually via changing the config or by opening the settings management UI within LazyGithub. That UI
+can be accessed via the command pallete (`CMD+p`) and then searching for settings.
 
-If you have [uv](https://github.com/astral-sh/uv) installed, then you can try LazyGithub by running
-`uvx lazy-github`. Alternatively, you can pull the repo and run it locally by running the
-`./start.sh` script in the root of the repo.
+![Settings screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-settings-ui.png)

{lazy_github-0.2.1 → lazy_github-0.2.2}/lazy_github.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ lazy_github/lib/config.py
 lazy_github/lib/constants.py
 lazy_github/lib/context.py
 lazy_github/lib/git_cli.py
+lazy_github/lib/github_cli.py
 lazy_github/lib/logging.py
 lazy_github/lib/messages.py
 lazy_github/lib/utils.py

{lazy_github-0.2.1 → lazy_github-0.2.2}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "lazy-github"
 description = "A terminal UI for interacting with Github"
 readme = "README.md"
-version = "0.2.1"
+version = "0.2.2"
 authors = [
 	{ name = "Chris Chapline", email = "gizmo385@users.noreply.github.com" },
 ]

lazy_github-0.2.1/README.md

@@ -1,32 +0,0 @@
-# LazyGithub
-
-This is a **WIP** terminal UI client for interacting with [GitHub](https://github.com). It draws heavy
-inspiration from the [lazygit](https://github.com/jesseduffield/lazygit) project and uses
-[Textual](https://textual.textualize.io/) to drive the terminal UI interactions.
-
-
-![Example screenshot](https://raw.githubusercontent.com/gizmo385/lazy-github/main/images/lazy-github-conversation-ui.svg)
-
-
-Currently, it supports the following:
-
-
-- Listing the repositories associated with your account 
-- Listing the issues and pull requests on those repositories
-- Listing the details, diff, and reviews on any of those pull requests
-- Detailed issue views, including conversation participation
-
-Planned features:
-- Local caching, improving reload times and making it easier to use within a terminal or editor
-  environment.
-- A more wholeistic summary view for the currently selected repository
-- The ability to list, view, and trigger actions on a repository
-- More fleshed out PR interactions, including commenting and eventually submitting full PR reviews
-  from within your terminal.
-
-
-## Running Locally
-
-If you have [uv](https://github.com/astral-sh/uv) installed, then you can try LazyGithub by running
-`uvx lazy-github`. Alternatively, you can pull the repo and run it locally by running the
-`./start.sh` script in the root of the repo.