feat: define initial ui and project structure #4

emy3 · 2025-10-11T14:13:06Z

📝 Description

Adding the initial project structure with UI folders and other folders

What does this PR do?

Structuring this project for better maintainability.

Why is this change necessary?

With more features and additions to the project, it will need to be structured better

🔄 Type of Change

🧪 Testing

Test Environment

Python version:
Docker version:
OS:

How Has This Been Tested?

Tested with multiple running containers
Tested with no running containers
Tested keyboard interrupt (Ctrl+C)
Verified color-coded output works correctly
Tested on different operating systems
Manually tested the changes
Added/updated unit tests
All existing tests pass

Test Commands

# Commands used to test the changes
python dockerLog.py

📋 Checklist

My code follows the project's code style
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation (README.md)
My changes generate no new warnings or errors
I have tested my changes locally
Any dependent changes have been merged and published
I have updated the requirements if new dependencies were added

📸 Screenshots/Output

Before

<!-- Paste output or screenshot from before the changes -->

After

<!-- Paste output or screenshot from after the changes -->

🔗 Related Issues

Closes #
Related to #

📝 Additional Notes

🔍 Reviewer Notes

Copilot

Pull Request Overview

This PR establishes the initial project structure for a Docker logs monitoring application, creating organized folders and base UI components for better maintainability.

Introduces a modular structure with separate packages for widgets, screens, services, and utilities
Creates foundational UI components including header, footer, controls, and metrics widgets
Sets up placeholder files for Docker services and configuration utilities

Reviewed Changes

Copilot reviewed 12 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/docker_logs/widgets/metrics_widget.py	Implements real-time metrics display widget with reactive properties for thread count, container count, and monitoring status
src/docker_logs/widgets/header.py	Creates custom header widget extending Textual's Header with app title and dynamic status display
src/docker_logs/widgets/footer.py	Defines basic footer widget extending Textual's Footer for keybindings display
src/docker_logs/widgets/controls_widget.py	Implements control panel with start/stop/refresh/clear buttons and corresponding message classes
src/docker_logs/widgets/init.py	Package initialization file with widget imports and exports
src/docker_logs/utils/config.py	Placeholder file for configuration utilities
src/docker_logs/utils/colors.py	Color management utility for assigning random colors to Docker containers
src/docker_logs/services/docker_services.py	Placeholder file for Docker-related services
src/docker_logs/screens/main_screen.py	Placeholder file for the main log viewer screen
src/docker_logs/screens/init.py	Package initialization file for screens module
src/docker_logs/dockerLog.py	Updated main app file with documentation header
layout.py	Example layout file demonstrating Textual app structure

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-13T20:21:07Z

src/docker_logs/widgets/__init__.py

+from ..widgets import Header, Footer, MetricsWidget, ControlsWidget, LogViewerWidget
+
+__all__ = [
+    "Header", 
+    "Footer", 
+    "MetricsWidget", 
+    "ControlsWidget", 
+    "LogViewerWidget"


The import statement references 'LogViewerWidget' which doesn't exist in any of the created files. This will cause an ImportError.

Suggested change

from ..widgets import Header, Footer, MetricsWidget, ControlsWidget, LogViewerWidget

__all__ = [

"Header",

"Footer",

"MetricsWidget",

"ControlsWidget",

"LogViewerWidget"

from ..widgets import Header, Footer, MetricsWidget, ControlsWidget

__all__ = [

"Header",

"Footer",

"MetricsWidget",

"ControlsWidget",

Copilot · 2025-10-13T20:21:07Z

src/docker_logs/screens/__init__.py

+from .main_screen import MainScreen
+
+__all__ = ["MainScreen"]


The import statement references 'MainScreen' class which doesn't exist in main_screen.py. The file only contains an import of textual.app.App.

Suggested change

from .main_screen import MainScreen

__all__ = ["MainScreen"]

__all__ = []

Copilot

Pull Request Overview

Copilot reviewed 14 out of 19 changed files in this pull request and generated 9 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-18T17:51:38Z

src/docker_logs/widgets/metrics_widget.py

+from textual.widget import static
+from textual.reactive import reactive
+from threading import active_count
+
+class MetricsWidget(static):


The import statement is incorrect. Textual's Static widget should be imported with a capital 'S': from textual.widgets import Static. The current lowercase 'static' will cause an ImportError.

Suggested change

from textual.widget import static

from textual.reactive import reactive

from threading import active_count

class MetricsWidget(static):

from textual.widgets import Static

from textual.reactive import reactive

from threading import active_count

class MetricsWidget(Static):

Copilot · 2025-10-18T17:51:38Z

src/docker_logs/widgets/metrics_widget.py

+from textual.widget import static
+from textual.reactive import reactive
+from threading import active_count
+
+class MetricsWidget(static):


The class inherits from 'static' (lowercase), but should inherit from 'Static' (capitalized). This is a consequence of the incorrect import on line 3 and will cause a NameError.

Suggested change

from textual.widget import static

from textual.reactive import reactive

from threading import active_count

class MetricsWidget(static):

from textual.widget import Static

from textual.reactive import reactive

from threading import active_count

class MetricsWidget(Static):

Copilot · 2025-10-18T17:51:39Z

src/docker_logs/widgets/log_viewer_widget.py

+        super().__init__(max_lines=max_lines)
+        self.max_lines = max_lines
+
+    def write_log(self, container_name: str, message: str, color:str) -> None:


Missing space after colon in the type annotation for 'color' parameter. Should be 'color: str' to conform to PEP 8 style guidelines.

Suggested change

def write_log(self, container_name: str, message: str, color:str) -> None:

def write_log(self, container_name: str, message: str, color: str) -> None:

Copilot · 2025-10-18T17:51:39Z

src/docker_logs/widgets/log_viewer_widget.py

@@ -0,0 +1,21 @@
+"""Log viewer widget."""
+
+from textual.widget import RichLog


Incorrect import path for RichLog. The correct import should be from textual.widgets import RichLog (plural 'widgets', not singular 'widget').

Suggested change

from textual.widget import RichLog

from textual.widgets import RichLog

Copilot · 2025-10-18T17:51:39Z

src/docker_logs/screens/main_screen.py

+    class StartMonitoring:
+        pass
+
+    class StopMonitoring:
+        pass
+
+    class ClearLogs:
+        pass
+
+    class RefreshContainers:
+        pass


These message classes don't inherit from textual.message.Message. They should inherit from Message to work properly with Textual's message handling system, similar to how they're defined in ControlsWidget.

Copilot · 2025-10-18T17:51:39Z

src/docker_logs/app.py

+from textual import on
+
+from .screens.main_screen import MainScreen
+from .services.docker_service import DockerService


Attempting to import DockerService from a file that only contains a docstring comment. The docker_service.py file needs to implement the DockerService class before this import will work.

Copilot · 2025-10-18T17:51:39Z

src/docker_logs/app.py

+from .utils.config import config
+


Attempting to import config from a file that only contains a docstring comment. The config.py file needs to define the config object with attributes like 'default_colors' and 'update_interval' before this import will work.

Suggested change

from .utils.config import config

try:

from .utils.config import config

except ImportError:

from types import SimpleNamespace

config = SimpleNamespace(

default_colors=["red", "green", "blue", "yellow", "magenta", "cyan"],

update_interval=1.0

)

Copilot · 2025-10-18T17:51:40Z

src/docker_logs/app.py

+        container_count = self.docker_service.get_container_count()
+        monitoring = self.docker_service.is_monitoring()
+
+        self.main_screen.refresh_metrics(container_count, monitoring)


The MainScreen class doesn't have a 'refresh_metrics' method. Based on the structure, this should likely call 'self.main_screen.metrics.refresh_metrics(container_count, monitoring)'.

Suggested change

self.main_screen.refresh_metrics(container_count, monitoring)

self.main_screen.metrics.refresh_metrics(container_count, monitoring)

Copilot · 2025-10-18T17:51:40Z

src/docker_logs/app.py

+    def action_clear_logs(self) -> None:
+        self.main_screen.log_viewer.clear_logs()
+        logger.info("Cleared logs")
+


The method calls 'self.handle_refresh_containers()' which is not defined in this class. The method should either be implemented or this should post a RefreshContainers message.

Suggested change

def handle_refresh_containers(self) -> None:

"""Refresh the list of containers and update the UI."""

containers = self.docker_service.get_containers()

self.main_screen.refresh_container_list(containers)

Copilot

Pull Request Overview

Copilot reviewed 14 out of 19 changed files in this pull request and generated 10 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-20T10:04:54Z

src/docker_logs/widgets/__init__.py

+
+__all__ = [
+    "Header",
+    "Footer", 


Trailing whitespace after 'Footer', - this line has inconsistent whitespace compared to other entries in the list.

Suggested change

"Footer",

"Footer",

Copilot · 2025-10-20T10:04:54Z

src/docker_logs/app.py

+from .screens.main_screen import MainScreen
+from .services.docker_service import DockerService
+from .utils.colors import ColorManager
+from .utils.config import config


Importing config from config.py, but that file only contains a docstring with no config object defined. This will result in an ImportError.

Copilot · 2025-10-20T10:04:54Z

src/docker_logs/app.py

+    def __init__(self):
+        super().__init__()
+        self.docker_service = DockerService()
+        self.color_manager = ColorManager(config.default_colors)


Attempting to access config.default_colors, but config is not defined in utils/config.py. This will cause an AttributeError at runtime.

Copilot · 2025-10-20T10:04:54Z

src/docker_logs/app.py

+    def on_mount(self) -> None:
+        """Called when the app starts"""
+        self.push_screen(self.main_screen)
+        self.set_interval(config.update_interval, self._update_metrics)


Attempting to access config.update_interval, but config is not defined in utils/config.py. This will cause an AttributeError at runtime.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+        container_count = self.docker_service.get_container_count()
+        monitoring = self.docker_service.is_monitoring()


Calling methods on docker_service, but DockerService class is not defined. These method calls will fail at runtime.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+        container_count = self.docker_service.get_container_count()
+        monitoring = self.docker_service.is_monitoring()
+
+        self.main_screen.refresh_metrics(container_count, monitoring)


Calling refresh_metrics on main_screen, but MainScreen class has no such method defined. This will result in an AttributeError.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+
+    def _process_logs(self) -> None:
+        """ Process the incoming log messages"""
+        for container_name, message in self.docker_service.get_log_messages():


Calling get_log_messages on docker_service, but this method is not defined in the DockerService class. This will fail at runtime.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+    # Setup event handlers
+    @on(MainScreen.StartMonitoring) 
+    def handle_start_monitoring(self) -> None: 
+        if self.docker_service.start_monitoring():


Calling start_monitoring on docker_service, but this method is not defined. This will fail at runtime.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+
+    @on(MainScreen.StopMonitoring)
+    def handle_stop_monitoring(self) -> None:
+        self.docker_service.stop_monitoring()


Calling stop_monitoring on docker_service, but this method is not defined. This will fail at runtime.

Copilot · 2025-10-20T10:04:55Z

src/docker_logs/app.py

+    def action_refresh(self) -> None:
+        self.handle_refresh_containers()


Method handle_refresh_containers is called but not defined in the DockerLogsApp class. This will result in an AttributeError.

emy3 added 3 commits October 11, 2025 14:58

create new project structure

eab98fc

add initial files

c2731b0

add widget components and initial main screen

1fd58ed

emy3 requested a review from Copilot October 13, 2025 20:20

Copilot AI reviewed Oct 13, 2025

View reviewed changes

add main screen file

d63c58a

emy3 added the hacktoberfest-accepted label Oct 16, 2025

adding more to main app file

e8ca4c7

Copilot AI review requested due to automatic review settings October 18, 2025 17:50

Copilot AI reviewed Oct 18, 2025

View reviewed changes

emy3 requested a review from Copilot October 20, 2025 10:02

Copilot AI reviewed Oct 20, 2025

View reviewed changes

		from .main_screen import MainScreen

		__all__ = ["MainScreen"] No newline at end of file

	def write_log(self, container_name: str, message: str, color:str) -> None:
	def write_log(self, container_name: str, message: str, color: str) -> None:

		@@ -0,0 +1,21 @@
		"""Log viewer widget."""

		from textual.widget import RichLog

	from textual.widget import RichLog
	from textual.widgets import RichLog

-from .utils.config import config
+try:
+    from .utils.config import config
+except ImportError:
+    from types import SimpleNamespace
+    config = SimpleNamespace(
+        default_colors=["red", "green", "blue", "yellow", "magenta", "cyan"],
+        update_interval=1.0
+    )

	self.main_screen.refresh_metrics(container_count, monitoring)
	self.main_screen.metrics.refresh_metrics(container_count, monitoring)

+    def handle_refresh_containers(self) -> None:
+        """Refresh the list of containers and update the UI."""
+        containers = self.docker_service.get_containers()
+        self.main_screen.refresh_container_list(containers)

		container_count = self.docker_service.get_container_count()
		monitoring = self.docker_service.is_monitoring()

		def action_refresh(self) -> None:
		self.handle_refresh_containers()

feat: define initial ui and project structure #4

Are you sure you want to change the base?

feat: define initial ui and project structure #4

Uh oh!

Conversation

emy3 commented Oct 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

What does this PR do?

Why is this change necessary?

🔄 Type of Change

🧪 Testing

Test Environment

How Has This Been Tested?

Test Commands

📋 Checklist

📸 Screenshots/Output

Before

After

🔗 Related Issues

📝 Additional Notes

🔍 Reviewer Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

emy3 commented Oct 11, 2025 •

edited

Loading