jsonantt 2026.1__tar.gz

jsonantt-2026.1/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: jsonantt
+Version: 2026.1
+Summary: Generate Gantt charts from JSON descriptions using matplotlib
+Keywords: gantt,chart,matplotlib,project-management,visualization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: matplotlib>=3.5
+
+# jsonantt
+
+**jsonantt** generates beautiful Gantt chart images from a simple JSON description.  
+Charts are rendered with [matplotlib](https://matplotlib.org/) so they can be saved as `.png`, `.pdf`, `.svg`, and more.
+
+---
+
+## Features
+
+- **Infinitely nestable tasks** — define sub-tasks, sub-sub-tasks, etc.
+- **Auto date computation** — parent task start/end are derived automatically from children when not specified.
+- **Milestone markers** — easy `"milestone": true` flag renders a distinctive diamond.
+- **Fully colourable** — set colours per-task; children inherit their parent's colour.
+- **Clean, indented y-axis labels** — task names are left-aligned with proper indentation per depth level.
+- **PNG / PDF / SVG output** — whatever matplotlib supports.
+
+---
+
+## Installation
+
+```bash
+pip install jsonantt
+```
+
+Or, directly from source:
+
+```bash
+git clone https://github.com/briday1/jsonantt.git
+cd jsonantt
+pip install -e .
+```
+
+---
+
+## Quick start
+
+### 1. Create a JSON description
+
+```json
+{
+  "title": "My Project",
+  "dateformat": "%Y-%m-%d",
+  "tasks": [
+    {
+      "name": "Phase 1 – Planning",
+      "children": [
+        { "name": "Requirements", "start": "2024-01-08", "end": "2024-01-19" },
+        { "name": "Architecture",  "start": "2024-01-15", "end": "2024-01-31" }
+      ]
+    },
+    { "name": "Planning done", "milestone": true, "date": "2024-01-31" },
+    {
+      "name": "Phase 2 – Build",
+      "color": "#70AD47",
+      "children": [
+        { "name": "Backend",  "start": "2024-02-01", "end": "2024-03-01" },
+        { "name": "Frontend", "start": "2024-02-12", "end": "2024-03-08" }
+      ]
+    },
+    { "name": "Launch", "milestone": true, "date": "2024-04-01", "color": "#FF5757" }
+  ]
+}
+```
+
+### 2. Generate the chart
+
+**CLI:**
+
+```bash
+jsonantt project.json project.png
+jsonantt project.json project.pdf   # vector PDF
+jsonantt project.json project.svg   # scalable SVG
+jsonantt --dpi 300 project.json project.png   # high-resolution PNG
+```
+
+**Python API:**
+
+```python
+from jsonantt import load_chart, render_chart
+
+config = load_chart("project.json")
+render_chart(config, "project.png", dpi=150)
+```
+
+---
+
+## JSON reference
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `title` | string | Optional chart title shown at the top |
+| `dateformat` | string | `strptime` format string (default: `"%Y-%m-%d"`) |
+| `start` | date string | Optional chart x-axis start date (overrides task dates) |
+| `end` | date string | Optional chart x-axis end date |
+| `style` | object | Visual style overrides (see below) |
+| `tasks` | array | Top-level list of task objects |
+
+### Task object
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | string | **Required.** Task label |
+| `start` | date string | Bar start date |
+| `end` | date string | Bar end date |
+| `color` | CSS hex string | Bar/milestone colour (e.g. `"#4472C4"`) |
+| `milestone` | boolean | Render as a diamond milestone instead of a bar |
+| `date` | date string | Milestone date (used when `milestone: true`) |
+| `children` | array | Nested sub-tasks (infinitely nestable) |
+
+> **Auto date computation:** When a task has `children` but no explicit `start`/`end`, the dates are computed automatically as the earliest child start and latest child end, recursively.
+
+### Style object
+
+| Field | Default | Description |
+|-------|---------|-------------|
+| `width` | `14` | Figure width in inches |
+| `row_height` | `0.45` | Height of each task row in inches |
+| `bar_height` | `0.5` | Bar height as a fraction of `row_height` |
+| `font_size` | `9` | Base font size in points |
+| `indent_size` | `3` | Spaces added per depth level in labels |
+| `label_fraction` | `0.28` | Fraction of figure width used for labels |
+| `colors` | palette | Array of default hex colours cycled per top-level task |
+| `background` | `"#FFFFFF"` | Figure background colour |
+| `grid_color` | `"#E0E0E0"` | Vertical gridline colour |
+| `row_band_color` | `"#F5F5F5"` | Alternating row band colour |
+| `milestone_color` | `"#E65100"` | Default milestone colour |
+
+---
+
+## Examples
+
+See the [`examples/`](examples/) folder for ready-to-run JSON files:
+
+- [`examples/simple.json`](examples/simple.json) — a three-phase project with milestones
+- [`examples/complex.json`](examples/complex.json) — a multi-quarter roadmap with deep nesting and custom colours
+
+Generate them locally:
+
+```bash
+jsonantt examples/simple.json simple.png
+jsonantt examples/complex.json complex.png
+```
+
+---
+
+## License
+
+MIT

jsonantt-2026.1/README.md

@@ -0,0 +1,148 @@
+# jsonantt
+
+**jsonantt** generates beautiful Gantt chart images from a simple JSON description.  
+Charts are rendered with [matplotlib](https://matplotlib.org/) so they can be saved as `.png`, `.pdf`, `.svg`, and more.
+
+---
+
+## Features
+
+- **Infinitely nestable tasks** — define sub-tasks, sub-sub-tasks, etc.
+- **Auto date computation** — parent task start/end are derived automatically from children when not specified.
+- **Milestone markers** — easy `"milestone": true` flag renders a distinctive diamond.
+- **Fully colourable** — set colours per-task; children inherit their parent's colour.
+- **Clean, indented y-axis labels** — task names are left-aligned with proper indentation per depth level.
+- **PNG / PDF / SVG output** — whatever matplotlib supports.
+
+---
+
+## Installation
+
+```bash
+pip install jsonantt
+```
+
+Or, directly from source:
+
+```bash
+git clone https://github.com/briday1/jsonantt.git
+cd jsonantt
+pip install -e .
+```
+
+---
+
+## Quick start
+
+### 1. Create a JSON description
+
+```json
+{
+  "title": "My Project",
+  "dateformat": "%Y-%m-%d",
+  "tasks": [
+    {
+      "name": "Phase 1 – Planning",
+      "children": [
+        { "name": "Requirements", "start": "2024-01-08", "end": "2024-01-19" },
+        { "name": "Architecture",  "start": "2024-01-15", "end": "2024-01-31" }
+      ]
+    },
+    { "name": "Planning done", "milestone": true, "date": "2024-01-31" },
+    {
+      "name": "Phase 2 – Build",
+      "color": "#70AD47",
+      "children": [
+        { "name": "Backend",  "start": "2024-02-01", "end": "2024-03-01" },
+        { "name": "Frontend", "start": "2024-02-12", "end": "2024-03-08" }
+      ]
+    },
+    { "name": "Launch", "milestone": true, "date": "2024-04-01", "color": "#FF5757" }
+  ]
+}
+```
+
+### 2. Generate the chart
+
+**CLI:**
+
+```bash
+jsonantt project.json project.png
+jsonantt project.json project.pdf   # vector PDF
+jsonantt project.json project.svg   # scalable SVG
+jsonantt --dpi 300 project.json project.png   # high-resolution PNG
+```
+
+**Python API:**
+
+```python
+from jsonantt import load_chart, render_chart
+
+config = load_chart("project.json")
+render_chart(config, "project.png", dpi=150)
+```
+
+---
+
+## JSON reference
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `title` | string | Optional chart title shown at the top |
+| `dateformat` | string | `strptime` format string (default: `"%Y-%m-%d"`) |
+| `start` | date string | Optional chart x-axis start date (overrides task dates) |
+| `end` | date string | Optional chart x-axis end date |
+| `style` | object | Visual style overrides (see below) |
+| `tasks` | array | Top-level list of task objects |
+
+### Task object
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | string | **Required.** Task label |
+| `start` | date string | Bar start date |
+| `end` | date string | Bar end date |
+| `color` | CSS hex string | Bar/milestone colour (e.g. `"#4472C4"`) |
+| `milestone` | boolean | Render as a diamond milestone instead of a bar |
+| `date` | date string | Milestone date (used when `milestone: true`) |
+| `children` | array | Nested sub-tasks (infinitely nestable) |
+
+> **Auto date computation:** When a task has `children` but no explicit `start`/`end`, the dates are computed automatically as the earliest child start and latest child end, recursively.
+
+### Style object
+
+| Field | Default | Description |
+|-------|---------|-------------|
+| `width` | `14` | Figure width in inches |
+| `row_height` | `0.45` | Height of each task row in inches |
+| `bar_height` | `0.5` | Bar height as a fraction of `row_height` |
+| `font_size` | `9` | Base font size in points |
+| `indent_size` | `3` | Spaces added per depth level in labels |
+| `label_fraction` | `0.28` | Fraction of figure width used for labels |
+| `colors` | palette | Array of default hex colours cycled per top-level task |
+| `background` | `"#FFFFFF"` | Figure background colour |
+| `grid_color` | `"#E0E0E0"` | Vertical gridline colour |
+| `row_band_color` | `"#F5F5F5"` | Alternating row band colour |
+| `milestone_color` | `"#E65100"` | Default milestone colour |
+
+---
+
+## Examples
+
+See the [`examples/`](examples/) folder for ready-to-run JSON files:
+
+- [`examples/simple.json`](examples/simple.json) — a three-phase project with milestones
+- [`examples/complex.json`](examples/complex.json) — a multi-quarter roadmap with deep nesting and custom colours
+
+Generate them locally:
+
+```bash
+jsonantt examples/simple.json simple.png
+jsonantt examples/complex.json complex.png
+```
+
+---
+
+## License
+
+MIT

jsonantt-2026.1/jsonantt/__init__.py

@@ -0,0 +1,18 @@
+"""jsonantt – Gantt chart generation from JSON descriptions.
+
+Quick-start example::
+
+    from jsonantt import load_chart, render_chart
+
+    config = load_chart("project.json")
+    render_chart(config, "project.png")
+
+Or from the command line::
+
+    jsonantt project.json project.png
+"""
+from .parser import load_chart, parse_chart
+from .renderer import render_chart
+
+__all__ = ["load_chart", "parse_chart", "render_chart"]
+__version__ = "0.1.0"

jsonantt-2026.1/jsonantt/cli.py

@@ -0,0 +1,49 @@
+"""Command-line interface for jsonantt."""
+from __future__ import annotations
+
+import argparse
+import sys
+
+from .parser import load_chart
+from .renderer import render_chart
+
+
+def main(argv=None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="jsonantt",
+        description=(
+            "Generate a Gantt chart image from a JSON description.\n\n"
+            "Example:\n  jsonantt project.json chart.png\n  jsonantt project.json chart.pdf"
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("input", help="Path to the JSON chart description file")
+    parser.add_argument("output", help="Output image path (e.g. chart.png, chart.pdf)")
+    parser.add_argument(
+        "--dpi", type=int, default=150,
+        help="Image resolution in DPI (default: 150, raster formats only)",
+    )
+
+    args = parser.parse_args(argv)
+
+    try:
+        config = load_chart(args.input)
+    except FileNotFoundError:
+        print(f"error: input file not found: {args.input}", file=sys.stderr)
+        return 1
+    except Exception as exc:  # noqa: BLE001
+        print(f"error: failed to parse {args.input}: {exc}", file=sys.stderr)
+        return 1
+
+    try:
+        render_chart(config, args.output, dpi=args.dpi)
+    except Exception as exc:  # noqa: BLE001
+        print(f"error: failed to render chart: {exc}", file=sys.stderr)
+        return 1
+
+    print(f"Chart saved to {args.output}")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

jsonantt-2026.1/jsonantt/models.py

@@ -0,0 +1,129 @@
+"""Data models for jsonantt."""
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from datetime import date
+from typing import List, Optional
+
+
+# ---------------------------------------------------------------------------
+# Default colour palette (can be overridden in JSON "style" block)
+# ---------------------------------------------------------------------------
+DEFAULT_PALETTE: List[str] = [
+    "#4472C4",  # steel blue
+    "#ED7D31",  # orange
+    "#70AD47",  # green
+    "#FF5757",  # coral red
+    "#9DC3E6",  # sky blue
+    "#FFC000",  # amber
+    "#7030A0",  # purple
+    "#00B0F0",  # cyan
+    "#FF0066",  # hot pink
+    "#00B050",  # emerald
+]
+
+
+@dataclass
+class Arrow:
+    """A dependency arrow connecting the end of one task to the start of another."""
+
+    from_id: str
+    to_id: str
+    color: str = "#888888"
+    label: Optional[str] = None
+
+
+@dataclass
+class Task:
+    """A single task (or milestone) in the Gantt chart.
+
+    Date resolution modes
+    ---------------------
+    1. ``start`` + ``end``   – explicit dates (original behaviour)
+    2. ``start`` + ``duration`` – ``end`` computed from ``start`` + duration
+    3. ``not_before`` + ``duration`` – ``start`` set to the ``effective_end``
+       of the task whose ``id`` matches ``not_before``, then ``end`` computed.
+
+    When absent the values are derived recursively from *children* via
+    :pymeth:`effective_start` / :pymeth:`effective_end`.
+    """
+
+    name: str
+    id: Optional[str] = None           # unique identifier for cross-referencing
+    start: Optional[date] = None
+    end: Optional[date] = None
+    color: Optional[str] = None
+    milestone: bool = False
+    milestone_date: Optional[date] = None
+    children: List["Task"] = field(default_factory=list)
+    # -- deferred-resolution fields (set by parser, consumed during resolve) --
+    not_before: Optional[str] = None   # id of task whose end becomes this start
+    duration_spec: Optional[str] = None  # raw duration string e.g. "3m", "14d"
+    marker_size: Optional[float] = None  # override milestone diamond size (pts)
+    bold: bool = False                    # render label in bold
+
+    # ------------------------------------------------------------------ #
+    #  Computed properties                                                 #
+    # ------------------------------------------------------------------ #
+
+    @property
+    def effective_start(self) -> Optional[date]:
+        """Earliest start date, resolving through children if needed."""
+        if self.milestone:
+            return self.milestone_date or self.start
+        if self.start is not None:
+            return self.start
+        starts = [c.effective_start for c in self.children if c.effective_start is not None]
+        return min(starts) if starts else None
+
+    @property
+    def effective_end(self) -> Optional[date]:
+        """Latest end date, resolving through children if needed."""
+        if self.milestone:
+            return self.milestone_date or self.start
+        if self.end is not None:
+            return self.end
+        ends = [c.effective_end for c in self.children if c.effective_end is not None]
+        return max(ends) if ends else None
+
+    @property
+    def is_parent(self) -> bool:
+        """True when this task has sub-tasks."""
+        return bool(self.children)
+
+
+@dataclass
+class Style:
+    """Visual style configuration for the chart."""
+
+    width: float = 14.0          # figure width in inches
+    row_height: float = 0.3      # height of each row in inches
+    bar_height: float = 0.5      # bar height as fraction of row_height
+    font_size: float = 12.0      # base font size in pts
+    indent_size: int = 3         # spaces added per depth level
+    label_fraction: float = 0.28 # fraction of figure width used for labels
+    colors: List[str] = field(default_factory=lambda: list(DEFAULT_PALETTE))
+    background: str = "#FFFFFF"  # figure background colour
+    grid_color: str = "#E0E0E0"  # vertical gridline colour
+    row_band_color: str = "#F5F5F5"  # alternating row band colour
+    milestone_color: str = "#E65100"  # default milestone colour
+    milestone_size: float = 14.0      # default milestone diamond size (pts)
+    major_tick: Optional[str] = None  # e.g. "year", "quarter", "month", "week"
+    minor_tick: Optional[str] = None  # e.g. "quarter", "month", "week", "day"
+    major_grid_width: float = 2.0     # major gridline linewidth
+    minor_grid_width: float = 1.5     # minor gridline linewidth
+    bold_tasks: bool = True           # auto-bold top-level (depth 0) tasks
+    tick_position: str = "top"        # x-axis label position: "top", "bottom", or "both"
+
+
+@dataclass
+class ChartConfig:
+    """Top-level chart configuration parsed from JSON."""
+
+    tasks: List[Task] = field(default_factory=list)
+    title: str = ""
+    date_format: str = "%Y-%m-%d"
+    start: Optional[date] = None    # force chart x-axis start
+    end: Optional[date] = None      # force chart x-axis end
+    style: Style = field(default_factory=Style)
+    arrows: List[Arrow] = field(default_factory=list)