dagflows 0.1.0__tar.gz

dagflows-0.1.0/.gitattributes

@@ -0,0 +1,10 @@
+*.py text eol=lf
+*.pyi text eol=lf
+py.typed text eol=lf
+*.toml text eol=lf
+*.cfg text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.txt text eol=lf
+.gitattributes text eol=lf
+.gitignore text eol=lf

dagflows-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editors and OS
+.vscode/
+.idea/
+*.swp
+.DS_Store
+Thumbs.db
+
+# Local fixtures for DAGFLOWS_INPUT=./fixture.json runs
+fixture*.json
+
+internal_refs/

dagflows-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dagflows-0.1.0/PKG-INFO

@@ -0,0 +1,282 @@
+Metadata-Version: 2.5
+Name: dagflows
+Version: 0.1.0
+Summary: SDK for authoring and running Dagflows workflow nodes
+Project-URL: Homepage, https://github.com/dagflows/sdk-python
+Project-URL: Repository, https://github.com/dagflows/sdk-python
+Project-URL: Issues, https://github.com/dagflows/sdk-python/issues
+Author: dagflows
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: dag,orchestration,workflow
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: httpx
+Requires-Dist: httpx>=0.27; extra == 'httpx'
+Description-Content-Type: text/markdown
+
+# dagflows
+
+Python SDK for authoring and running Dagflows workflows.
+
+## Installation
+
+```bash
+pip install dagflows
+```
+
+Requires Python 3.11+.
+
+To enable the optional async HTTP client backend:
+
+```bash
+pip install dagflows[httpx]
+```
+
+## Quickstart
+
+Define a workflow and its node functions in a module:
+
+```python
+# app/workflow.py
+from dagflows import Workflow
+
+wf = Workflow("order_pipeline", max_concurrent_nodes=4)
+
+
+@wf.node()
+def fetch_orders(ctx, inputs):
+    return {"orders": [{"id": 1, "amount": 100}, {"id": 2, "amount": 250}]}
+
+
+@wf.node(depends=[fetch_orders])
+def calculate_totals(ctx, inputs):
+    orders = inputs["fetch_orders"].value()["orders"]
+    total = sum(order["amount"] for order in orders)
+    return {"total": total}
+```
+
+### Handler Signatures
+
+Node functions can be synchronous or asynchronous, and may take fewer
+arguments than are offered. Arguments are passed **positionally**, so the first
+parameter is always `ctx` whatever you name it:
+
+```python
+# Full signature
+@wf.node()
+def step_a(ctx, inputs):
+    ...
+
+# Context only: one parameter receives ctx, never inputs
+@wf.node()
+def step_c(ctx):
+    ...
+
+# No arguments
+@wf.node()
+def step_d():
+    return {"status": "ready"}
+
+# Async handler
+@wf.node(depends=[step_a])
+async def step_async(ctx, inputs):
+    async for item in inputs["step_a"]:
+        ...
+    return {"done": True}
+```
+
+To reach inputs, declare both parameters. `def step(inputs)` receives `ctx`
+under the name `inputs`, which fails later and confusingly.
+
+## Node Configuration
+
+### Resource Limits and Retries
+
+Configure execution limits and retry policies on `@wf.node()`:
+
+```python
+from dagflows import ExecutionConfig, RetryConfig, Workflow
+
+wf = Workflow("data_pipeline")
+
+
+@wf.node(
+    execution=ExecutionConfig(timeout=300, memory_limit_mb=512),
+    retry=RetryConfig(max_attempts=3, initial_backoff_ms=1000),
+)
+def extract_data(ctx, inputs):
+    ...
+```
+
+### Cross-Project Dependencies
+
+To depend on a node from another project or workflow, use `wf.external_node`:
+
+```python
+@wf.node(depends=[fetch_orders, wf.external_node("inventory_check")])
+def fulfill_order(ctx, inputs):
+    ...
+```
+
+## Standalone Node Scripts (Optional)
+
+In addition to defining nodes within a workflow module, you can also write standalone script files using `dagflows.run`:
+
+```python
+# app/nodes/custom_task.py
+import dagflows
+
+
+def handler(ctx, inputs):
+    data = inputs.one().value()
+    return {"processed": True, "count": len(data)}
+
+
+if __name__ == "__main__":
+    dagflows.run(handler)
+```
+
+## Working with Inputs
+
+Inputs are accessed through input handles:
+
+```python
+upstream = inputs["fetch_orders"]
+
+# Retrieve complete value, refused if it exceeds the node's memory limit
+data = upstream.value()
+
+# Iterate without holding it all (sync and async iteration both work)
+for record in upstream:
+    process_record(record)
+
+# Raw chunks for opaque content: a generator, not a bytes object
+for chunk in upstream.bytes():
+    sink.write(chunk)
+```
+
+Iteration yields one **record** at a time for row oriented payloads, which is
+what lets a node read more than it can hold. A JSON input has no records, so it
+yields the whole document as a single item.
+
+| content type | `for x in handle` yields |
+| --- | --- |
+| `application/x-ndjson`, `text/csv` | one row at a time |
+| `application/json` | the whole document, once |
+
+Iteration re-opens the source each pass, so looping twice costs a second read
+rather than silently yielding nothing the second time.
+
+If a node has exactly one parent dependency, use `inputs.one()`:
+
+```python
+single_input = inputs.one().value()
+```
+
+## Producing Outputs
+
+Return a Python dictionary/value directly, or use `Result` for explicit routing and formatting:
+
+```python
+from dagflows import ContentType, Result
+
+# Direct value return
+return {"count": 42}
+
+# Route downstream execution to a specific branch
+return Result(output={"status": "approved"}, next="process_payment")
+
+# Halt execution of this branch
+return Result(output={}, stop=True)
+
+# Explicit content type specification
+return Result(output=stream_generator(), content_type=ContentType.NDJSON)
+```
+
+## Error Handling
+
+Raise `Fail` to signal structured execution errors with retry instructions:
+
+```python
+from dagflows import EXECUTION, Fail
+
+raise Fail("Payment gateway unavailable", category=EXECUTION, retry_after=30)
+```
+
+Available error categories:
+- `EXECUTION`
+- `INFRASTRUCTURE`
+- `TIMEOUT`
+- `PERMANENT`
+
+## Command Line Interface
+
+The SDK provides CLI commands invoked via `python -m dagflows`:
+
+### Manifest Management
+
+```bash
+# Generate manifest file
+python -m dagflows build manifest app.workflow -o dagflows-manifest.json
+
+# Check if an existing manifest is up to date
+python -m dagflows build manifest app.workflow --check
+
+# Validate workflow definition without writing output
+python -m dagflows build validate app.workflow
+```
+
+### Local Development & Testing
+
+`dev run` executes a node with no VM, no platform and no network. It takes a
+**script path**, so it applies to standalone node scripts:
+
+```bash
+python -m dagflows dev run app/nodes/custom_task.py --input fetch_orders=orders.json
+```
+
+`dev fixture` writes a starting input envelope, so nobody has to invent one. It
+takes either form:
+
+```bash
+# a standalone script
+python -m dagflows dev fixture app/nodes/custom_task.py -o fixture.json
+
+# a node declared with @wf.node
+python -m dagflows dev fixture app.workflow:calculate_totals --input fetch_orders=orders.json -o m.json
+```
+
+It prints the command that runs the node against what it wrote, which for a
+decorated node goes through the interpreter because a `module:function`
+entrypoint is not a file:
+
+```bash
+DAGFLOWS_INPUT=m.json DAGFLOWS_OUTPUT=out.json python -m dagflows invoke --node calculate_totals
+```
+
+That is the local loop for decorator-defined nodes, since `dev run` needs a
+file to execute.
+
+`dev run` accepts several options worth knowing:
+
+```bash
+--input users=rows.ndjson     a file, content type inferred from the suffix
+--input users='{"n": 1}'      inline json
+--memory-limit-mb 512         what the node believes it has
+--inline-max-bytes 262144     when an output would offload
+--keep-fixture <path>         write the envelope instead of discarding it
+```
+
+All CLI commands support `--json` for machine-readable output. Exit codes are
+`0` success, `1` the operation failed, `2` the command was wrong.
+
+## License
+
+Apache-2.0