domd 2.2.26__tar.gz → 2.2.27__tar.gz

{domd-2.2.26 → domd-2.2.27}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.3
 Name: domd
-Version: 2.2.26
+Version: 2.2.27
 Summary:  ✓ DoMD - Do Markdown Docs - automatically detect, run and show working commands in DONE.md and errors in TODO.md markdown files
 License: Apache-2.0
 Author: Tom Sapletta
 Author-email: info@softreck.dev
 Maintainer: WRONAI Team
-Requires-Python: >=3.8.1,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -34,6 +34,7 @@ Requires-Dist: colorama (>=0.4.6,<0.5.0) ; extra == "ui" or extra == "all"
 Requires-Dist: configparser (>=5.3.0,<6.0.0)
 Requires-Dist: docker (>=6.1.3,<7.0.0)
 Requires-Dist: flask (>=2.0.0,<3.0.0) ; extra == "api" or extra == "all"
+Requires-Dist: flask-cors (>=6.0.1,<7.0.0)
 Requires-Dist: pathlib ; python_version >= "3.4"
 Requires-Dist: pyyaml (>=6.0,<7.0)
 Requires-Dist: rich (>=13.0.0,<14.0.0) ; extra == "ui" or extra == "all"
@@ -66,6 +67,16 @@ Description-Content-Type: text/markdown
 - **Cross-Platform** - Works on Linux, macOS, and Windows
 - **Extensible** - Add support for new command types and tools
 
+## 📚 Examples
+
+Explore our comprehensive collection of examples to get started with DoMD:
+
+- [Basic Examples](docs/examples/basic/) - Simple examples to get you started
+- [Advanced Usage](docs/examples/advanced/) - Complex scenarios and custom configurations
+- [Web Interface Guide](docs/examples/web/) - How to use the DoMD web interface
+- [CI/CD Integration](docs/examples/ci_cd/) - Automate documentation with GitHub Actions and more
+- [Integration Examples](docs/examples/integration/) - Using DoMD with other tools and platforms
+
 ## 🚀 Quick Start
 
 ### Prerequisites
@@ -105,7 +116,9 @@ docker run --rm -v $(pwd):/app ghcr.io/wronai/domd domd
 
 ## 🌐 Web Interface
 
-DoMD includes a web-based interface for a more interactive experience:
+DoMD includes a secure web-based interface for a more interactive experience:
+
+### Starting the Web Interface
 
 ```bash
 # Start the web interface (default port: 3003)
@@ -116,23 +129,79 @@ domd web --port 8080
 
 # Start without opening browser automatically
 domd web --no-browser
+
+# Start with specific host binding
+domd web --host 0.0.0.0
 ```
 
+### Local Development
+
+For local development, you can start both the backend and frontend services:
+
+```bash
+# Start the backend server
+poetry run uvicorn domd.main:app --reload --port 8000
+
+# In a separate terminal, start the frontend
+cd frontend
+npm install
+npm start
+```
+
+### Authentication & Login
+
+The web interface is protected by authentication. Use the following default credentials:
+
+- **URL**: http://localhost:3000 (frontend development server) or http://localhost:3003 (production build)
+- **Username**: admin
+- **Password**: admin123
+
+> **Security Note**: Change the default password after first login by navigating to User Settings in the web interface.
+
+#### First-Time Login
+
+1. Open your web browser and navigate to http://localhost:3000 (development) or http://localhost:3003 (production)
+2. Enter the default credentials:
+   - Email/Username: `admin`
+   - Password: `admin123`
+3. Click "Sign In"
+4. Immediately change your password in the User Settings menu
+
 ### Web Interface Features
 
+- **Secure Login**: Protected by username/password authentication
 - **Interactive Dashboard**: View command execution results in real-time
 - **Command History**: Browse through previously executed commands
 - **Filtering**: Filter commands by status, type, or search term
 - **Detailed Views**: See full command output and execution details
+- **User Management**: Manage users and permissions (admin only)
 - **Responsive Design**: Works on desktop and mobile devices
 
+### Troubleshooting Login Issues
+
+If you're having trouble logging in:
+
+1. Ensure the backend server is running (check terminal for errors)
+2. Verify the frontend is properly connected to the backend (check browser's developer console for errors)
+3. Clear your browser cache and cookies if experiencing persistent login issues
+4. Check that your credentials are correct (default: admin/admin123)
+5. If you've forgotten your password, you can reset it by:
+   - Stopping the server
+   - Deleting the `domd.db` file (or your configured database file)
+   - Restarting the server (this will recreate the database with default credentials)
+2. Open http://localhost:3003 in your browser
+3. Log in with the default credentials
+4. Navigate to Settings > Users to change the default password
+5. (Optional) Create additional users with appropriate permissions
+
 ### Prerequisites
 
 To use the web interface, you'll need:
 
-- Node.js (v14 or later) and npm (v6 or later)
+- Node.js (v16 or later) and npm (v8 or later)
 - Python 3.8+ with DoMD installed
 - Internet connection (for loading external resources)
+- Modern web browser (Chrome, Firefox, Safari, or Edge)
 
 ## 📖 Basic Usage
 

{domd-2.2.26 → domd-2.2.27}/README.md

@@ -19,6 +19,16 @@
 - **Cross-Platform** - Works on Linux, macOS, and Windows
 - **Extensible** - Add support for new command types and tools
 
+## 📚 Examples
+
+Explore our comprehensive collection of examples to get started with DoMD:
+
+- [Basic Examples](docs/examples/basic/) - Simple examples to get you started
+- [Advanced Usage](docs/examples/advanced/) - Complex scenarios and custom configurations
+- [Web Interface Guide](docs/examples/web/) - How to use the DoMD web interface
+- [CI/CD Integration](docs/examples/ci_cd/) - Automate documentation with GitHub Actions and more
+- [Integration Examples](docs/examples/integration/) - Using DoMD with other tools and platforms
+
 ## 🚀 Quick Start
 
 ### Prerequisites
@@ -58,7 +68,9 @@ docker run --rm -v $(pwd):/app ghcr.io/wronai/domd domd
 
 ## 🌐 Web Interface
 
-DoMD includes a web-based interface for a more interactive experience:
+DoMD includes a secure web-based interface for a more interactive experience:
+
+### Starting the Web Interface
 
 ```bash
 # Start the web interface (default port: 3003)
@@ -69,23 +81,79 @@ domd web --port 8080
 
 # Start without opening browser automatically
 domd web --no-browser
+
+# Start with specific host binding
+domd web --host 0.0.0.0
 ```
 
+### Local Development
+
+For local development, you can start both the backend and frontend services:
+
+```bash
+# Start the backend server
+poetry run uvicorn domd.main:app --reload --port 8000
+
+# In a separate terminal, start the frontend
+cd frontend
+npm install
+npm start
+```
+
+### Authentication & Login
+
+The web interface is protected by authentication. Use the following default credentials:
+
+- **URL**: http://localhost:3000 (frontend development server) or http://localhost:3003 (production build)
+- **Username**: admin
+- **Password**: admin123
+
+> **Security Note**: Change the default password after first login by navigating to User Settings in the web interface.
+
+#### First-Time Login
+
+1. Open your web browser and navigate to http://localhost:3000 (development) or http://localhost:3003 (production)
+2. Enter the default credentials:
+   - Email/Username: `admin`
+   - Password: `admin123`
+3. Click "Sign In"
+4. Immediately change your password in the User Settings menu
+
 ### Web Interface Features
 
+- **Secure Login**: Protected by username/password authentication
 - **Interactive Dashboard**: View command execution results in real-time
 - **Command History**: Browse through previously executed commands
 - **Filtering**: Filter commands by status, type, or search term
 - **Detailed Views**: See full command output and execution details
+- **User Management**: Manage users and permissions (admin only)
 - **Responsive Design**: Works on desktop and mobile devices
 
+### Troubleshooting Login Issues
+
+If you're having trouble logging in:
+
+1. Ensure the backend server is running (check terminal for errors)
+2. Verify the frontend is properly connected to the backend (check browser's developer console for errors)
+3. Clear your browser cache and cookies if experiencing persistent login issues
+4. Check that your credentials are correct (default: admin/admin123)
+5. If you've forgotten your password, you can reset it by:
+   - Stopping the server
+   - Deleting the `domd.db` file (or your configured database file)
+   - Restarting the server (this will recreate the database with default credentials)
+2. Open http://localhost:3003 in your browser
+3. Log in with the default credentials
+4. Navigate to Settings > Users to change the default password
+5. (Optional) Create additional users with appropriate permissions
+
 ### Prerequisites
 
 To use the web interface, you'll need:
 
-- Node.js (v14 or later) and npm (v6 or later)
+- Node.js (v16 or later) and npm (v8 or later)
 - Python 3.8+ with DoMD installed
 - Internet connection (for loading external resources)
+- Modern web browser (Chrome, Firefox, Safari, or Edge)
 
 ## 📖 Basic Usage
 

{domd-2.2.26 → domd-2.2.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "domd"
-version = "2.2.26"
+version = "2.2.27"
 description = " ✓ DoMD - Do Markdown Docs - automatically detect, run and show working commands in DONE.md and errors in TODO.md markdown files"
 authors = ["Tom Sapletta <info@softreck.dev>"]
 maintainers = ["WRONAI Team"]
@@ -37,7 +37,7 @@ classifiers = [
 "Documentation" = "https://wronai.github.io/domd"
 
 [tool.poetry.dependencies]
-python = ">=3.8.1,<4.0"
+python = ">=3.9,<4.0"
 pyyaml = "^6.0"
 toml = "^0.10.2"
 configparser = "^5.3.0"
@@ -51,6 +51,7 @@ colorama = { version = "^0.4.6", optional = true }
 rich = { version = "^13.0.0", optional = true }
 click = { version = "^8.1.0", optional = true }
 flask = { version = "^2.0.0", optional = true }
+flask-cors = "^6.0.1"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{domd-2.2.26 → domd-2.2.27}/src/domd/__init__.py

@@ -14,7 +14,7 @@ __license__ = "Apache-2.0"
 
 from typing import Callable, TypeVar
 
-from .core.detector import ProjectCommandDetector
+from .core.project_detection.detector import ProjectCommandDetector
 
 # Define a type variable for the main function
 F = TypeVar("F", bound=Callable[..., int])

{domd-2.2.26 → domd-2.2.27}/src/domd/adapters/api/flask_api.py

@@ -15,7 +15,8 @@ from flask_cors import CORS
 from werkzeug.security import check_password_hash, generate_password_hash
 
 from ...application.factory import ApplicationFactory
-from ...core.ports.command import Command
+from ...core.domain.command import Command
+from ...core.parsing.pattern_matcher import PatternMatcher
 
 # Configure logging
 logger = logging.getLogger(__name__)
@@ -76,6 +77,7 @@ class DomdFlaskApi:
             project_path=self.project_path,
             todo_file="TODO.md",
             done_file="DONE.md",
+            formatter=self.formatter,
         )
 
         # Register routes
@@ -145,6 +147,9 @@ class DomdFlaskApi:
         """Register all API routes."""
         # Health check (public)
         self.app.route("/health", methods=["GET"])(self.health)
+        self.app.route("/api/health", methods=["GET"])(
+            self.health
+        )  # Added for frontend compatibility
 
         # Authentication
         self.app.route("/api/auth/login", methods=["POST"])(self.login)
@@ -418,7 +423,7 @@ class DomdFlaskApi:
 
             # Use the command service to scan for commands
             try:
-                from ...core.detector import ProjectCommandDetector
+                from ...core.project_detection.detector import ProjectCommandDetector
 
                 detector = ProjectCommandDetector(
                     project_path=project_path,
@@ -564,16 +569,12 @@ class DomdFlaskApi:
             todo_file = data.get("todo_file", "TODO.md")
             done_file = data.get("done_file", "DONE.md")
 
-            # Aktualizuj usługę raportów
-            self.report_service = ApplicationFactory.create_report_service(
-                repository=self.repository,
-                project_path=self.project_path,
-                todo_file=todo_file,
-                done_file=done_file,
-            )
+            # Update report service with new file names
+            self.report_service.todo_file = todo_file
+            self.report_service.done_file = done_file
 
-            # Generuj raporty
-            todo_path, done_path = self.report_service.generate_reports(self.formatter)
+            # Generate reports
+            todo_path, done_path = self.report_service.generate_reports()
 
             return jsonify(
                 {

{domd-2.2.26 → domd-2.2.27}/src/domd/adapters/cli/command_presenter.py

@@ -3,8 +3,7 @@ Prezenter komend dla interfejsu wiersza poleceń.
 """
 
 import logging
-from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Optional
 
 from ...core.ports.command_repository import CommandRepository
 

{domd-2.2.26 → domd-2.2.27}/src/domd/adapters/formatters/markdown_formatter.py

@@ -4,7 +4,7 @@ Implementacja formatera raportów w formacie Markdown.
 
 import logging
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import List
 
 from ...core.domain.command import Command
 from ...core.ports.report_formatter import ReportFormatter

{domd-2.2.26 → domd-2.2.27}/src/domd/adapters/persistence/in_memory_command_repository.py

@@ -2,7 +2,7 @@
 Implementacja repozytorium komend w pamięci.
 """
 
-from typing import Any, Dict, List, Optional
+from typing import List
 
 from ...core.domain.command import Command
 from ...core.ports.command_repository import CommandRepository

{domd-2.2.26 → domd-2.2.27}/src/domd/adapters/persistence/shell_command_executor.py

@@ -2,12 +2,18 @@
 Implementacja wykonawcy komend powłoki systemowej.
 """
 
+# Standard library imports
 import logging
+import os
 import shlex
 import subprocess
 import time
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple
+
+# Local application imports
+from ...core.domain.command import Command, CommandResult
+from ...core.ports.command_executor import CommandExecutor
 
 # List of common shell built-in commands
 SHELL_BUILTINS = {
@@ -72,9 +78,6 @@ SHELL_BUILTINS = {
     "wait",
 }
 
-from ...core.domain.command import Command, CommandResult
-from ...core.ports.command_executor import CommandExecutor
-
 logger = logging.getLogger(__name__)
 
 

{domd-2.2.26 → domd-2.2.27}/src/domd/api.py

@@ -112,7 +112,7 @@ def main() -> int:
         api = DomdFlaskApi(project_path=project_path)
 
         # Wyświetl informacje o serwerze
-        print(f"DoMD REST API Server")
+        print("DoMD REST API Server")
         print(f"Projekt: {project_path}")
         print(f"Uruchamianie serwera na http://{args.host}:{args.port}")
         print("Dostępne endpointy:")

{domd-2.2.26 → domd-2.2.27}/src/domd/application/factory.py

@@ -2,7 +2,6 @@
 Fabryka aplikacji DoMD.
 """
 
-import os
 from pathlib import Path
 from typing import List, Optional
 
@@ -91,6 +90,7 @@ class ApplicationFactory:
         project_path: Path,
         todo_file: str = "TODO.md",
         done_file: str = "DONE.md",
+        formatter: Optional[ReportFormatter] = None,
     ) -> ReportService:
         """
         Tworzy usługę raportów.
@@ -100,6 +100,7 @@ class ApplicationFactory:
             project_path: Ścieżka do katalogu projektu
             todo_file: Nazwa pliku z nieudanymi komendami
             done_file: Nazwa pliku z udanymi komendami
+            formatter: Opcjonalny formater raportów
 
         Returns:
             Usługa raportów