pydagu 0.1.0__py3-none-any.whl

pydagu/models/step.py

@@ -0,0 +1,144 @@
+"""Step configuration models"""
+
+import re
+from typing import Any, Literal, Self
+from pydantic import BaseModel, Field, model_validator
+
+from pydagu.models.base import Precondition
+from pydagu.models.executor import ExecutorConfig
+
+
+class RetryPolicy(BaseModel):
+    """Retry policy for a step"""
+
+    limit: int = Field(
+        ge=0, description="Maximum number of retries", examples=[3, 5, 10]
+    )
+    intervalSec: int = Field(
+        ge=0, description="Interval between retries in seconds", examples=[30, 60, 300]
+    )
+
+
+class ContinueOn(BaseModel):
+    """Configuration for continuing execution on specific conditions"""
+
+    failure: bool | None = Field(None, description="Continue on failure")
+    skipped: bool | None = Field(None, description="Continue on skipped")
+
+
+class ParallelConfig(BaseModel):
+    """Configuration for parallel step execution"""
+
+    items: list[str] = Field(
+        description="Items to process in parallel",
+        examples=[
+            ["customers", "orders", "products"],
+            ["file1.csv", "file2.csv", "file3.csv"],
+        ],
+    )
+    maxConcurrent: int | None = Field(
+        None, ge=1, description="Maximum concurrent items", examples=[2, 5, 10]
+    )
+
+
+class Step(BaseModel):
+    """A step in the DAG"""
+
+    model_config = {
+        "json_schema_extra": {
+            "anyOf": [{"required": ["command"]}, {"required": ["script"]}],
+        }
+    }
+
+    name: str | None = Field(
+        None, description="Step name", examples=["extract-data", "validate-environment"]
+    )
+    description: str | None = Field(
+        None,
+        description="Step description",
+        examples=["Extract data from source database"],
+    )
+    command: str | None = Field(
+        None,
+        description="Command to execute",
+        examples=["python extract.py --date=${DATE}", "echo 'Processing...'"],
+    )
+    script: str | None = Field(
+        None,
+        description="Script path to execute",
+        examples=["./scripts/process.sh", "process.py"],
+    )
+    depends: str | list[str] | None = Field(
+        None,
+        description="Dependencies (step names)",
+        examples=["validate-environment", ["extract", "transform"]],
+    )
+    output: str | None = Field(
+        None,
+        description="Output variable name",
+        examples=["RAW_DATA_PATH", "RESULT_COUNT"],
+    )
+    params: str | list[str] | None = Field(
+        None,
+        description="Parameters for the step",
+        examples=[
+            "TYPE=${ITEM} INPUT=${RAW_DATA_PATH}",
+            ["--verbose", "--config=prod"],
+        ],
+    )
+    dir: str | None = Field(
+        None, description="Working directory", examples=["/data/workspace", "./scripts"]
+    )
+    executor: ExecutorConfig | None = Field(
+        None, description="Custom executor for this step"
+    )
+    continueOn: ContinueOn | None = Field(
+        None, description="Continue execution conditions"
+    )
+    retryPolicy: RetryPolicy | None = Field(None, description="Retry policy")
+    repeatPolicy: dict[str, Any] | None = Field(None, description="Repeat policy")
+    mailOnError: bool | None = Field(None, description="Send email on error")
+    preconditions: list[Precondition] | None = Field(
+        None, description="Step-level preconditions"
+    )
+    signalOnStop: (
+        Literal["SIGTERM", "SIGINT", "SIGKILL", "SIGHUP", "SIGQUIT"] | None
+    ) = Field(
+        None,
+        description="Signal to send on stop",
+        examples=["SIGTERM", "SIGKILL", "SIGINT"],
+    )
+    parallel: ParallelConfig | None = Field(
+        None, description="Parallel execution configuration"
+    )
+
+    @model_validator(mode="after")
+    def validate_step_has_action(self: Self) -> Self:
+        """Validate that step has at least one of: command or script"""
+        if not (self.command or self.script):
+            raise ValueError(
+                "Step must have at least one of: command or script. "
+                "Examples: command='echo hello', script='./run.sh'"
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_http_executor_command(self: Self) -> Self:
+        """Validate that HTTP executor steps have command in 'METHOD URL' format"""
+        if self.executor and self.executor.type == "http" and self.command:
+            # HTTP executor requires command in format: "METHOD URL"
+            # Valid methods: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
+            # URL can be a literal or a Dagu parameter like ${WEBHOOK_URL}
+            http_method_pattern = re.compile(
+                r"^(GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS)\s+(https?://\S+|\$\{[A-Z_]+\})",
+                re.IGNORECASE,
+            )
+            if not http_method_pattern.match(self.command):
+                raise ValueError(
+                    f"HTTP executor command must be in format 'METHOD URL'. "
+                    f"Got: '{self.command}'. "
+                    f"Examples: 'GET https://api.example.com/data', "
+                    f"'POST https://api.example.com/webhook', "
+                    f"'POST ${{WEBHOOK_URL}}' (using Dagu parameter)"
+                )
+        return self

pydagu/models/types.py

@@ -0,0 +1,16 @@
+from typing import Annotated, TypeAlias
+
+from pydantic import BeforeValidator
+
+
+def _empty_str_to_none(v: str | None) -> None:
+    if v is None:
+        return None
+    if v == "":
+        return None
+    raise ValueError(
+        "Value is not empty"
+    )  # Not str or None, Fall to next type. e.g. Decimal, or a non-empty str
+
+
+EmptyStrToNone: TypeAlias = Annotated[None, BeforeValidator(_empty_str_to_none)]

pydagu-0.1.0.dist-info/METADATA

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: pydagu
+Version: 0.1.0
+Summary: Python client library for Dagu - A cron alternative with a Web UI
+Project-URL: Homepage, https://github.com/yourusername/pydagu
+Project-URL: Documentation, https://github.com/yourusername/pydagu#readme
+Project-URL: Repository, https://github.com/yourusername/pydagu
+Project-URL: Issues, https://github.com/yourusername/pydagu/issues
+Author-email: Patrick Dobbs <patrick.dobbs@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: cron,dag,dagu,scheduler,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.3
+Requires-Dist: pyyaml>=6.0.3
+Provides-Extra: dev
+Requires-Dist: hypothesis-jsonschema>=0.23.1; extra == 'dev'
+Requires-Dist: import-linter>=2.5.2; extra == 'dev'
+Requires-Dist: pre-commit>=4.3.0; extra == 'dev'
+Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.4.2; extra == 'dev'
+Requires-Dist: ruff>=0.14.3; extra == 'dev'
+Requires-Dist: schemathesis>=4.3.18; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pydagu
+
+[![PyPI version](https://badge.fury.io/py/pydagu.svg)](https://badge.fury.io/py/pydagu)
+[![Tests](https://github.com/yourusername/pydagu/actions/workflows/test.yml/badge.svg)](https://github.com/yourusername/pydagu/actions/workflows/test.yml)
+[![Python Versions](https://img.shields.io/pypi/pyversions/pydagu.svg)](https://pypi.org/project/pydagu/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python client library for [Dagu](https://github.com/dagu-org/dagu) - providing type-safe DAG creation and HTTP API interaction with Pydantic validation.
+
+## Features
+
+- 🎯 **Type-safe**: Built with Pydantic models for full type safety and validation
+- 🏗️ **Builder Pattern**: Fluent API for constructing DAGs and steps
+- 🔌 **HTTP Client**: Complete client for Dagu's HTTP API
+- 🔄 **Webhook Support**: Built-in patterns for webhook integration
+- ✅ **Well-tested**: Comprehensive test suite with 95%+ coverage
+- 📝 **Examples**: Production-ready integration examples
+
+## Installation
+
+```bash
+pip install pydagu
+```
+
+## Prerequisites
+
+You need a running [Dagu server](https://github.com/dagu-org/dagu) to run the tests. Install Dagu:
+
+```bash
+# macOS
+brew install dagu-org/brew/dagu
+
+# Linux
+curl -L https://github.com/dagu-org/dagu/releases/latest/download/dagu_linux_amd64.tar.gz | tar xz
+sudo mv dagu /usr/local/bin/
+
+# Start the server
+dagu server
+```
+
+## Quick Start
+
+### Create and Run a Simple DAG
+
+```python
+from pydagu.builder import DagBuilder, StepBuilder
+from pydagu.http import DaguHttpClient
+from pydagu.models.request import StartDagRun
+
+# Initialize client
+client = DaguHttpClient(
+    dag_name="my-first-dag",
+    url_root="http://localhost:8080/api/v2/"
+)
+
+# Build a DAG
+dag = (
+    DagBuilder("my-first-dag")
+    .description("My first DAG with pydagu")
+    .add_step_models(
+        StepBuilder("hello-world")
+        .command("echo 'Hello from pydagu!'")
+        .build()
+    )
+    .build()
+)
+
+# Post the DAG to Dagu
+client.post_dag(dag)
+
+# Start a run
+dag_run_id = client.start_dag_run(StartDagRun(dagName=dag.name))
+
+# Check status
+status = client.get_dag_run_status(dag_run_id.dagRunId)
+print(f"Status: {status.statusLabel}")
+```
+
+### HTTP Executor with Retry
+
+```python
+from pydagu.builder import StepBuilder
+
+step = (
+    StepBuilder("api-call")
+    .command("POST https://api.example.com/webhook")
+    .http_executor(
+        headers={
+            "Content-Type": "application/json",
+            "Authorization": "Bearer ${API_TOKEN}"
+        },
+        body={"event": "user.created", "user_id": "123"},
+        timeout=30
+    )
+    .retry(limit=3, interval=5)
+    .build()
+)
+```
+
+### Chained Steps with Dependencies
+
+```python
+from pydagu.builder import DagBuilder, StepBuilder
+
+dag = (
+    DagBuilder("data-pipeline")
+    .add_step_models(
+        StepBuilder("extract")
+        .command("python extract_data.py")
+        .output("EXTRACTED_FILE")
+        .build(),
+
+        StepBuilder("transform")
+        .command("python transform_data.py ${EXTRACTED_FILE}")
+        .depends_on("extract")
+        .output("TRANSFORMED_FILE")
+        .build(),
+
+        StepBuilder("load")
+        .command("python load_data.py ${TRANSFORMED_FILE}")
+        .depends_on("transform")
+        .build()
+    )
+    .build()
+)
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/pydagu.git
+cd pydagu
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests (requires Dagu server running)
+pytest tests/ -v
+
+# Run with coverage
+pytest tests/ --cov=pydagu --cov-report=html
+```
+
+## Documentation
+
+- [Dagu Documentation](https://dagu.readthedocs.io/)
+- [Webhook Integration Guide](examples/README.md)
+- [API Reference](https://github.com/yourusername/pydagu/wiki)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Related Projects
+
+- [Dagu](https://github.com/dagu-org/dagu) - The underlying DAG execution engine
+- [Airflow](https://airflow.apache.org/) - Alternative workflow orchestration platform

pydagu-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+pydagu/__init__.py,sha256=kfDenuf6m3o0UNuxUuETSCkRJdoQQacVRp8khYDiKpw,218
+pydagu/builder.py,sha256=_GfMrzaxHxYBKPxGaZsNwooCvqkjgK7pB_6ZZsXB6oU,16486
+pydagu/http.py,sha256=pd25yx39sjHrQnXegWFS-bf_yEdiOVKJiewlpgi-gNw,3101
+pydagu/models/__init__.py,sha256=5QMhVLCjHE_err-9cq6oIUfLpKT8zou3g8jm62Vw9LY,1388
+pydagu/models/base.py,sha256=sPZ0ysADgTDegnTiE2rgsyqezAJLbleGdyJ_dTEYOp8,339
+pydagu/models/dag.py,sha256=QvZBPif8yfzy5wn3TWnuDpqGNcCUuKMqBjKtfF1Zytw,7965
+pydagu/models/executor.py,sha256=8WZd85JXKXQEL8_dyEt8XEWs-7yip4Xn_QRsUPPnPks,5934
+pydagu/models/handlers.py,sha256=oWC4OKGpMzzqTr3lxQiA08BuodDtyLYu8SkgLMaLR4Q,945
+pydagu/models/infrastructure.py,sha256=O9QCX7PwiAwcznQUQ5YNGjbBoyY6qM_RpG6vvB9Ojh4,2147
+pydagu/models/notifications.py,sha256=F58k8FAdvIF0pQalvvk3UVypaDQ3eNUlZ7unM17f6yk,837
+pydagu/models/request.py,sha256=I8b10lN7WfY9onQaGIInGMujalqJwqSTcthrtqexCco,313
+pydagu/models/response.py,sha256=GkYDBKdMDmbd1EiQJVFoyt5UudRXYC_eMwUydSqqdpQ,1596
+pydagu/models/step.py,sha256=jeErnStYPtA_9LByJrsEoPGo6DdmZlp7iq_O0SRkkNQ,5146
+pydagu/models/types.py,sha256=7baIATh_m4FH5OcsMLcG1HKh4nVpv0hcHdoOEg6Vw90,413
+pydagu-0.1.0.dist-info/METADATA,sha256=FUWiOOguZTOBrTWtygo-K3E4MBv1_2aPdMOIlSGCiy4,5611
+pydagu-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pydagu-0.1.0.dist-info/licenses/LICENSE,sha256=TaXqim4LU9XdIufnAraWqxqVFmiyS2mwbi0K8QJszlA,1081
+pydagu-0.1.0.dist-info/RECORD,,

pydagu-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pydagu-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Patrick [Your Last Name]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.