scriptplan 0.9.2__tar.gz → 0.10.0__tar.gz

scriptplan-0.10.0/CHANGELOG.md

@@ -0,0 +1,118 @@
+# Changelog
+
+## 0.10.0
+
+A readiness audit of 0.9.2 turned every documented claim into a probe that
+drives ScriptPlan through its own API or CLI. 32 of those probes failed. This
+release is what it took to make them pass, and it changes scheduling results.
+
+### Breaking: `effort` is person-time
+
+`effort 16h allocate a, b` used to occupy both resources for sixteen hours and
+credit sixteen hours of work. Two resources booked thirty-two hours, four booked
+sixty-four, and the completion date never moved however many were assigned. The
+engine took the largest contribution in each slot rather than the sum, so the
+labour of every resource but one was booked, billed and discarded.
+
+Effort is now the amount of work to be done, and each allocated resource
+contributes its own time towards it, as TaskJuggler defines it. The same task
+with two resources finishes in half the time and costs what one resource's worth
+of work costs.
+
+**Upgrading.** A task whose allocations were meant to work side by side is
+written with `mandatory` and its effort in person-hours:
+
+```
+# before 0.10.0: four hours of a pair working together
+task deploy "Deploy" { effort 4h  allocate dev, qa }
+
+# 0.10.0 and after
+task deploy "Deploy" { effort 8h  allocate dev { mandatory }, qa { mandatory } }
+```
+
+Tasks with a single allocation are unaffected. Of the 24 example projects, 21
+schedule identically to 0.9.2; the three that differ are those that allocate
+more than one resource to a task.
+
+### Breaking: failures are reported as failures
+
+`Project.schedule()` always returned `True`, and the CLI exited 0 with empty
+start and end cells. A circular dependency, an effort task with no allocation,
+or a task that did not fit the project window produced a warning nobody saw.
+
+Scheduling now returns the real result and names each failing task and why; the
+CLIs exit non-zero. A dependency cycle is rejected before scheduling, naming the
+cycle. An attribute or reference the parser cannot place is an error rather than
+a silent drop, which is how `duration`, `length`, `complete` and `note` reached
+the model for the first time.
+
+### Breaking: the declared project period is honoured
+
+The project end was grown by a heuristic before scheduling. It is now taken as
+written, and a task that does not fit is reported. Projects that relied on the
+extension need their period stated honestly.
+
+### Breaking: unimplemented report formats are rejected
+
+`ical`, `tjp`, `niku`, `ctags` and MS Project XML were accepted, wrote no file,
+and left the CLI blaming a scheduling problem that did not exist. They now raise
+at parse time. Use `json` or `csv`.
+
+### Fixed
+
+- Durations follow one table: `m` is months and `min` is minutes everywhere;
+  `duration` and `gapduration` are calendar time, `effort`, `length` and
+  `gaplength` working time derived from `dailyworkinghours` and
+  `yearlyworkingdays`. `gapduration 2d` was 16 hours; `gaplength 30min` was no
+  gap at all; `limits { dailymax 30min }` was a 4800-hour cap.
+- Limits count seconds in the resource's own calendar and admit part of a slot,
+  so `dailymax 6.4h` is exact. A resource in Los Angeles capped at four hours a
+  day was working five in one of its own days. `dailymin`, `weeklymin`,
+  `monthlymax`, `monthlymin`, `maximum` and `minimum` reach the grammar, as do
+  `maxend`, `maxstart`, `minend` and `minstart`, and violations are reported.
+- Dates are read in the project's timezone and scheduled in UTC; reports convert
+  back. The default working day was compared against the hour of a UTC slot,
+  putting a New York project five hours out.
+- Slot size is derived from the times a project uses, so `start 09:30` and a
+  shift of `08:13 - 11:59` are exact without setting `timingresolution`. That
+  shift was credited with seven hours a day instead of eight and a half.
+- A working-hours interval crossing midnight applies to the following day.
+  `fri 22:00 - 06:00` marked Friday morning instead of Saturday.
+- Chains mixing ASAP and ALAP schedule instead of deadlocking.
+- Scheduling twice gives the same dates and the same bookings. The second run
+  kept the dates and discarded every booking.
+- Reports honour their own `sorttasks`, `hidetask`, column options and formats,
+  and `plan report` renders the reports a project declares rather than
+  substituting a three-column one. Descending sort was a no-op, and any filter
+  hid every row.
+- `report_id` is a SHA-256 of the rendered result. It hashed the input file, so
+  a correct and a broken schedule of the same input shared an id.
+- `mandatory`, `persistent` and per-resource allocation options work; they
+  parsed to nothing.
+
+### Removed
+
+- The Cython extensions. Under `cdivision` the compiled path computed
+  `(0 - 1) % 7` as `-1`, so a resource with a Sunday night shift lost its Monday
+  morning in every published wheel and kept it in every source checkout: the
+  same file, two schedules, and no test covering the compiled one. The wheel is
+  now pure Python and cannot diverge from its source.
+- `scheduler.batch_processor`, `utils.data_cache.DataCache` and `utils.Log`,
+  none of which were reachable.
+
+### Performance
+
+500 chained tasks at minute resolution schedule in 3.3s, from 14.4s. A year at
+minute resolution with ten resources takes about 13s, from 58.7s.
+
+### Verification
+
+`audit/evaluations/` holds 74 probes across 12 files, each named after the
+behaviour it would falsify and each driving ScriptPlan through its own
+interface. `scripts/ci.sh` runs lint, types, a file-size cap, 411 tests, a
+showcase currency check and the probes. The probes also pass against the built
+wheel installed in a clean virtualenv, so what is verified is what ships.
+
+## 0.9.2 and earlier
+
+See the git history.

{scriptplan-0.9.2 → scriptplan-0.10.0}/MANIFEST.in

@@ -1,5 +1,6 @@
 include LICENSE
 include README.md
+include CHANGELOG.md
 include pyproject.toml
 recursive-include scriptplan *.lark
 recursive-include scriptplan py.typed

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scriptplan
-Version: 0.9.2
+Version: 0.10.0
 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>
@@ -9,6 +9,7 @@ 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
+Project-URL: Changelog, https://github.com/rodmena-limited/scriptplan/blob/main/CHANGELOG.md
 Keywords: scheduling,project-management,resource-allocation,gantt,critical-path
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -40,7 +41,6 @@ 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">
@@ -49,11 +49,10 @@ Dynamic: license-file
 
 # 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)
+![Tests](https://img.shields.io/badge/tests-411_passing-success?style=for-the-badge)
+![Probes](https://img.shields.io/badge/audit_probes-67_passing-success?style=for-the-badge)
+![Python](https://img.shields.io/badge/python-3.9%2B-blue?style=for-the-badge)
+![Licence](https://img.shields.io/badge/licence-Apache--2.0-lightgrey?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).
 
@@ -110,11 +109,11 @@ done
 **Features**:
 - Output to stdout (Unix philosophy)
 - Messages to stderr
-- SHA256 report_id (content-based hash)
+- SHA256 `report_id` over the rendered result, so it changes when the schedule does
 - Lowercase column names
 - No HTML metadata
 - No file pollution (uses temp directories)
-- Safe for concurrent execution (100+ instances)
+- Separate processes do not collide: temporary files and directories are unique per run
 
 ### Python API
 
@@ -132,39 +131,69 @@ for task in project.tasks:
         print(f"{task.id}: {start} -> {end}")
 ```
 
-## System Certified
+## What is verified
 
-**Certification Level**: Airport-Grade / Mission Critical
+Each behaviour below has a probe in `audit/evaluations/` that drives ScriptPlan
+through its own API or CLI and asserts the result. They run as part of the test
+suite, and can be run on their own against an installed release:
 
-**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
+```bash
+audit/evaluations/run_all.sh
+```
 
-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.
+**Time**
+
+- Dates are read in the project's timezone and scheduled in UTC; reports convert back.
+- Resource shifts follow their own timezone across daylight-saving changes in both directions.
+- A working-hours interval that crosses midnight applies to the following day.
+- Slot size is derived from the times a project uses, so `start 09:30` is honoured
+  exactly and a shift of `08:13 - 11:59, 13:07 - 17:47` yields its true 8h26m a day.
+  `timingresolution` overrides this.
+
+**Units**
+
+- Calendar time (`duration`, `gapduration`) and working time (`effort`, `length`,
+  `gaplength`) are distinguished, with working time derived from
+  `dailyworkinghours` and `yearlyworkingdays`. `m` means months; `min` means minutes.
+
+**Resources**
+
+- `effort` is person-time: two resources available in a slot contribute two
+  slots of it. `mandatory` requires a resource for the task to progress at all;
+  `persistent` keeps the one first chosen; `alternative` falls back.
+- `dailymax`, `weeklymax`, `monthlymax`, `maximum` and their `min` counterparts
+  block at the cap **and** release in the next period. Periods are counted in the
+  resource's own calendar, and a cap smaller than one slot is honoured exactly.
+
+**Scheduling**
+
+- ASAP and ALAP, including chains that mix the two.
+- Contention is resolved by priority, then criticalness, then declaration order.
+- The declared project period is never rewritten. A task that does not fit is
+  reported, with its name and the reason.
+- Scheduling the same project twice produces the same dates and the same bookings.
+- `maxgapduration`, `maxgaplength`, `maxstart`, `minstart`, `maxend` and `minend`
+  are checked once the schedule is complete, and a violation is an error.
+
+**Honesty**
+
+- A project that cannot be scheduled exits non-zero and says why. A dependency
+  cycle is rejected before scheduling, naming the cycle.
+- An attribute or reference the parser cannot place is an error, never a silent
+  drop.
+- `report_id` is a SHA-256 of the rendered result, so it differs when the
+  schedule differs.
+
+## Known limits
+
+- `include`, `supplement`, `leaveallowance` and `statussheet` are not implemented.
+- Output formats are JSON and CSV. `ical`, `tjp`, `niku` and MS Project XML are
+  rejected at parse time rather than silently producing nothing.
+- Accounts are parsed but not yet modelled, so `chargeset` and `charge` record an
+  amount without posting it anywhere.
+- `onstart` dependencies are read as "the dependent task must finish before the
+  predecessor starts", which is ScriptPlan's own reading rather than
+  TaskJuggler's start-to-start one.
 
 ## Example Project
 

{scriptplan-0.9.2 → scriptplan-0.10.0}/README.md

@@ -4,11 +4,10 @@
 
 # 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)
+![Tests](https://img.shields.io/badge/tests-411_passing-success?style=for-the-badge)
+![Probes](https://img.shields.io/badge/audit_probes-67_passing-success?style=for-the-badge)
+![Python](https://img.shields.io/badge/python-3.9%2B-blue?style=for-the-badge)
+![Licence](https://img.shields.io/badge/licence-Apache--2.0-lightgrey?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).
 
@@ -65,11 +64,11 @@ done
 **Features**:
 - Output to stdout (Unix philosophy)
 - Messages to stderr
-- SHA256 report_id (content-based hash)
+- SHA256 `report_id` over the rendered result, so it changes when the schedule does
 - Lowercase column names
 - No HTML metadata
 - No file pollution (uses temp directories)
-- Safe for concurrent execution (100+ instances)
+- Separate processes do not collide: temporary files and directories are unique per run
 
 ### Python API
 
@@ -87,39 +86,69 @@ for task in project.tasks:
         print(f"{task.id}: {start} -> {end}")
 ```
 
-## System Certified
+## What is verified
 
-**Certification Level**: Airport-Grade / Mission Critical
+Each behaviour below has a probe in `audit/evaluations/` that drives ScriptPlan
+through its own API or CLI and asserts the result. They run as part of the test
+suite, and can be run on their own against an installed release:
 
-**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
+```bash
+audit/evaluations/run_all.sh
+```
 
-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.
+**Time**
+
+- Dates are read in the project's timezone and scheduled in UTC; reports convert back.
+- Resource shifts follow their own timezone across daylight-saving changes in both directions.
+- A working-hours interval that crosses midnight applies to the following day.
+- Slot size is derived from the times a project uses, so `start 09:30` is honoured
+  exactly and a shift of `08:13 - 11:59, 13:07 - 17:47` yields its true 8h26m a day.
+  `timingresolution` overrides this.
+
+**Units**
+
+- Calendar time (`duration`, `gapduration`) and working time (`effort`, `length`,
+  `gaplength`) are distinguished, with working time derived from
+  `dailyworkinghours` and `yearlyworkingdays`. `m` means months; `min` means minutes.
+
+**Resources**
+
+- `effort` is person-time: two resources available in a slot contribute two
+  slots of it. `mandatory` requires a resource for the task to progress at all;
+  `persistent` keeps the one first chosen; `alternative` falls back.
+- `dailymax`, `weeklymax`, `monthlymax`, `maximum` and their `min` counterparts
+  block at the cap **and** release in the next period. Periods are counted in the
+  resource's own calendar, and a cap smaller than one slot is honoured exactly.
+
+**Scheduling**
+
+- ASAP and ALAP, including chains that mix the two.
+- Contention is resolved by priority, then criticalness, then declaration order.
+- The declared project period is never rewritten. A task that does not fit is
+  reported, with its name and the reason.
+- Scheduling the same project twice produces the same dates and the same bookings.
+- `maxgapduration`, `maxgaplength`, `maxstart`, `minstart`, `maxend` and `minend`
+  are checked once the schedule is complete, and a violation is an error.
+
+**Honesty**
+
+- A project that cannot be scheduled exits non-zero and says why. A dependency
+  cycle is rejected before scheduling, naming the cycle.
+- An attribute or reference the parser cannot place is an error, never a silent
+  drop.
+- `report_id` is a SHA-256 of the rendered result, so it differs when the
+  schedule differs.
+
+## Known limits
+
+- `include`, `supplement`, `leaveallowance` and `statussheet` are not implemented.
+- Output formats are JSON and CSV. `ical`, `tjp`, `niku` and MS Project XML are
+  rejected at parse time rather than silently producing nothing.
+- Accounts are parsed but not yet modelled, so `chargeset` and `charge` record an
+  amount without posting it anywhere.
+- `onstart` dependencies are read as "the dependent task must finish before the
+  predecessor starts", which is ScriptPlan's own reading rather than
+  TaskJuggler's start-to-start one.
 
 ## Example Project
 

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

@@ -1,10 +1,11 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel", "cython>=3.0.0"]
+requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "scriptplan"
-version = "0.9.2"
+# Single source of truth: scriptplan/__init__.py
+dynamic = ["version"]
 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" },
@@ -50,7 +51,6 @@ dev = [
     "twine",
     "ruff>=0.1.0",
     "mypy>=1.0.0",
-    "cython>=3.0.0",
 ]
 
 [project.scripts]
@@ -62,23 +62,29 @@ plan = "scriptplan.cli.plan:main"
 "Documentation" = "https://github.com/rodmena-limited/scriptplan#readme"
 "Bug Tracker" = "https://github.com/rodmena-limited/scriptplan/issues"
 "Source" = "https://github.com/rodmena-limited/scriptplan"
+"Changelog" = "https://github.com/rodmena-limited/scriptplan/blob/main/CHANGELOG.md"
 
 [tool.setuptools]
 include-package-data = true
 
+[tool.setuptools.dynamic]
+version = { attr = "scriptplan.__version__" }
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["scriptplan*"]
 
 [tool.setuptools.package-data]
-scriptplan = ["py.typed", "parser/*.lark", "_cython/*.pyx"]
+scriptplan = ["py.typed", "parser/*.lark"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = ["test_*.py"]
 python_classes = ["Test*"]
 python_functions = ["test_*"]
-addopts = "-v --tb=short -n auto"
+# No -n here: pytest-xdist is an optional extra, and requiring it means
+# the suite cannot start without it. Pass -n yourself to parallelise.
+addopts = "--tb=short"
 filterwarnings = [
     "ignore::DeprecationWarning",
     "ignore::PendingDeprecationWarning",

{scriptplan-0.9.2 → scriptplan-0.10.0}/scriptplan/__init__.py

@@ -9,7 +9,10 @@ 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"
+# The single source of truth for the version; pyproject reads it from here.
+# A semantic change: effort is now person-time, failures are reported as
+# failures, and the compiled extensions are gone.
+__version__ = "0.10.0"
 __author__ = "ScriptPlan Team"
 
 from scriptplan.core.project import Project