PyPI - planaco - Versions diffs - 0.2.2__tar.gz → 0.2.3__tar.gz - Mend

planaco 0.2.2tar.gz → 0.2.3tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

{planaco-0.2.2/src/planaco.egg-info → planaco-0.2.3}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: planaco
-Version: 0.2.2
+Version: 0.2.3
 Summary: Task and project estimation using Monte Carlo simulation
 Author: Martijn Wieriks
 License: MIT
@@ -39,15 +39,20 @@ Dynamic: license-file
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-dark.svg">
-    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-light.svg" alt="planaco" width="320">
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-dark.svg">
+    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-light.svg" alt="planaco" width="320">
   </picture>
   **Probabilistic Project Planning with Monte Carlo Simulation**
-  [![Python](https://img.shields.io/badge/python-3.8+-blue.svg?style=flat-square)](https://www.python.org)
+  [![CI](https://img.shields.io/github/actions/workflow/status/sepam/planaco/ci.yml?branch=master&style=flat-square&label=CI)](https://github.com/sepam/planaco/actions/workflows/ci.yml)
+  [![PyPI version](https://img.shields.io/pypi/v/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
+  [![Python versions](https://img.shields.io/pypi/pyversions/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
   [![License](https://img.shields.io/github/license/sepam/planaco?style=flat-square)](LICENSE.md)
   ![Status](https://img.shields.io/badge/status-alpha-orange?style=flat-square)
+  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
+  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)
+  [![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue?style=flat-square)](https://mypy-lang.org/)
   <p align="center">
     <a href="#why-planaco">Why Planaco?</a> •
@@ -69,7 +74,7 @@ Estimating the time it takes to complete a task or project is hard. Traditional
 **Planaco helps you make better estimates by modeling tasks as random processes**, accounting for uncertainty and task dependencies through Monte Carlo simulation.
-> **Status:** Planaco is in **alpha** (v0.2.2). The public API may still change between releases.
+> **Status:** Planaco is in **alpha** (v0.2.3). The public API may still change between releases.
 ## Features
@@ -118,7 +123,7 @@ task = Task(
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/task_definition.png" alt="Task Definition" width="600"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/task_definition.png" alt="Task Definition" width="600"/>
 </div>
 ### Build Projects with Dependencies
@@ -147,7 +152,7 @@ project.add_task(deploy, depends_on=[testing])
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/project_estimation.png" alt="Project Estimation" width="700"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/project_estimation.png" alt="Project Estimation" width="700"/>
 </div>
 ---
@@ -191,7 +196,7 @@ project.plot(n=10000, hist=True)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
 </div>
 ### Cumulative Distribution
@@ -204,7 +209,7 @@ project.plot(n=10000, hist=False)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
 </div>
 The cumulative distribution shows the probability of completing the project within a given timeframe, accounting for both parallel and sequential task execution.
@@ -217,10 +222,10 @@ The cumulative distribution shows the probability of completing the project with
 ```python
 # Export to JSON
-project.export_results(n=10000, format='json', filename='results.json')
+project.export_results(n=10000, format='json', output='results.json')
 # Export to CSV
-project.export_results(n=10000, format='csv', filename='results.csv')
+project.export_results(n=10000, format='csv', output='results.csv')
 ```
 ### Probability Distributions
@@ -366,20 +371,20 @@ project:
   seed: 42  # optional, for reproducible runs
 tasks:
-  - name: Design
-    distribution:
-      type: pert
-      minimum: 5
-      mode: 7
-      maximum: 14
-  - name: Development
-    depends_on: [Design]
-    distribution:
-      type: triangular
-      minimum: 10
-      mode: 15
-      maximum: 25
+  design:
+    name: Design
+    estimator: pert
+    min_duration: 5
+    mode_duration: 7
+    max_duration: 14
+  development:
+    name: Development
+    estimator: triangular
+    min_duration: 10
+    mode_duration: 15
+    max_duration: 25
+    depends_on: [design]
 ```
 Run `planaco --help` or `planaco <command> --help` to see all available options, including `--seed` for reproducible results and `-p/--percentile` markers for plots.
@@ -421,7 +426,7 @@ Please open an issue to discuss larger changes before starting work.
 ## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
 ---

{planaco-0.2.2 → planaco-0.2.3}/README.md RENAMED Viewed

@@ -1,14 +1,19 @@
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-dark.svg">
-    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-light.svg" alt="planaco" width="320">
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-dark.svg">
+    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-light.svg" alt="planaco" width="320">
   </picture>
   **Probabilistic Project Planning with Monte Carlo Simulation**
-  [![Python](https://img.shields.io/badge/python-3.8+-blue.svg?style=flat-square)](https://www.python.org)
+  [![CI](https://img.shields.io/github/actions/workflow/status/sepam/planaco/ci.yml?branch=master&style=flat-square&label=CI)](https://github.com/sepam/planaco/actions/workflows/ci.yml)
+  [![PyPI version](https://img.shields.io/pypi/v/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
+  [![Python versions](https://img.shields.io/pypi/pyversions/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
   [![License](https://img.shields.io/github/license/sepam/planaco?style=flat-square)](LICENSE.md)
   ![Status](https://img.shields.io/badge/status-alpha-orange?style=flat-square)
+  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
+  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)
+  [![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue?style=flat-square)](https://mypy-lang.org/)
   <p align="center">
     <a href="#why-planaco">Why Planaco?</a> •
@@ -30,7 +35,7 @@ Estimating the time it takes to complete a task or project is hard. Traditional
 **Planaco helps you make better estimates by modeling tasks as random processes**, accounting for uncertainty and task dependencies through Monte Carlo simulation.
-> **Status:** Planaco is in **alpha** (v0.2.2). The public API may still change between releases.
+> **Status:** Planaco is in **alpha** (v0.2.3). The public API may still change between releases.
 ## Features
@@ -79,7 +84,7 @@ task = Task(
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/task_definition.png" alt="Task Definition" width="600"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/task_definition.png" alt="Task Definition" width="600"/>
 </div>
 ### Build Projects with Dependencies
@@ -108,7 +113,7 @@ project.add_task(deploy, depends_on=[testing])
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/project_estimation.png" alt="Project Estimation" width="700"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/project_estimation.png" alt="Project Estimation" width="700"/>
 </div>
 ---
@@ -152,7 +157,7 @@ project.plot(n=10000, hist=True)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
 </div>
 ### Cumulative Distribution
@@ -165,7 +170,7 @@ project.plot(n=10000, hist=False)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
 </div>
 The cumulative distribution shows the probability of completing the project within a given timeframe, accounting for both parallel and sequential task execution.
@@ -178,10 +183,10 @@ The cumulative distribution shows the probability of completing the project with
 ```python
 # Export to JSON
-project.export_results(n=10000, format='json', filename='results.json')
+project.export_results(n=10000, format='json', output='results.json')
 # Export to CSV
-project.export_results(n=10000, format='csv', filename='results.csv')
+project.export_results(n=10000, format='csv', output='results.csv')
 ```
 ### Probability Distributions
@@ -327,20 +332,20 @@ project:
   seed: 42  # optional, for reproducible runs
 tasks:
-  - name: Design
-    distribution:
-      type: pert
-      minimum: 5
-      mode: 7
-      maximum: 14
-  - name: Development
-    depends_on: [Design]
-    distribution:
-      type: triangular
-      minimum: 10
-      mode: 15
-      maximum: 25
+  design:
+    name: Design
+    estimator: pert
+    min_duration: 5
+    mode_duration: 7
+    max_duration: 14
+  development:
+    name: Development
+    estimator: triangular
+    min_duration: 10
+    mode_duration: 15
+    max_duration: 25
+    depends_on: [design]
 ```
 Run `planaco --help` or `planaco <command> --help` to see all available options, including `--seed` for reproducible results and `-p/--percentile` markers for plots.
@@ -382,7 +387,7 @@ Please open an issue to discuss larger changes before starting work.
 ## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
 ---

{planaco-0.2.2 → planaco-0.2.3}/pyproject.toml RENAMED Viewed

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "planaco"
-version = "0.2.2"
+dynamic = ["version"]
 description = "Task and project estimation using Monte Carlo simulation"
 readme = "README.md"
 license = {text = "MIT"}
@@ -63,6 +63,9 @@ Repository = "https://github.com/sepam/planaco"
 [tool.setuptools.packages.find]
 where = ["src"]
+[tool.setuptools.dynamic]
+version = {attr = "planaco.__version__"}
 [tool.mypy]
 python_version = "3.9"
 warn_return_any = true

{planaco-0.2.2 → planaco-0.2.3}/src/planaco/__init__.py RENAMED Viewed

@@ -72,7 +72,7 @@ Using Distribution Objects
 >>> from planaco import Task, PERTDistribution
 >>>
 >>> # Use PERT distribution for smoother estimates
->>> dist = PERTDistribution(minimum=5, mode=7, maximum=14)
+>>> dist = PERTDistribution(min_value=5, mode_value=7, max_value=14)
 >>> task = Task(name="Design", distribution=dist)
 Configuration Files
@@ -87,20 +87,21 @@ Example YAML::
       unit: "days"
     tasks:
-      - name: "Design"
-        distribution:
-          type: "pert"
-          minimum: 5
-          mode: 7
-          maximum: 14
-      - name: "Development"
-        depends_on: ["Design"]
-        distribution:
-          type: "triangular"
-          minimum: 10
-          mode: 15
-          maximum: 25
+      design:
+        name: "Design"
+        estimator: "pert"
+        min_duration: 5
+        mode_duration: 7
+        max_duration: 14
+      development:
+        name: "Development"
+        estimator: "triangular"
+        min_duration: 10
+        mode_duration: 15
+        max_duration: 25
+        depends_on:
+          - design
 Command Line Interface
 ----------------------
@@ -119,10 +120,6 @@ planaco.task : Task class for individual tasks.
 planaco.project : Project class for task collections.
 planaco.config : YAML configuration loading.
 planaco.cli : Command-line interface.
-Version
--------
-0.2.2
 """
 # Import order matters: distributions -> task -> project to avoid circular imports
@@ -138,7 +135,7 @@ from planaco.distributions import (
 from planaco.task import Task
 from planaco.project import Project
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 __all__ = [
     # Core classes

{planaco-0.2.2 → planaco-0.2.3}/src/planaco/config.py RENAMED Viewed

@@ -104,7 +104,7 @@ def load_config(config_path: str) -> Dict[str, Any]:
         raise FileNotFoundError(f"Configuration file not found: {config_path}")
     with open(path) as f:
-        config = yaml.safe_load(f)
+        config: Dict[str, Any] = yaml.safe_load(f)
     _validate_config(config)
     return config

{planaco-0.2.2 → planaco-0.2.3}/src/planaco/project.py RENAMED Viewed

@@ -74,7 +74,6 @@ import seaborn as sns
 from planaco.task import Task
 class Project:
     """A collection of tasks with optional dependencies for Monte Carlo simulation.
@@ -115,7 +114,6 @@ class Project:
     >>> print(f"P85: {stats['percentiles']['p85']:.1f} {stats['unit']}")
     """
     def __init__(self, name: Optional[str] = None, unit: str = "days") -> None:
         """Initialize a new Project.
@@ -843,7 +841,7 @@ class Project:
             if show_percentiles:
                 colors = ["red", "orange", "purple", "green", "blue"]
                 for i, p in enumerate(percentiles):
-                    p_value = np.percentile(sims, p)
+                    p_value = float(np.percentile(sims, p))
                     color = colors[i % len(colors)]
                     ax.axvline(
                         x=p_value,
@@ -861,8 +859,9 @@ class Project:
                     )
             else:
                 # Default: show only median
-                ax.axvline(x=np.median(sims), color="red", label="50%")
-                ax.text(np.median(sims) - 0.5, ax.get_ylim()[0], "50%", color="red")
+                median = float(np.median(sims))
+                ax.axvline(x=median, color="red", label="50%")
+                ax.text(median - 0.5, ax.get_ylim()[0], "50%", color="red")
             ax.legend()

{planaco-0.2.2 → planaco-0.2.3}/src/planaco/task.py RENAMED Viewed

@@ -45,7 +45,7 @@ Example
 >>> # Modern style: use a Distribution object
 >>> from planaco import PERTDistribution
->>> dist = PERTDistribution(minimum=5, mode=8, maximum=15)
+>>> dist = PERTDistribution(min_value=5, mode_value=8, max_value=15)
 >>> task = Task(name="Development", distribution=dist)
 See Also
@@ -78,8 +78,6 @@ class Task:
     ----------
     task_id : str
         Unique identifier (UUID) for the task.
-    cdate : datetime
-        Creation timestamp.
     name : str or None
         Human-readable name for the task.
@@ -233,7 +231,7 @@ class Task:
         """
         if self._distribution is not None:
             if hasattr(self._distribution, "min_value"):
-                return self._distribution.min_value
+                return float(self._distribution.min_value)
         return self._min_duration
     @property
@@ -254,7 +252,7 @@ class Task:
         """
         if self._distribution is not None:
             if hasattr(self._distribution, "mode_value"):
-                return self._distribution.mode_value
+                return float(self._distribution.mode_value)
         return self._mode_duration
     @property
@@ -275,7 +273,7 @@ class Task:
         """
         if self._distribution is not None:
             if hasattr(self._distribution, "max_value"):
-                return self._distribution.max_value
+                return float(self._distribution.max_value)
         return self._max_duration
     def estimate(self) -> float:

{planaco-0.2.2 → planaco-0.2.3/src/planaco.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: planaco
-Version: 0.2.2
+Version: 0.2.3
 Summary: Task and project estimation using Monte Carlo simulation
 Author: Martijn Wieriks
 License: MIT
@@ -39,15 +39,20 @@ Dynamic: license-file
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-dark.svg">
-    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/brand/planaco-lockup-light.svg" alt="planaco" width="320">
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-dark.svg">
+    <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/brand/planaco-lockup-light.svg" alt="planaco" width="320">
   </picture>
   **Probabilistic Project Planning with Monte Carlo Simulation**
-  [![Python](https://img.shields.io/badge/python-3.8+-blue.svg?style=flat-square)](https://www.python.org)
+  [![CI](https://img.shields.io/github/actions/workflow/status/sepam/planaco/ci.yml?branch=master&style=flat-square&label=CI)](https://github.com/sepam/planaco/actions/workflows/ci.yml)
+  [![PyPI version](https://img.shields.io/pypi/v/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
+  [![Python versions](https://img.shields.io/pypi/pyversions/planaco.svg?style=flat-square)](https://pypi.org/project/planaco/)
   [![License](https://img.shields.io/github/license/sepam/planaco?style=flat-square)](LICENSE.md)
   ![Status](https://img.shields.io/badge/status-alpha-orange?style=flat-square)
+  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
+  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)
+  [![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue?style=flat-square)](https://mypy-lang.org/)
   <p align="center">
     <a href="#why-planaco">Why Planaco?</a> •
@@ -69,7 +74,7 @@ Estimating the time it takes to complete a task or project is hard. Traditional
 **Planaco helps you make better estimates by modeling tasks as random processes**, accounting for uncertainty and task dependencies through Monte Carlo simulation.
-> **Status:** Planaco is in **alpha** (v0.2.2). The public API may still change between releases.
+> **Status:** Planaco is in **alpha** (v0.2.3). The public API may still change between releases.
 ## Features
@@ -118,7 +123,7 @@ task = Task(
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/task_definition.png" alt="Task Definition" width="600"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/task_definition.png" alt="Task Definition" width="600"/>
 </div>
 ### Build Projects with Dependencies
@@ -147,7 +152,7 @@ project.add_task(deploy, depends_on=[testing])
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/project_estimation.png" alt="Project Estimation" width="700"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/project_estimation.png" alt="Project Estimation" width="700"/>
 </div>
 ---
@@ -191,7 +196,7 @@ project.plot(n=10000, hist=True)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_estimation.png" alt="Monte Carlo Histogram" width="550"/>
 </div>
 ### Cumulative Distribution
@@ -204,7 +209,7 @@ project.plot(n=10000, hist=False)
 ```
 <div align="center">
-  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.2/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
+  <img src="https://raw.githubusercontent.com/sepam/planaco/v0.2.3/example/monte_carlo_cumulative.png" alt="Cumulative Distribution" width="550"/>
 </div>
 The cumulative distribution shows the probability of completing the project within a given timeframe, accounting for both parallel and sequential task execution.
@@ -217,10 +222,10 @@ The cumulative distribution shows the probability of completing the project with
 ```python
 # Export to JSON
-project.export_results(n=10000, format='json', filename='results.json')
+project.export_results(n=10000, format='json', output='results.json')
 # Export to CSV
-project.export_results(n=10000, format='csv', filename='results.csv')
+project.export_results(n=10000, format='csv', output='results.csv')
 ```
 ### Probability Distributions
@@ -366,20 +371,20 @@ project:
   seed: 42  # optional, for reproducible runs
 tasks:
-  - name: Design
-    distribution:
-      type: pert
-      minimum: 5
-      mode: 7
-      maximum: 14
-  - name: Development
-    depends_on: [Design]
-    distribution:
-      type: triangular
-      minimum: 10
-      mode: 15
-      maximum: 25
+  design:
+    name: Design
+    estimator: pert
+    min_duration: 5
+    mode_duration: 7
+    max_duration: 14
+  development:
+    name: Development
+    estimator: triangular
+    min_duration: 10
+    mode_duration: 15
+    max_duration: 25
+    depends_on: [design]
 ```
 Run `planaco --help` or `planaco <command> --help` to see all available options, including `--seed` for reproducible results and `-p/--percentile` markers for plots.
@@ -421,7 +426,7 @@ Please open an issue to discuss larger changes before starting work.
 ## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
 ---

{planaco-0.2.2 → planaco-0.2.3}/src/planaco.egg-info/SOURCES.txt RENAMED Viewed

@@ -17,5 +17,6 @@ tests/test_cli.py
 tests/test_config.py
 tests/test_distributions.py
 tests/test_project.py
+tests/test_readme_examples.py
 tests/test_refactoring.py
 tests/test_task.py

{planaco-0.2.2 → planaco-0.2.3}/tests/test_cli.py RENAMED Viewed

@@ -6,6 +6,7 @@ from pathlib import Path
 import pytest
 from click.testing import CliRunner
+from planaco import __version__
 from planaco.cli import main
 # Get path to fixtures directory
@@ -43,7 +44,7 @@ class TestMainGroup:
         """Test --version flag."""
         result = runner.invoke(main, ["--version"])
         assert result.exit_code == 0
-        assert "0.2.2" in result.output
+        assert __version__ in result.output
 class TestInitCommand:

{planaco-0.2.2 → planaco-0.2.3}/tests/test_distributions.py RENAMED Viewed

@@ -726,7 +726,9 @@ class TestDistributionRoundTrip:
     def test_normal_round_trip_with_bounds(self):
         """Normal distribution with explicit bounds survives round-trip."""
-        original = NormalDistribution(mean=7.0, std_dev=2.0, min_value=3.0, max_value=11.0)
+        original = NormalDistribution(
+            mean=7.0, std_dev=2.0, min_value=3.0, max_value=11.0
+        )
         d = original.to_dict()
         restored = create_distribution(estimator=d.pop("type"), **d)
         assert isinstance(restored, NormalDistribution)
@@ -772,7 +774,9 @@ class TestDistributionRoundTrip:
     def test_lognormal_round_trip_with_bounds(self):
         """LogNormal with explicit bounds survives round-trip."""
-        original = LogNormalDistribution(mean=8.0, std_dev=3.0, min_value=2.0, max_value=20.0)
+        original = LogNormalDistribution(
+            mean=8.0, std_dev=3.0, min_value=2.0, max_value=20.0
+        )
         d = original.to_dict()
         restored = create_distribution(estimator=d.pop("type"), **d)
         assert isinstance(restored, LogNormalDistribution)

planaco-0.2.3/tests/test_readme_examples.py ADDED Viewed

@@ -0,0 +1,69 @@
+"""Ensure code examples in README.md stay in sync with the actual API.
+Extracts fenced ``python`` and ``yaml`` code blocks from README.md and
+executes them, so a README example that no longer matches the library
+fails the test suite instead of failing for a new user.
+"""
+import re
+from pathlib import Path
+import matplotlib
+matplotlib.use("Agg")  # Non-interactive backend for testing
+import matplotlib.pyplot as plt  # noqa: E402
+import pytest  # noqa: E402
+from planaco.config import build_project_from_config, load_config  # noqa: E402
+README_PATH = Path(__file__).resolve().parent.parent / "README.md"
+def _extract_code_blocks(language):
+    """Return the contents of all fenced code blocks for a language."""
+    text = README_PATH.read_text(encoding="utf-8")
+    pattern = re.compile(rf"```{language}\n(.*?)```", re.DOTALL)
+    return pattern.findall(text)
+def test_readme_python_examples_run(tmp_path, monkeypatch):
+    """All Python examples must run in order without errors.
+    Blocks are executed cumulatively in a shared namespace because later
+    examples build on objects defined in earlier ones (e.g. ``project``).
+    """
+    monkeypatch.chdir(tmp_path)  # exported files land in a temp dir
+    blocks = _extract_code_blocks("python")
+    assert blocks, "No Python code blocks found in README.md"
+    namespace = {}
+    for i, block in enumerate(blocks, start=1):
+        try:
+            exec(compile(block, f"README.md python block {i}", "exec"), namespace)
+        except Exception as e:
+            pytest.fail(
+                f"README.md python block {i} raised {type(e).__name__}: {e}\n"
+                f"---\n{block}---"
+            )
+        finally:
+            plt.close("all")
+def test_readme_yaml_examples_load(tmp_path):
+    """All YAML project examples must pass config validation and simulate."""
+    blocks = [b for b in _extract_code_blocks("yaml") if "project:" in b]
+    assert blocks, "No YAML project config blocks found in README.md"
+    for i, block in enumerate(blocks, start=1):
+        config_file = tmp_path / f"readme_example_{i}.yaml"
+        config_file.write_text(block, encoding="utf-8")
+        try:
+            config = load_config(str(config_file))
+            project = build_project_from_config(config)
+            project.statistics(n=100)
+        except Exception as e:
+            pytest.fail(
+                f"README.md yaml block {i} raised {type(e).__name__}: {e}\n"
+                f"---\n{block}---"
+            )

{planaco-0.2.2 → planaco-0.2.3}/tests/test_refactoring.py RENAMED Viewed

@@ -254,7 +254,9 @@ class TestExportResultsEfficiency:
             call_count += 1
             return original_estimate()
-        with tempfile.NamedTemporaryFile(suffix=".json", delete=True) as tmp:  # noqa: SIM117
+        with tempfile.NamedTemporaryFile(  # noqa: SIM117
+            suffix=".json", delete=True
+        ) as tmp:
             with patch.object(p, "estimate", side_effect=counting_estimate):
                 p.export_results(n=n, format="json", output=tmp.name)