scriptplan 0.9.0__tar.gz → 0.9.1__tar.gz

{scriptplan-0.9.0/scriptplan.egg-info → scriptplan-0.9.1}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: scriptplan
-Version: 0.9.0
+Version: 0.9.1
 Summary: A precise project scheduling engine with minute-level accuracy for resource allocation and dependency management.
 Author-email: Farshid Ashouri <farsheed.ashouri@gmail.com>
 Maintainer-email: Farshid Ashouri <farsheed.ashouri@gmail.com>
 License-Expression: Apache-2.0
-Project-URL: Homepage, https://github.com/farshidash/scriptplan
-Project-URL: Documentation, https://github.com/farshidash/scriptplan#readme
-Project-URL: Bug Tracker, https://github.com/farshidash/scriptplan/issues
-Project-URL: Source, https://github.com/farshidash/scriptplan
+Project-URL: Homepage, https://github.com/rodmena-limited/scriptplan
+Project-URL: Documentation, https://github.com/rodmena-limited/scriptplan#readme
+Project-URL: Bug Tracker, https://github.com/rodmena-limited/scriptplan/issues
+Project-URL: Source, https://github.com/rodmena-limited/scriptplan
 Keywords: scheduling,project-management,resource-allocation,gantt,critical-path
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Office/Business :: Scheduling
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -28,16 +29,31 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lark>=1.0.0
 Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: click>=8.0.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
 Requires-Dist: pandas>=1.5.0; extra == "dev"
+Requires-Dist: types-python-dateutil>=2.8.0; extra == "dev"
+Requires-Dist: types-pytz>=2022.1.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
 Dynamic: license-file
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/rodmena-limited/scriptplan/main/icons/logo.svg" alt="ScriptPlan" width="400"/>
+</p>
+
 # ScriptPlan
 
+![Logic Certified](https://img.shields.io/badge/Logic-Certified_Airport--Grade-success?style=for-the-badge&logo=github)
+![Tests Passed](https://img.shields.io/badge/Stress_Tests-24%2F24_Passed-success?style=for-the-badge)
+![Temporal Physics](https://img.shields.io/badge/Temporal_Physics-Verified-blue?style=for-the-badge)
+![Scheduling](https://img.shields.io/badge/Scheduling-ALAP_%7C_JIT_%7C_Priority-blueviolet?style=for-the-badge)
+![Constraints](https://img.shields.io/badge/Constraints-Hard_Limits_%7C_Quotas-orange?style=for-the-badge)
+
 A precise project scheduling engine with minute-level accuracy for resource allocation and dependency management. The syntax is compatible with TaskJuggler (.tjp files).
 
 ## Installation
@@ -46,15 +62,59 @@ A precise project scheduling engine with minute-level accuracy for resource allo
 pip install scriptplan
 ```
 
-## Usage
+## Quick Start
 
-### Command Line
+### Report Generation (Unix-style)
 
 ```bash
-scriptplan project.tjp
-scriptplan --output-dir ./reports project.tjp
+# Generate JSON report to stdout
+plan report project.tjp
+
+# Generate CSV report
+plan report --csv project.tjp
+
+# Save to file
+plan report project.tjp > output.json
+plan report --csv project.tjp > output.csv
+
+# Read from stdin
+cat project.tjp | plan report
+plan report - < project.tjp
+
+# Pipe to other tools
+plan report project.tjp | jq '.data[0]'
+plan report --csv project.tjp | csvkit
+
+# Process multiple files
+for f in projects/*.tjp; do
+  plan report "$f" | jq -r '.report_id'
+done
 ```
 
+**Output Format** (JSON):
+```json
+{
+  "data": [
+    {
+      "id": "project.task1",
+      "start": "2024-01-01-09:00",
+      "end": "2024-01-05-17:00"
+    }
+  ],
+  "columns": ["id", "start", "end"],
+  "report_id": "ea3f901dd6426dfa58288d945819c75485fd9ff1875db59def350f219e2d62ca"
+}
+```
+
+**Features**:
+- Output to stdout (Unix philosophy)
+- Messages to stderr
+- SHA256 report_id (content-based hash)
+- Lowercase column names
+- No HTML metadata
+- No file pollution (uses temp directories)
+- Safe for concurrent execution (100+ instances)
+
 ### Python API
 
 ```python
@@ -71,6 +131,20 @@ for task in project.tasks:
         print(f"{task.id}: {start} -> {end}")
 ```
 
+## System Certified
+
+**Certification Level**: Airport-Grade / Mission Critical
+
+**Capabilities Verified**:
+
+- **Temporal Physics**: Floating point precision, Timezones, DST awareness, Date Line crossing.
+
+- **Resource Constraints**: Daily/Weekly limits, Hierarchical quotas, Shift intersections.
+
+- **Advanced Scheduling**: ALAP (Backward pass), Priority preemption, Smart Resource Selection (Failover).
+
+- **Workflow Logic**: Atomicity (Contiguous), Perishability (Max Gap), Zero-Buffer Synchronization.
+
 ## Features
 
 - Minute-level scheduling precision
@@ -159,3 +233,13 @@ delivery.assemble_b: 2025-07-16-08:00 -> 2025-07-17-16:00
 ## License
 
 Apache 2.0
+
+
+## Why?
+This scheduler is part of Highway Workflow Egnine's worker capacity management system.
+I decided to open-source it for the community to benefit from its precise scheduling capabilities.
+Thanks to TaskJuggler's established syntax, users can easily adopt ScriptPlan without learning a new format.
+Credits to TaskJuggler for the original project definition language and concepts.
+
+Yours,
+Farshid.

{scriptplan-0.9.0 → scriptplan-0.9.1}/README.md

@@ -1,5 +1,15 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/rodmena-limited/scriptplan/main/icons/logo.svg" alt="ScriptPlan" width="400"/>
+</p>
+
 # ScriptPlan
 
+![Logic Certified](https://img.shields.io/badge/Logic-Certified_Airport--Grade-success?style=for-the-badge&logo=github)
+![Tests Passed](https://img.shields.io/badge/Stress_Tests-24%2F24_Passed-success?style=for-the-badge)
+![Temporal Physics](https://img.shields.io/badge/Temporal_Physics-Verified-blue?style=for-the-badge)
+![Scheduling](https://img.shields.io/badge/Scheduling-ALAP_%7C_JIT_%7C_Priority-blueviolet?style=for-the-badge)
+![Constraints](https://img.shields.io/badge/Constraints-Hard_Limits_%7C_Quotas-orange?style=for-the-badge)
+
 A precise project scheduling engine with minute-level accuracy for resource allocation and dependency management. The syntax is compatible with TaskJuggler (.tjp files).
 
 ## Installation
@@ -8,15 +18,59 @@ A precise project scheduling engine with minute-level accuracy for resource allo
 pip install scriptplan
 ```
 
-## Usage
+## Quick Start
 
-### Command Line
+### Report Generation (Unix-style)
 
 ```bash
-scriptplan project.tjp
-scriptplan --output-dir ./reports project.tjp
+# Generate JSON report to stdout
+plan report project.tjp
+
+# Generate CSV report
+plan report --csv project.tjp
+
+# Save to file
+plan report project.tjp > output.json
+plan report --csv project.tjp > output.csv
+
+# Read from stdin
+cat project.tjp | plan report
+plan report - < project.tjp
+
+# Pipe to other tools
+plan report project.tjp | jq '.data[0]'
+plan report --csv project.tjp | csvkit
+
+# Process multiple files
+for f in projects/*.tjp; do
+  plan report "$f" | jq -r '.report_id'
+done
 ```
 
+**Output Format** (JSON):
+```json
+{
+  "data": [
+    {
+      "id": "project.task1",
+      "start": "2024-01-01-09:00",
+      "end": "2024-01-05-17:00"
+    }
+  ],
+  "columns": ["id", "start", "end"],
+  "report_id": "ea3f901dd6426dfa58288d945819c75485fd9ff1875db59def350f219e2d62ca"
+}
+```
+
+**Features**:
+- Output to stdout (Unix philosophy)
+- Messages to stderr
+- SHA256 report_id (content-based hash)
+- Lowercase column names
+- No HTML metadata
+- No file pollution (uses temp directories)
+- Safe for concurrent execution (100+ instances)
+
 ### Python API
 
 ```python
@@ -33,6 +87,20 @@ for task in project.tasks:
         print(f"{task.id}: {start} -> {end}")
 ```
 
+## System Certified
+
+**Certification Level**: Airport-Grade / Mission Critical
+
+**Capabilities Verified**:
+
+- **Temporal Physics**: Floating point precision, Timezones, DST awareness, Date Line crossing.
+
+- **Resource Constraints**: Daily/Weekly limits, Hierarchical quotas, Shift intersections.
+
+- **Advanced Scheduling**: ALAP (Backward pass), Priority preemption, Smart Resource Selection (Failover).
+
+- **Workflow Logic**: Atomicity (Contiguous), Perishability (Max Gap), Zero-Buffer Synchronization.
+
 ## Features
 
 - Minute-level scheduling precision
@@ -121,3 +189,13 @@ delivery.assemble_b: 2025-07-16-08:00 -> 2025-07-17-16:00
 ## License
 
 Apache 2.0
+
+
+## Why?
+This scheduler is part of Highway Workflow Egnine's worker capacity management system.
+I decided to open-source it for the community to benefit from its precise scheduling capabilities.
+Thanks to TaskJuggler's established syntax, users can easily adopt ScriptPlan without learning a new format.
+Credits to TaskJuggler for the original project definition language and concepts.
+
+Yours,
+Farshid.

{scriptplan-0.9.0 → scriptplan-0.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scriptplan"
-version = "0.9.0"
+version = "0.9.1"
 description = "A precise project scheduling engine with minute-level accuracy for resource allocation and dependency management."
 authors = [
     { name = "Farshid Ashouri", email = "farsheed.ashouri@gmail.com" },
@@ -26,6 +26,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: OS Independent",
     "Topic :: Office/Business :: Scheduling",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -35,6 +36,7 @@ keywords = ["scheduling", "project-management", "resource-allocation", "gantt",
 dependencies = [
     "lark>=1.0.0",
     "python-dateutil>=2.8.0",
+    "click>=8.0.0",
 ]
 
 [project.optional-dependencies]
@@ -42,18 +44,23 @@ dev = [
     "pytest>=7.0.0",
     "pytest-xdist>=3.0.0",
     "pandas>=1.5.0",
+    "types-python-dateutil>=2.8.0",
+    "types-pytz>=2022.1.0",
     "build",
     "twine",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
 ]
 
 [project.scripts]
 scriptplan = "scriptplan.cli.main:main"
+plan = "scriptplan.cli.plan:main"
 
 [project.urls]
-"Homepage" = "https://github.com/farshidash/scriptplan"
-"Documentation" = "https://github.com/farshidash/scriptplan#readme"
-"Bug Tracker" = "https://github.com/farshidash/scriptplan/issues"
-"Source" = "https://github.com/farshidash/scriptplan"
+"Homepage" = "https://github.com/rodmena-limited/scriptplan"
+"Documentation" = "https://github.com/rodmena-limited/scriptplan#readme"
+"Bug Tracker" = "https://github.com/rodmena-limited/scriptplan/issues"
+"Source" = "https://github.com/rodmena-limited/scriptplan"
 
 [tool.setuptools]
 include-package-data = true
@@ -75,3 +82,19 @@ filterwarnings = [
     "ignore::DeprecationWarning",
     "ignore::PendingDeprecationWarning",
 ]
+
+[tool.ruff]
+line-length = 120
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "C4", "SIM", "RUF"]
+# N rules ignored: codebase uses camelCase for TaskJuggler API compatibility
+ignore = ["E501"]  # Line length handled separately
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true

scriptplan-0.9.1/scriptplan/cli/__init__.py

@@ -0,0 +1,7 @@
+"""
+Command-line interface for ScriptPlan.
+"""
+
+from scriptplan.cli.main import ScriptPlan, create_parser, main
+
+__all__ = ['ScriptPlan', 'create_parser', 'main']

{scriptplan-0.9.0 → scriptplan-0.9.1}/scriptplan/cli/main.py

@@ -17,17 +17,17 @@ Examples:
 """
 
 import argparse
-import sys
-import os
 import logging
-from pathlib import Path
-from typing import List, Optional
+import os
 import re
+import sys
+from pathlib import Path
+from typing import Optional
 
 from scriptplan import __version__
 
 
-def setup_logging(debug_level: int = 0, debug_modules: Optional[List[str]] = None) -> None:
+def setup_logging(debug_level: int = 0, debug_modules: Optional[list[str]] = None) -> None:
     """
     Configure logging based on debug settings.
 
@@ -226,8 +226,10 @@ class ScriptPlan:
         Args:
             args: Parsed command-line arguments
         """
+        from scriptplan.core.project import Project
+
         self.args = args
-        self.project = None
+        self.project: Optional[Project] = None
         self.errors = 0
         self.warnings = 0
         self.logger = logging.getLogger('scriptplan.cli')
@@ -284,22 +286,20 @@ class ScriptPlan:
                     return 1
 
         # Freeze (generate bookings) if requested
-        if self.args.freeze:
-            if not self.freeze_project():
-                return 1
+        if self.args.freeze and not self.freeze_project():
+            return 1
 
         # List reports if requested
         if self.args.list_reports:
             self.list_reports(self.args.list_reports)
 
         # Generate reports
-        if not self.args.no_reports:
-            if not self.generate_reports():
-                return 1
+        if not self.args.no_reports and not self.generate_reports():
+            return 1
 
         return 0 if self.errors == 0 else 1
 
-    def parse_files(self, files: List[str]) -> bool:
+    def parse_files(self, files: list[str]) -> bool:
         """
         Parse the project files.
 
@@ -322,11 +322,12 @@ class ScriptPlan:
                 print(f"Error: File '{main_file}' not found", file=sys.stderr)
                 return False
 
-            with open(main_file, 'r', encoding='utf-8') as f:
+            with open(main_file, encoding='utf-8') as f:
                 content = f.read()
 
             self.project = parser.parse(content)
-            self.logger.info(f"Project '{self.project.name}' loaded successfully")
+            if self.project:
+                self.logger.info(f"Project '{self.project.name}' loaded successfully")
 
             # Parse additional include files
             for include_file in files[1:]:
@@ -505,7 +506,7 @@ class ScriptPlan:
                 context.push()
 
                 try:
-                    result = report.generate()
+                    result = report.generate()  # type: ignore[attr-defined]
                     if result != 0:
                         self.warnings += 1
                 finally:
@@ -520,7 +521,53 @@ class ScriptPlan:
             return False
 
 
-def main(argv: Optional[List[str]] = None) -> int:
+def run_scriptplan(tjp_file: str, output_dir: Optional[str] = None) -> tuple[bool, Optional[str]]:
+    """
+    Run ScriptPlan report generation on a .tjp file.
+
+    This is a simplified interface for programmatic use.
+
+    Args:
+        tjp_file: Path to the .tjp file
+        output_dir: Optional output directory for reports (default: current directory)
+
+    Returns:
+        Tuple of (success, error_message)
+    """
+    import contextlib
+    import io
+
+    # Capture stderr to get error messages
+    stderr_capture = io.StringIO()
+
+    try:
+        with contextlib.redirect_stderr(stderr_capture):
+            # Create minimal args
+            parser = create_parser()
+            args_list = [tjp_file]
+            if output_dir:
+                args_list.extend(['--output-dir', output_dir])
+            args = parser.parse_args(args_list)
+
+            # Suppress logging for programmatic use
+            logging.getLogger().setLevel(logging.ERROR)
+
+            # Run the application
+            app = ScriptPlan(args)
+            exit_code = app.run()
+
+            if exit_code == 0:
+                return (True, None)
+            else:
+                error_output = stderr_capture.getvalue()
+                return (False, error_output or "Report generation failed")
+
+    except Exception as e:
+        error_output = stderr_capture.getvalue()
+        return (False, error_output or str(e))
+
+
+def main(argv: Optional[list[str]] = None) -> int:
     """
     Main entry point for the CLI.