ms-flow 0.2.0__tar.gz → 0.3.0__tar.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 (165) hide show
  1. {ms_flow-0.2.0 → ms_flow-0.3.0}/PKG-INFO +30 -17
  2. ms_flow-0.3.0/README.md +64 -0
  3. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/README.md +3 -1
  4. ms_flow-0.3.0/benchmarks/refactor_optimization/bench_volumes.py +987 -0
  5. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/03-impacto.html +79 -1
  6. ms_flow-0.3.0/benchmarks/refactor_optimization/docs/08-plan-volumenes.md +495 -0
  7. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/report.py +246 -1
  8. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_2026-10-15.json +114 -0
  9. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_V1-9.json +67 -0
  10. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_V2-12.json +48 -0
  11. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_V3.json +52 -0
  12. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_V4-10.json +44 -0
  13. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_V5-8.json +69 -0
  14. ms_flow-0.3.0/benchmarks/refactor_optimization/results/volumes_baseline.json +173 -0
  15. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/workers.py +34 -0
  16. ms_flow-0.3.0/docs/api_reference.md +50 -0
  17. ms_flow-0.3.0/docs/guide.md +181 -0
  18. ms_flow-0.3.0/docs/index.md +74 -0
  19. ms_flow-0.3.0/docs/payloads.md +170 -0
  20. {ms_flow-0.2.0 → ms_flow-0.3.0}/pyproject.toml +2 -1
  21. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/_api_impl/project_runtime.py +1 -1
  22. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/base.py +1 -0
  23. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/project.py +23 -0
  24. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/project_models.py +42 -0
  25. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/project_store_ops.py +14 -0
  26. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/catalog.py +0 -5
  27. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/manager.py +2 -1
  28. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/resources.py +0 -7
  29. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/flow.py +2 -0
  30. ms_flow-0.3.0/src/ms_flow/payloads.py +936 -0
  31. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/PKG-INFO +30 -17
  32. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/SOURCES.txt +18 -2
  33. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/requires.txt +1 -0
  34. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/scm_file_list.json +18 -2
  35. ms_flow-0.3.0/src/ms_flow.egg-info/scm_version.json +8 -0
  36. ms_flow-0.3.0/tests/test_bench_volumes.py +98 -0
  37. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_engine_flow.py +1 -1
  38. ms_flow-0.3.0/tests/test_payloads.py +387 -0
  39. ms_flow-0.3.0/tests/test_payloads_codecs.py +119 -0
  40. ms_flow-0.3.0/tests/test_payloads_jobs.py +327 -0
  41. ms_flow-0.3.0/tests/test_payloads_maintenance.py +391 -0
  42. ms_flow-0.3.0/tests/test_payloads_read.py +172 -0
  43. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_project_catalog.py +3 -2
  44. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_project_manager.py +2 -6
  45. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_workspace_runtime.py +1 -1
  46. {ms_flow-0.2.0 → ms_flow-0.3.0}/zensical.toml +2 -2
  47. ms_flow-0.2.0/README.md +0 -52
  48. ms_flow-0.2.0/docs/api_guide.md +0 -191
  49. ms_flow-0.2.0/docs/api_reference.md +0 -46
  50. ms_flow-0.2.0/docs/examples.md +0 -191
  51. ms_flow-0.2.0/docs/index.md +0 -83
  52. ms_flow-0.2.0/src/ms_flow.egg-info/scm_version.json +0 -8
  53. {ms_flow-0.2.0 → ms_flow-0.3.0}/.github/workflows/docs.yml +0 -0
  54. {ms_flow-0.2.0 → ms_flow-0.3.0}/.github/workflows/publish.yml +0 -0
  55. {ms_flow-0.2.0 → ms_flow-0.3.0}/.gitignore +0 -0
  56. {ms_flow-0.2.0 → ms_flow-0.3.0}/LICENSE +0 -0
  57. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/__init__.py +0 -0
  58. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/bench.py +0 -0
  59. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/01-auditoria.md +0 -0
  60. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/02-diseno-motor.md +0 -0
  61. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/04-auditoria-tasks-jobs.md +0 -0
  62. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/05-diseno-tasks-jobs.md +0 -0
  63. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/06-diseno-ejecutor-remoto.md +0 -0
  64. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/docs/07-diseno-ms-env.md +0 -0
  65. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/baseline.json +0 -0
  66. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/batching.json +0 -0
  67. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/engine_core.json +0 -0
  68. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/feeders.json +0 -0
  69. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/forced_batch.json +0 -0
  70. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/grouped_delivery.json +0 -0
  71. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/journal.json +0 -0
  72. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/lazy_import.json +0 -0
  73. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/memory.json +0 -0
  74. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/new_engine_only.json +0 -0
  75. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/pack_target.json +0 -0
  76. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/remote_executor.json +0 -0
  77. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/resume.json +0 -0
  78. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/resume_count.json +0 -0
  79. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/retries.json +0 -0
  80. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/table_sources.json +0 -0
  81. {ms_flow-0.2.0 → ms_flow-0.3.0}/benchmarks/refactor_optimization/results/task_api.json +0 -0
  82. {ms_flow-0.2.0 → ms_flow-0.3.0}/setup.cfg +0 -0
  83. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/__init__.py +0 -0
  84. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/_api_impl/__init__.py +0 -0
  85. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/_api_impl/advanced.py +0 -0
  86. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/_api_impl/job_api.py +0 -0
  87. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/advanced.py +0 -0
  88. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/api.py +0 -0
  89. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/artifacts.py +0 -0
  90. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/__init__.py +0 -0
  91. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/app_settings.py +0 -0
  92. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/apps.py +0 -0
  93. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/configuration.py +0 -0
  94. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/__init__.py +0 -0
  95. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/backends.py +0 -0
  96. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/bridge.py +0 -0
  97. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/contracts.py +0 -0
  98. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/planner.py +0 -0
  99. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/project_output.py +0 -0
  100. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/runtime.py +0 -0
  101. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/data/shard.py +0 -0
  102. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/__init__.py +0 -0
  103. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/master.py +0 -0
  104. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/master_models.py +0 -0
  105. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/project_records.py +0 -0
  106. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/database/sqlite_utils.py +0 -0
  107. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/events.py +0 -0
  108. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/__init__.py +0 -0
  109. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/context.py +0 -0
  110. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/repository.py +0 -0
  111. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/project/state.py +0 -0
  112. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/settings/__init__.py +0 -0
  113. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/settings/defaults.toml +0 -0
  114. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/settings/manager.py +0 -0
  115. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/core/settings/models.py +0 -0
  116. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/__init__.py +0 -0
  117. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/engine.py +0 -0
  118. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/executors.py +0 -0
  119. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/files.py +0 -0
  120. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/journal.py +0 -0
  121. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/engine/tokens.py +0 -0
  122. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/logger.py +0 -0
  123. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/main.py +0 -0
  124. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/progress.py +0 -0
  125. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/query.py +0 -0
  126. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/ray_hosts.py +0 -0
  127. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/remote.py +0 -0
  128. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/runner.py +0 -0
  129. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/runtime.py +0 -0
  130. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/selection.py +0 -0
  131. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/sinks.py +0 -0
  132. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/specs/__init__.py +0 -0
  133. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/specs/input.py +0 -0
  134. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow/specs/output.py +0 -0
  135. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/dependency_links.txt +0 -0
  136. {ms_flow-0.2.0 → ms_flow-0.3.0}/src/ms_flow.egg-info/top_level.txt +0 -0
  137. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/conftest.py +0 -0
  138. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_app_registry.py +0 -0
  139. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_artifact_registry.py +0 -0
  140. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_data_api.py +0 -0
  141. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_data_backend.py +0 -0
  142. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_database_manager.py +0 -0
  143. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_database_migrations.py +0 -0
  144. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_db_pages.py +0 -0
  145. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_engine_core.py +0 -0
  146. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_engine_journal.py +0 -0
  147. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_file_sink_append.py +0 -0
  148. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_files.py +0 -0
  149. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_graph_deferred_relation.py +0 -0
  150. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_hosts_executors.py +0 -0
  151. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_logging_manager.py +0 -0
  152. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_outlives.py +0 -0
  153. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_output_helpers.py +0 -0
  154. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_project_storage.py +0 -0
  155. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_project_store.py +0 -0
  156. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_prune_missing_projects.py +0 -0
  157. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_public_api.py +0 -0
  158. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_pydantic_configuration.py +0 -0
  159. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_remote.py +0 -0
  160. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_runner.py +0 -0
  161. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_selection.py +0 -0
  162. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_settings_manager.py +0 -0
  163. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_shard_container.py +0 -0
  164. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_sink_column_defaults.py +0 -0
  165. {ms_flow-0.2.0 → ms_flow-0.3.0}/tests/test_sql_compiler.py +0 -0
@@ -1,11 +1,11 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ms_flow
3
- Version: 0.2.0
3
+ Version: 0.3.0
4
4
  Summary: In-process, desktop-first, domain-agnostic job/task/executor orchestrator for massive data flows.
5
5
  Author: Mario S. Valdés-Tresanco, Mario E. Valdés-Tresanco, Ernesto Moreno, Pedro A. Valiente
6
6
  License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/MolSuite/ms_flow
8
- Project-URL: Documentation, https://github.com/MolSuite/ms_flow/tree/main/docs
8
+ Project-URL: Documentation, https://molsuite.github.io/ms_flow/
9
9
  Project-URL: Issues, https://github.com/MolSuite/ms_flow/issues
10
10
  Keywords: orchestration,executor,jobs,pipeline,scientific-computing
11
11
  Classifier: Development Status :: 4 - Beta
@@ -24,6 +24,7 @@ Requires-Dist: pydantic>=2.0
24
24
  Requires-Dist: sqlalchemy>=2.0
25
25
  Requires-Dist: sqlmodel>=0.0.14
26
26
  Requires-Dist: toml>=0.10
27
+ Requires-Dist: zstandard>=0.22
27
28
  Provides-Extra: dev
28
29
  Requires-Dist: pytest>=7.0; extra == "dev"
29
30
  Provides-Extra: ray
@@ -36,10 +37,19 @@ In-process, desktop-first, domain-agnostic orchestrator for massive data flows:
36
37
  jobs, executors and persistence in the same process as your app — no broker, no
37
38
  daemon, no server. Works from a Qt app, a notebook or a plain script.
38
39
 
40
+ `workers.py` (tasks and jobs live in a module the workers can import):
41
+
39
42
  ```python
40
- import sqlite3
43
+ from sqlmodel import Field, SQLModel
44
+
45
+ from ms_flow import job, table_sink, task
41
46
 
42
- from ms_flow import Workspace, job, table_sink, task
47
+
48
+ class Result(SQLModel, table=True): # the project creates this table when it opens
49
+ __tablename__ = "results"
50
+ id: int | None = Field(default=None, primary_key=True)
51
+ value: int
52
+ double_value: int
43
53
 
44
54
 
45
55
  @task()
@@ -50,15 +60,21 @@ def double_value(value: int) -> dict:
50
60
  @job(task=double_value, output=table_sink("results", columns=("value", "double_value")))
51
61
  def double_values(params, project):
52
62
  yield from range(1000)
63
+ ```
53
64
 
65
+ `run.py`:
54
66
 
55
- ms = Workspace(app_id="demo")
56
- ms.create_or_open_project(name="demo", folder="./demo_project", activate=True)
57
- with sqlite3.connect(ms.project_db.db_path) as db:
58
- db.execute("CREATE TABLE IF NOT EXISTS results (value INTEGER, double_value INTEGER)")
67
+ ```python
68
+ from ms_flow import Workspace
69
+ from workers import Result, double_values
59
70
 
60
- print(ms.engine.wait(ms.submit(double_values)).status)
61
- ms.shutdown()
71
+ ms = Workspace(app_id="demo")
72
+ try:
73
+ ms.create_or_open_project(name="demo", folder="./demo_project", activate=True)
74
+ print(ms.engine.wait(ms.submit(double_values)).status) # completed
75
+ print(ms.project_db.count(Result)) # 1000
76
+ finally:
77
+ ms.shutdown()
62
78
  ```
63
79
 
64
80
  ## Install
@@ -67,17 +83,14 @@ ms.shutdown()
67
83
  pip install ms_flow # engine + projects: SQLite and loky
68
84
  ```
69
85
 
70
- ## Where to look
86
+ ## Documentation
71
87
 
72
- - [5-minute quickstart](docs/guides/quickstart_5min.md) — first working job.
73
- - [Runnable examples](examples/README.md) — scripts y notebook.
74
- - [Public API](docs/guides/public_api.md) — API.
75
- - [Docs index](docs/README.md) — guides, contracts, operation
76
- - [Benchmarks](benchmarks/README.md) — performance.
88
+ <https://molsuite.github.io/ms_flow/>: a guide to tasks, jobs, sinks, following and
89
+ continuing jobs and where they run, and the API reference.
77
90
 
78
91
  ## Status
79
92
 
80
- Beta. The public API (`ms_flow.api`) is the stable surface; `ms_flow.core.*` may change without notice.
93
+ Beta. The public API (`ms_flow`, `ms_flow.api`, `ms_flow.engine`) is the stable surface; `ms_flow.core.*` may change without notice.
81
94
 
82
95
  ## License
83
96
 
@@ -0,0 +1,64 @@
1
+ # ms_flow
2
+
3
+ In-process, desktop-first, domain-agnostic orchestrator for massive data flows:
4
+ jobs, executors and persistence in the same process as your app — no broker, no
5
+ daemon, no server. Works from a Qt app, a notebook or a plain script.
6
+
7
+ `workers.py` (tasks and jobs live in a module the workers can import):
8
+
9
+ ```python
10
+ from sqlmodel import Field, SQLModel
11
+
12
+ from ms_flow import job, table_sink, task
13
+
14
+
15
+ class Result(SQLModel, table=True): # the project creates this table when it opens
16
+ __tablename__ = "results"
17
+ id: int | None = Field(default=None, primary_key=True)
18
+ value: int
19
+ double_value: int
20
+
21
+
22
+ @task()
23
+ def double_value(value: int) -> dict:
24
+ return {"value": value, "double_value": 2 * value}
25
+
26
+
27
+ @job(task=double_value, output=table_sink("results", columns=("value", "double_value")))
28
+ def double_values(params, project):
29
+ yield from range(1000)
30
+ ```
31
+
32
+ `run.py`:
33
+
34
+ ```python
35
+ from ms_flow import Workspace
36
+ from workers import Result, double_values
37
+
38
+ ms = Workspace(app_id="demo")
39
+ try:
40
+ ms.create_or_open_project(name="demo", folder="./demo_project", activate=True)
41
+ print(ms.engine.wait(ms.submit(double_values)).status) # completed
42
+ print(ms.project_db.count(Result)) # 1000
43
+ finally:
44
+ ms.shutdown()
45
+ ```
46
+
47
+ ## Install
48
+
49
+ ```bash
50
+ pip install ms_flow # engine + projects: SQLite and loky
51
+ ```
52
+
53
+ ## Documentation
54
+
55
+ <https://molsuite.github.io/ms_flow/>: a guide to tasks, jobs, sinks, following and
56
+ continuing jobs and where they run, and the API reference.
57
+
58
+ ## Status
59
+
60
+ Beta. The public API (`ms_flow`, `ms_flow.api`, `ms_flow.engine`) is the stable surface; `ms_flow.core.*` may change without notice.
61
+
62
+ ## License
63
+
64
+ MIT — see [LICENSE](LICENSE).
@@ -10,8 +10,10 @@ Refactor del motor de ms_flow: el banco de pruebas, lo que midió cada paso y lo
10
10
  | [docs/04-auditoria-tasks-jobs.md](docs/04-auditoria-tasks-jobs.md) | Auditoría del diseño de tasks y jobs contra el uso real en AMDockVS |
11
11
  | [docs/05-diseno-tasks-jobs.md](docs/05-diseno-tasks-jobs.md) | Diseño de tasks y jobs sobre el motor nuevo, estado de cada pieza y restos del motor viejo |
12
12
  | [docs/06-diseno-ejecutor-remoto.md](docs/06-diseno-ejecutor-remoto.md) | Propuesta del ejecutor remoto: Ray dentro del job del HPC, runner de `ms_flow` y decisiones abiertas |
13
+ | [docs/08-plan-volumenes.md](docs/08-plan-volumenes.md) | Plan de los volúmenes para payloads por entidad: invariantes, fallos y recuperación, hitos V0-V7 (`ms_flow`) y A0-A8 (AMDockVS) con sus tareas |
13
14
  | `bench.py` | Mide el coste de orquestación y las comprobaciones de robustez; escribe `results/<paso>.json` |
14
- | `report.py` | Lee `results/*.json` y escribe el informe |
15
+ | `bench_volumes.py` | Banco de los volúmenes (plan 08): compara SQLite con blobs y volúmenes en disco (modo serie y paralelo, lecturas en caliente y en frío); escribe `results/volumes_<etiqueta>.json` |
16
+ | `report.py` | Lee `results/*.json` y escribe el informe; los `volumes_*.json` van a su sección «Volumes» |
15
17
  | `workers.py` | Funciones de chunk del banco de pruebas |
16
18
 
17
19
  ## Un cambio, una rama, un PR