wool 0.1rc6__tar.gz → 0.1rc8__tar.gz

wool-0.1rc8/.gitignore

@@ -0,0 +1,22 @@
+# Ignore all files with prefix "."...
+.*
+# ...except for
+!/.github
+!/.gitignore
+!.gitkeep
+
+*.code-workspace
+*.egg-info
+*.task.json
+__pycache__
+build
+dist
+generated
+uv.lock
+
+# Generated by EditableInstallHook
+wool/src/wool/locking
+
+# Generated by protoc
+*_pb2.py*
+*_pb2_grpc.py

wool-0.1rc8/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.4
+Name: wool
+Version: 0.1rc8
+Summary: A Python framework for distributed multiprocessing.
+Author-email: Conrad Bzura <conrad@wool.io>
+Maintainer-email: maintainers@wool.io
+License:                                  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 2025 Wool Labs LLC
+        
+           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.
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Requires-Dist: annotated-types
+Requires-Dist: click
+Requires-Dist: debugpy
+Requires-Dist: grpcio
+Requires-Dist: protobuf
+Requires-Dist: shortuuid
+Requires-Dist: tblib
+Requires-Dist: typing-extensions
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-grpc-aio~=0.2.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: locking
+Requires-Dist: wool-locking==0.1rc8; extra == 'locking'
+Description-Content-Type: text/markdown
+
+# Wool
+
+Wool is a native Python package for transparently executing tasks in a horizontally scalable, distributed network of agnostic worker processes. Any picklable async function or method can be converted into a task with a simple decorator and a client connection.
+
+## Installation
+
+### Using pip
+
+To install the package using pip, run the following command:
+
+```sh
+[uv] pip install --pre wool
+```
+
+### Cloning from GitHub
+
+To install the package by cloning from GitHub, run the following commands:
+
+```sh
+git clone https://github.com/wool-labs/wool.git
+cd wool
+[uv] pip install ./wool
+```
+
+## Usage
+
+### CLI Commands
+
+Wool provides a command-line interface (CLI) for managing the worker pool.
+
+To list the available commands:
+
+```sh
+wool --help
+```
+
+#### Start the Worker Pool
+
+To start the worker pool, use the `up` command:
+
+```sh
+wool pool up --host <host> --port <port> --authkey <authkey> --breadth <breadth> --module <module>
+```
+
+- `--host`: The host address (default: `localhost`).
+- `--port`: The port number (default: `0`).
+- `--authkey`: The authentication key (default: `b""`).
+- `--breadth`: The number of worker processes (default: number of CPU cores).
+- `--module`: Python module containing Wool task definitions to be executed by this pool (optional, can be specified multiple times).
+
+#### Stop the Worker Pool
+
+To stop the worker pool, use the `down` command:
+
+```sh
+wool pool down --host <host> --port <port> --authkey <authkey> --wait
+```
+
+- `--host`: The host address (default: `localhost`).
+- `--port`: The port number (required).
+- `--authkey`: The authentication key (default: `b""`).
+- `--wait`: Wait for in-flight tasks to complete before shutting down.
+
+#### Ping the Worker Pool
+
+To ping the worker pool, use the `ping` command:
+
+```sh
+wool ping --host <host> --port <port> --authkey <authkey>
+```
+
+- `--host`: The host address (default: `localhost`).
+- `--port`: The port number (required).
+- `--authkey`: The authentication key (default: `b""`).
+
+### Sample Python Application
+
+Below is an example of how to create a Wool client connection, decorate an async function using the `task` decorator, and execute the function remotely:
+
+Module defining remote tasks:
+`tasks.py`
+```python
+import asyncio, wool
+
+# Decorate an async function using the `task` decorator
+@wool.task
+async def sample_task(x, y):
+    await asyncio.sleep(1)
+    return x + y
+```
+
+Module executing remote workflow:
+`main.py`
+```python
+import asyncio, wool
+from tasks import sample_task
+
+# Execute the decorated function in an external worker pool
+async def main():
+    with wool.PoolSession(port=5050, authkey=b"deadbeef"):
+        result = await sample_task(1, 2)
+        print(f"Result: {result}")
+
+asyncio.new_event_loop().run_until_complete(main())
+```
+
+To run the demo, first start a worker pool specifying the module defining the tasks to be executed:
+```bash
+wool pool up --port 5050 --authkey deadbeef --breadth 1 --module tasks
+```
+
+Next, in a separate terminal, execute the application defined in `main.py` and, finally, stop the worker pool:
+```bash
+python main.py
+wool pool down --port 5050 --authkey deadbeef
+```
+
+## License
+
+This project is licensed under the Apache License Version 2.0.

{wool-0.1rc6 → wool-0.1rc8}/README.md

@@ -97,7 +97,7 @@ from tasks import sample_task
 
 # Execute the decorated function in an external worker pool
 async def main():
-    with wool.WoolClient(port=5050, authkey=b"deadbeef"):
+    with wool.PoolSession(port=5050, authkey=b"deadbeef"):
         result = await sample_task(1, 2)
         print(f"Result: {result}")
 

wool-0.1rc8/pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+
+build-backend = "hatchling.build"
+requires = ["debugpy", "hatchling", "packaging", "GitPython", "toml"]
+
+[project]
+authors = [{ name = "Conrad Bzura", email = "conrad@wool.io" }]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: POSIX :: Linux",
+]
+dependencies = [
+    "annotated-types",
+    "click",
+    "debugpy",
+    "grpcio",
+    "protobuf",
+    "shortuuid",
+    "tblib",
+    "typing-extensions",
+]
+description = "A Python framework for distributed multiprocessing."
+dynamic = ["version"]
+license = { file = "../LICENSE" }
+maintainers = [{ email = "maintainers@wool.io" }]
+name = "wool"
+readme = "README.md"
+requires-python = ">=3.10"
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-asyncio", "pytest-grpc-aio~=0.2.0", "ruff"]
+locking = ["wool-locking"]
+
+[project.scripts]
+wool = "wool._cli:cli"
+
+[tool.hatch.build.hooks.protobuf]
+dependencies = ["hatch-protobuf"]
+generate_grpc = true
+generate_pyi = true
+output_path = "src/wool/_protobuf"
+proto_paths = ["protobuf"]
+
+[tool.hatch.build.targets.sdist]
+sources = ["src"]
+include = ["wool"]
+
+[tool.hatch.build.targets.wheel]
+sources = ["src"]
+include = ["wool"]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.hooks.custom]
+path = "../build-hooks/build.py"
+
+[tool.hatch.metadata.hooks.custom]
+path = "../build-hooks/metadata.py"
+
+[tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.format]
+quote-style = "double"
+docstring-code-format = true
+
+[tool.ruff.lint.isort]
+combine-as-imports = false
+force-single-line = true
+known-first-party = ["wool"]

wool-0.1rc8/wool/__init__.py

@@ -0,0 +1,76 @@
+import logging
+from contextvars import ContextVar
+from importlib.metadata import entry_points
+from typing import Final
+
+from tblib import pickling_support
+
+from wool._cli import WorkerPoolCommand
+from wool._cli import cli
+from wool._future import Future
+from wool._logging import __log_format__
+from wool._pool import WorkerPool
+from wool._pool import pool
+from wool._session import LocalSession
+from wool._session import WorkerPoolSession
+from wool._session import session
+from wool._task import Task
+from wool._task import TaskEvent
+from wool._task import TaskEventCallback
+from wool._task import TaskException
+from wool._task import current_task
+from wool._task import task
+from wool._worker import Scheduler
+from wool._worker import Worker
+
+pickling_support.install()
+
+# PUBLIC
+__log_format__: str = __log_format__
+
+# PUBLIC
+__log_level__: int = logging.INFO
+
+# PUBLIC
+__wool_session__: Final[ContextVar[WorkerPoolSession]] = ContextVar(
+    "__wool_session__", default=LocalSession()
+)
+
+__wool_worker__: Worker | None = None
+
+__all__ = [
+    "TaskException",
+    "Future",
+    "Task",
+    "TaskEvent",
+    "TaskEventCallback",
+    "WorkerPool",
+    "WorkerPoolSession",
+    "WorkerPoolCommand",
+    "Scheduler",
+    "__log_format__",
+    "__log_level__",
+    "__wool_session__",
+    "cli",
+    "current_task",
+    "pool",
+    "session",
+    "task",
+]
+
+for symbol in __all__:
+    attribute = globals().get(symbol)
+    try:
+        if attribute and "wool" in attribute.__module__.split("."):
+            # Set the module to reflect imports of the symbol
+            attribute.__module__ = __name__
+    except AttributeError:
+        continue
+
+for plugin in entry_points(group="wool_cli_plugins"):
+    try:
+        plugin.load()
+        logging.info(f"Loaded CLI plugin {plugin.name}")
+    except Exception as e:
+        logging.error(f"Failed to load CLI plugin {plugin.name}: {e}")
+        raise