taskferry 0.2.0__tar.gz

taskferry-0.2.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+
+# Build artifacts
+dist/
+build/
+*.whl
+*.tar.gz
+
+# Environments
+.venv/
+.venv-*/
+.env
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+node_modules/
+
+# uv
+uv.lock
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/
+site/

taskferry-0.2.0/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to `taskferry` are documented here.
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
+this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.2.0] — 2026-07-26
+
+The distribution formerly published as `taskferry-core`, reframed as the portable
+execution layer itself. See [ADR-0001](../../docs/adr/0001-portable-execution-layer.md)
+and the [migration guide](../../docs/migration/0.1-to-0.2.md).
+
+### Added
+
+- **A public API.** `from taskferry import Taskferry, TaskSpec, JobSpec, Execution,
+  ExecutionHandle` now works; `taskferry` is a regular package with a curated
+  `__all__`.
+- **Three execution primitives** — `InlineSpec`, `TaskSpec`, `JobSpec` — modelled
+  framework-agnostically for the first time. Tasks previously existed only inside
+  Django.
+- **`Taskferry` runtime** with `inline` / `tasks` / `jobs` facades, lazy backend
+  construction, a bounded execution index and context-manager lifecycle.
+- **`Router`** with ordered, glob-capable rules on kind, queue, profile, name and
+  labels; first match wins, and an unroutable spec names every rule it tried.
+- **`Execution`, `ExecutionState`, `ExecutionHandle`** — one portable identity and
+  one documented state machine shared by every backend of every kind.
+- **A single `Capability` enum** shared across kinds, replacing the per-domain
+  enums that could not be compared.
+- **`RetryPolicy` / `TimeoutPolicy`** with explicit `RetryOwner`, so exactly one
+  layer retries. See [ADR-0011](../../docs/adr/0011-retry-ownership.md).
+- **`FunctionRef` / `FunctionRegistry`** — the portable
+  `package.module:function` reference, with an import allowlist for untrusted
+  queues.
+- **Four built-in backends**: `InlineExecutionBackend`, `ThreadTaskBackend`,
+  `ProcessTaskBackend`, `SubprocessJobBackend`.
+- **`TaskferryConfig`** — typed, validated at construction, loadable from a
+  mapping, from `TASKFERRY_*` environment variables, or built in Python.
+- **Plugin discovery** through the `taskferry.backends` entry-point group.
+- **`taskferry.contract`** — reusable, capability-driven contract suites every
+  adapter runs.
+- **Hooks** (`before_submit`, `after_submit`, `on_success`, `on_failure`,
+  `on_retry`, ...) as composable objects, with a documented ordering guarantee.
+- **`ExternalIdIndex`** — the bounded Taskferry-id ↔ engine-id map every adapter
+  needs.
+- **A CLI**: `taskferry backends | capabilities | route | submit-task | submit-job
+  | status | cancel | result | doctor`.
+- **Architectural tests** enforcing zero dependencies three independent ways.
+
+### Changed
+
+- `taskferry-core` is absorbed into `taskferry`. `taskferry.core` remains a valid
+  import path.
+- `QUEUED → SUCCEEDED` is a legal transition: a worker that finishes before the
+  first poll is normal, not a broken adapter.
+
+### Fixed
+
+- `UnsupportedCapability` is now an alias of `UnsupportedCapabilityError` rather
+  than a subclass. As a subclass, the documented `except UnsupportedCapability`
+  missed everything raised by `CapabilitySet.require()`.
+
+### Removed
+
+- `taskferry-core` as a separate distribution. Depend on `taskferry`.

taskferry-0.2.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.

taskferry-0.2.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.5
+Name: taskferry
+Version: 0.2.0
+Summary: A portable execution layer for Python — inline, tasks and jobs on the engines you already run.
+Project-URL: Homepage, https://github.com/xiidigital/taskferry
+Project-URL: Documentation, https://taskferry.dev
+Project-URL: Source, https://github.com/xiidigital/taskferry
+Project-URL: Changelog, https://github.com/xiidigital/taskferry/blob/main/packages/taskferry/CHANGELOG.md
+Author: Taskferry authors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: capabilities,execution,jobs,portability,ports-and-adapters,taskferry,tasks
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# taskferry
+
+**A portable execution layer for Python.**
+
+Taskferry models units of work, chooses the right *kind* of execution, and routes
+them to engines that already exist. It is not a task queue, not a worker system,
+not a scheduler and not a workflow engine.
+
+```bash
+pip install taskferry
+```
+
+That installs **nothing else**. No Django, no PostgreSQL driver, no Redis client,
+no cloud SDK. The distribution declares zero dependencies and CI proves it in a
+bare virtualenv on every commit.
+
+```python
+from taskferry import Taskferry
+
+runtime = Taskferry.local()
+
+
+def add(a: int, b: int) -> int:
+    return a + b
+
+
+execution = runtime.inline.submit(add, 20, 22)
+assert execution.result().value == 42
+```
+
+## Three primitives
+
+```python
+runtime.inline.submit(add, 20, 22)  # now, in this process
+runtime.tasks.submit("myapp.tasks:send_email", 42)  # later, on an engine
+runtime.jobs.submit("build-cog", image="gdal:latest")  # a container, to completion
+```
+
+A Job is not "a Task that takes longer": it has its own image, its own resource
+envelope and its own lifecycle, and it returns an exit code rather than a Python
+value.
+
+## Built-in backends
+
+| Backend | Kind | Use |
+| --- | --- | --- |
+| `inline` | inline | tests, notebooks, CLIs, small tools |
+| `thread` | task | development, single-process applications |
+| `process` | task | rehearsing what a real worker does to your code |
+| `subprocess` | job | local batch workloads |
+
+None of them is a queue. They are not durable, not visible across processes, and
+they lose pending work on restart — which is stated plainly in their docstrings
+and in their capability sets. For production, route at a real engine; that is a
+configuration change.
+
+## Adapters
+
+Install the engine you use. Each registers itself through the `taskferry.backends`
+entry-point group, so naming it in configuration is all it takes.
+
+```bash
+pip install taskferry-procrastinate    # PostgreSQL-backed tasks
+pip install taskferry-cloudtasks       # push-based serverless tasks
+pip install taskferry-cloudrun         # serverless container jobs
+pip install taskferry-jobs             # AWS Batch, Kubernetes, Azure Container Apps
+pip install taskferry-django           # django.tasks integration
+```
+
+## CLI
+
+```bash
+taskferry backends
+taskferry capabilities pg
+taskferry route --kind job --profile gpu
+taskferry doctor
+```
+
+## Documentation
+
+Full documentation, ADRs and the migration guide live in the
+[repository](https://github.com/xiidigital/taskferry).
+
+## License
+
+Apache-2.0.

taskferry-0.2.0/README.md

@@ -0,0 +1,86 @@
+# taskferry
+
+**A portable execution layer for Python.**
+
+Taskferry models units of work, chooses the right *kind* of execution, and routes
+them to engines that already exist. It is not a task queue, not a worker system,
+not a scheduler and not a workflow engine.
+
+```bash
+pip install taskferry
+```
+
+That installs **nothing else**. No Django, no PostgreSQL driver, no Redis client,
+no cloud SDK. The distribution declares zero dependencies and CI proves it in a
+bare virtualenv on every commit.
+
+```python
+from taskferry import Taskferry
+
+runtime = Taskferry.local()
+
+
+def add(a: int, b: int) -> int:
+    return a + b
+
+
+execution = runtime.inline.submit(add, 20, 22)
+assert execution.result().value == 42
+```
+
+## Three primitives
+
+```python
+runtime.inline.submit(add, 20, 22)  # now, in this process
+runtime.tasks.submit("myapp.tasks:send_email", 42)  # later, on an engine
+runtime.jobs.submit("build-cog", image="gdal:latest")  # a container, to completion
+```
+
+A Job is not "a Task that takes longer": it has its own image, its own resource
+envelope and its own lifecycle, and it returns an exit code rather than a Python
+value.
+
+## Built-in backends
+
+| Backend | Kind | Use |
+| --- | --- | --- |
+| `inline` | inline | tests, notebooks, CLIs, small tools |
+| `thread` | task | development, single-process applications |
+| `process` | task | rehearsing what a real worker does to your code |
+| `subprocess` | job | local batch workloads |
+
+None of them is a queue. They are not durable, not visible across processes, and
+they lose pending work on restart — which is stated plainly in their docstrings
+and in their capability sets. For production, route at a real engine; that is a
+configuration change.
+
+## Adapters
+
+Install the engine you use. Each registers itself through the `taskferry.backends`
+entry-point group, so naming it in configuration is all it takes.
+
+```bash
+pip install taskferry-procrastinate    # PostgreSQL-backed tasks
+pip install taskferry-cloudtasks       # push-based serverless tasks
+pip install taskferry-cloudrun         # serverless container jobs
+pip install taskferry-jobs             # AWS Batch, Kubernetes, Azure Container Apps
+pip install taskferry-django           # django.tasks integration
+```
+
+## CLI
+
+```bash
+taskferry backends
+taskferry capabilities pg
+taskferry route --kind job --profile gpu
+taskferry doctor
+```
+
+## Documentation
+
+Full documentation, ADRs and the migration guide live in the
+[repository](https://github.com/xiidigital/taskferry).
+
+## License
+
+Apache-2.0.

taskferry-0.2.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "taskferry"
+version = "0.2.0"
+description = "A portable execution layer for Python — inline, tasks and jobs on the engines you already run."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Taskferry authors" }]
+keywords = [
+    "taskferry",
+    "execution",
+    "tasks",
+    "jobs",
+    "portability",
+    "ports-and-adapters",
+    "capabilities",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Distributed Computing",
+    "Typing :: Typed",
+]
+
+# Intentionally empty, and enforced by packages/taskferry/tests/test_architecture.py.
+# Installing taskferry must never pull in Django, Procrastinate, psycopg, Redis,
+# Celery, a cloud SDK or a Kubernetes client. Adapters are separate distributions.
+dependencies = []
+
+# No optional dependencies: the OpenTelemetry bridge now lives in its own
+# distribution, `taskferry-otel`, so `taskferry` declares nothing beyond itself.
+# The bridge code stays importable at `taskferry.core.otel` and imports
+# opentelemetry lazily, so the core carries no dependency, required or optional.
+
+[project.scripts]
+taskferry = "taskferry.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/xiidigital/taskferry"
+Documentation = "https://taskferry.dev"
+Source = "https://github.com/xiidigital/taskferry"
+Changelog = "https://github.com/xiidigital/taskferry/blob/main/packages/taskferry/CHANGELOG.md"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/taskferry"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "README.md", "CHANGELOG.md", "LICENSE"]