scriptplan 0.9.0__tar.gz → 0.9.2__tar.gz

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

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: scriptplan
-Version: 0.9.0
+Version: 0.9.2
 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,32 @@ 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"
+Requires-Dist: cython>=3.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 +63,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 +132,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
@@ -158,4 +233,21 @@ delivery.assemble_b: 2025-07-16-08:00 -> 2025-07-17-16:00
 
 ## License
 
-Apache 2.0
+Apache-2.0
+
+## Acknowledgments
+
+ScriptPlan references [TaskJuggler](https://taskjuggler.org/) solely for **file format compatibility**. We have not used, modified, or copied any TaskJuggler source code. ScriptPlan is an independent, clean-room implementation.
+
+- The `.tjp` file format is documented publicly and widely used in the project management community
+- All scheduling algorithms, parser, and report generation in ScriptPlan are original implementations
+- TaskJuggler is mentioned only to indicate that ScriptPlan can read the same project file format
+
+If you're looking for the original TaskJuggler with its full feature set including interactive HTML reports and GUI tools, please visit [taskjuggler.org](https://taskjuggler.org/).
+
+## Why ScriptPlan?
+
+This scheduler is part of Highway Workflow Engine'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.
+
+Yours,
+Farshid.

scriptplan-0.9.2/README.md

@@ -0,0 +1,208 @@
+<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
+
+```bash
+pip install scriptplan
+```
+
+## Quick Start
+
+### Report Generation (Unix-style)
+
+```bash
+# 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
+from scriptplan.parser.tjp_parser import ProjectFileParser
+
+parser = ProjectFileParser()
+project = parser.parse(open('project.tjp').read())
+
+# Access scheduled tasks
+for task in project.tasks:
+    if task.leaf():
+        start = task.get('start', 0)
+        end = task.get('end', 0)
+        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
+- ASAP and ALAP scheduling modes
+- Resource allocation with contention handling
+- Working hours and shift definitions
+- Dependency chains with gap constraints
+- Leap year and timezone handling
+
+## Accuracy
+
+ScriptPlan uses integer arithmetic for all time calculations, avoiding floating-point drift. The scheduler correctly handles:
+
+- Non-standard shift boundaries (e.g., 08:13 - 11:59, 13:07 - 17:47)
+- Prime-number effort durations with prime-number gaps
+- Resource contention across multi-day tasks
+- Calendar gaps (weekends, holidays) vs working time gaps
+
+Example: A chain of 500 tasks, each with 73-minute effort and 29-minute gaps, scheduled across leap year boundaries with non-standard shifts, produces exact minute-aligned results.
+
+## Example Project
+
+```
+project "Manufacturing" 2025-07-01 +1m {
+  timezone "Etc/UTC"
+  timeformat "%Y-%m-%d %H:%M"
+  scheduling alap
+}
+
+shift factory_hours "Factory Hours" {
+  workinghours mon - fri 08:00 - 16:00
+}
+
+resource machine "Press" {
+  workinghours factory_hours
+}
+
+task delivery "Product Launch" {
+  end 2025-07-18-16:00
+
+  task pack "Packaging" {
+    effort 8h
+    allocate machine
+  }
+
+  task assemble_b "Body Assembly" {
+    effort 16h
+    allocate machine
+    depends !!pack { onstart }
+  }
+
+  task assemble_a "Engine Assembly" {
+    effort 16h
+    allocate machine
+  }
+}
+
+task connection_setup "Logic" {
+  task set_deps "Apply" {
+    depends !delivery.assemble_a, !delivery.assemble_b
+    precedes !delivery.pack
+  }
+}
+
+taskreport output "output" {
+  formats csv
+  columns id, start, end
+  timeformat "%Y-%m-%d-%H:%M"
+}
+```
+
+This project schedules backward from the delivery deadline (ALAP mode). The scheduler:
+
+1. Anchors packaging to end at 16:00 on July 18
+2. Schedules both assembly tasks to complete before packaging starts
+3. Resolves resource contention (single machine) by sequencing assemblies back-to-back
+4. Respects weekend boundaries (Mon-Fri working hours)
+
+Result:
+```
+delivery.pack:       2025-07-18-08:00 -> 2025-07-18-16:00
+delivery.assemble_a: 2025-07-14-08:00 -> 2025-07-15-16:00
+delivery.assemble_b: 2025-07-16-08:00 -> 2025-07-17-16:00
+```
+
+## License
+
+Apache-2.0
+
+## Acknowledgments
+
+ScriptPlan references [TaskJuggler](https://taskjuggler.org/) solely for **file format compatibility**. We have not used, modified, or copied any TaskJuggler source code. ScriptPlan is an independent, clean-room implementation.
+
+- The `.tjp` file format is documented publicly and widely used in the project management community
+- All scheduling algorithms, parser, and report generation in ScriptPlan are original implementations
+- TaskJuggler is mentioned only to indicate that ScriptPlan can read the same project file format
+
+If you're looking for the original TaskJuggler with its full feature set including interactive HTML reports and GUI tools, please visit [taskjuggler.org](https://taskjuggler.org/).
+
+## Why ScriptPlan?
+
+This scheduler is part of Highway Workflow Engine'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.
+
+Yours,
+Farshid.

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

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0", "wheel", "cython>=3.0.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "scriptplan"
-version = "0.9.0"
+version = "0.9.2"
 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,24 @@ 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",
+    "cython>=3.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
@@ -63,7 +71,7 @@ where = ["."]
 include = ["scriptplan*"]
 
 [tool.setuptools.package-data]
-scriptplan = ["py.typed", "parser/*.lark"]
+scriptplan = ["py.typed", "parser/*.lark", "_cython/*.pyx"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -75,3 +83,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.2/scriptplan/__init__.py

@@ -0,0 +1,26 @@
+"""
+ScriptPlan - A Python implementation inspired by TaskJuggler.
+
+This package provides project scheduling and resource management capabilities
+compatible with the TaskJuggler Project Definition Language (.tjp files).
+
+ScriptPlan owes its existence to TaskJuggler (https://taskjuggler.org/),
+the pioneering open-source project management tool created by Chris Schlaeger.
+The TJP file format and scheduling concepts originate from TaskJuggler.
+"""
+
+__version__ = "0.9.2"
+__author__ = "ScriptPlan Team"
+
+from scriptplan.core.project import Project
+from scriptplan.core.resource import Resource
+from scriptplan.core.scenario import Scenario
+from scriptplan.core.task import Task
+
+__all__ = [
+    "Project",
+    "Resource",
+    "Scenario",
+    "Task",
+    "__version__",
+]

scriptplan-0.9.2/scriptplan/_cython/__init__.py

@@ -0,0 +1,45 @@
+"""
+Cython-optimized modules for ScriptPlan.
+
+This package contains Cython implementations of performance-critical code.
+Pure Python fallbacks are used if Cython extensions are not compiled.
+"""
+
+# Track which optimized modules are available
+CYTHON_AVAILABLE = {
+    "scoreboard": False,
+    "time_utils": False,
+    "working_hours": False,
+}
+
+# Try to import Cython modules
+try:
+    from scriptplan._cython import scoreboard_cy  # noqa: F401
+
+    CYTHON_AVAILABLE["scoreboard"] = True
+except ImportError:
+    pass
+
+try:
+    from scriptplan._cython import time_utils_cy  # noqa: F401
+
+    CYTHON_AVAILABLE["time_utils"] = True
+except ImportError:
+    pass
+
+try:
+    from scriptplan._cython import working_hours_cy  # noqa: F401
+
+    CYTHON_AVAILABLE["working_hours"] = True
+except ImportError:
+    pass
+
+
+def is_optimized(module: str) -> bool:
+    """Check if a Cython-optimized module is available."""
+    return CYTHON_AVAILABLE.get(module, False)
+
+
+def get_available_optimizations() -> list[str]:
+    """Get list of available Cython optimizations."""
+    return [k for k, v in CYTHON_AVAILABLE.items() if v]