fluxqueue-cli 0.1.0__py3-none-any.whl

fluxqueue_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

fluxqueue_cli/cli.py

@@ -0,0 +1,121 @@
+import re
+from typing import Annotated
+
+import typer
+
+from fluxqueue_cli.exceptions import InvalidVersionError
+from fluxqueue_cli.worker import (
+    download_and_install,
+    start_worker,
+    update_worker,
+)
+
+app = typer.Typer()
+worker_app = typer.Typer()
+
+app.add_typer(worker_app, name="worker", help="Worker related commands.")
+
+
+@app.command()
+def start(
+    *,
+    concurrency: Annotated[
+        int,
+        typer.Option(
+            "--concurrency",
+            "-c",
+            envvar="FLUXQUEUE_CONCURRENCY",
+            help="Number of tasks to run in parallel.",
+        ),
+    ] = 4,
+    redis_url: Annotated[
+        str,
+        typer.Option(
+            "--redis-url",
+            "-r",
+            envvar="FLUXQUEUE_REDIS_URL",
+            help="Redis connection URL for the worker.",
+        ),
+    ] = "redis://127.0.0.1:6379",
+    tasks_module_path: Annotated[
+        str,
+        typer.Option(
+            "--tasks-module-path",
+            "-t",
+            envvar="FLUXQUEUE_TASKS_MODULE_PATH",
+            help="Python module path where task functions are defined (e.g. src.tasks).",
+        ),
+    ],
+    queue: Annotated[
+        str,
+        typer.Option(
+            "--queue",
+            "-q",
+            envvar="FLUXQUEUE_QUEUE",
+            help="Queue name the worker reads jobs from.",
+        ),
+    ] = "default",
+    save_dead_tasks: Annotated[
+        bool,
+        typer.Option(
+            is_flag=True,
+            help="Keep failed tasks that reached the retry limit so you can inspect them later.",
+        ),
+    ] = False,
+):
+    """
+    Start a [bold]fluxqueue[/bold] worker.
+    """
+    start_worker(
+        concurrency=concurrency,
+        redis_url=redis_url,
+        tasks_module_path=tasks_module_path,
+        queue=queue,
+        save_dead_tasks=save_dead_tasks,
+    )
+
+
+@worker_app.command(name="install")
+def worker_install(
+    version: Annotated[
+        str | None,
+        typer.Option(help="Version to install. If omitted, installs the latest."),
+    ] = None,
+):
+    """
+    Download and install [bold]fluxqueue-worker[/bold].
+    """
+    if version:
+        pattern = r"^\d+\.\d+\.\d+$"
+
+        if not re.match(pattern, version):
+            raise InvalidVersionError(
+                "Invalid version. Please use versions like: 0.1.0, 0.2.3"
+            )
+
+    download_and_install(version)
+
+
+@worker_app.command(name="update")
+def worker_update(
+    version: Annotated[
+        str | None,
+        typer.Option(help="Version to update to. If omitted, updates to the latest."),
+    ] = None,
+    no_backup: Annotated[
+        bool,
+        typer.Option(
+            is_flag=True,
+            flag_value=False,
+            help="Skip keeping a backup of the old binary when updating.",
+        ),
+    ] = False,
+):
+    """
+    Update [bold]fluxqueue-worker[/bold].
+    """
+    update_worker(version=version, no_backup=no_backup)
+
+
+if __name__ == "__main__":
+    app()

fluxqueue_cli/exceptions.py

@@ -0,0 +1,18 @@
+class ReleaseNotFoundError(Exception):
+    pass
+
+
+class InvalidVersionError(Exception):
+    pass
+
+
+class AlreadyInstalledError(Exception):
+    pass
+
+
+class BinaryNotFoundError(Exception):
+    pass
+
+
+class NotInstalledError(Exception):
+    pass

fluxqueue_cli/worker.py

@@ -0,0 +1,283 @@
+import os
+import platform
+import shutil
+import subprocess
+import sys
+import tarfile
+import tempfile
+import zipfile
+from pathlib import Path
+
+import requests
+
+from fluxqueue_cli.exceptions import (
+    AlreadyInstalledError,
+    BinaryNotFoundError,
+    InvalidVersionError,
+    NotInstalledError,
+    ReleaseNotFoundError,
+)
+
+REPO = "CCXLV/fluxqueue"
+BINARY_NAME = "fluxqueue-worker"
+if platform.system() == "Windows":
+    user_profile = os.environ.get("USERPROFILE", os.path.expanduser("~"))
+    install_dir = os.path.join(user_profile, ".fluxqueue", "bin")
+    INSTALL_DIR = install_dir
+else:
+    INSTALL_DIR = "/usr/local/bin"
+
+
+def start_worker(
+    *,
+    concurrency: int,
+    redis_url: str,
+    tasks_module_path: str,
+    queue: str,
+    save_dead_tasks=False,
+):
+    # fmt: off
+    arguments = [
+        "--concurrency", str(concurrency),
+        "--redis-url", redis_url,
+        "--tasks-module-path", tasks_module_path,
+        "--queue", queue,
+    ]
+    # fmt: on
+
+    if save_dead_tasks:
+        arguments.append("--save-dead-tasks")
+
+    subprocess.run(
+        ["fluxqueue-worker", *arguments],
+        stdin=sys.stdin,
+        stdout=sys.stdout,
+        stderr=sys.stderr,
+    )
+
+
+def get_worker_version() -> str | None:
+    try:
+        result = subprocess.run(
+            ["fluxqueue-worker", "--version"],
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+        return result.stdout.replace("fluxqueue-worker", "").strip()
+    except (FileNotFoundError, subprocess.CalledProcessError):
+        return None
+
+
+def get_worker_release(version: str | None = None):
+    headers = {
+        "Accept": "application/vnd.github.v3+json",
+    }
+    api_url = f"https://api.github.com/repos/{REPO}/releases"
+    response = requests.get(api_url, headers=headers)
+    response.raise_for_status()
+
+    worker_releases = []
+    for r in response.json():
+        tag = r["tag_name"]
+        if tag.startswith("worker-v"):
+            version_str = tag[len("worker-v") :]
+            r["extracted_version"] = version_str
+            worker_releases.append(r)
+
+    if not worker_releases:
+        raise ReleaseNotFoundError("No worker releases found.")
+
+    if version:
+        for r in worker_releases:
+            if r["extracted_version"] == version:
+                return r
+        available = [r["extracted_version"] for r in worker_releases]
+        raise InvalidVersionError(
+            f"Worker version {version} not found.\n"
+            f"Available versions: {', '.join(available)}"
+        )
+    return worker_releases[0]
+
+
+def download_worker_binary(version: str | None = None):
+    release = get_worker_release(version)
+    version = release["extracted_version"]
+
+    py_version = f"{sys.version_info.major}.{sys.version_info.minor}"
+    system = platform.system().lower()
+
+    print(f"Detected: Python {py_version} on {system}")
+    print(f"Fetching latest worker: {version}")
+    asset_api_url = None
+    target_name: str | None = None
+    for asset in release["assets"]:
+        name = asset["name"]
+        if f"py{py_version}" in name and system in name:
+            asset_api_url = asset["url"]
+            target_name = str(name)
+            break
+
+    if not asset_api_url or not target_name:
+        raise BinaryNotFoundError(
+            f"No binary found for Python {py_version} on {system}."
+        )
+
+    print(f"Downloading {target_name} via API...")
+
+    headers = {
+        "Accept": "application/octet-stream",
+    }
+
+    try:
+        r = requests.get(asset_api_url, headers=headers, stream=True)
+        r.raise_for_status()
+    except:
+        delete_installed_files(target_name)
+        raise
+
+    with tempfile.NamedTemporaryFile(prefix=target_name, delete=False) as f:
+        temp_path = Path(f.name)
+        shutil.copyfileobj(r.raw, f)
+
+    return str(temp_path), target_name
+
+
+def install_worker(*, actual_file_name: str, temp_file_path: str, overwrite=False):
+    if platform.system() == "Windows":
+        dest_path = Path(INSTALL_DIR) / f"{BINARY_NAME}.exe"
+    else:
+        dest_path = Path(INSTALL_DIR) / BINARY_NAME
+    if dest_path.exists() and not overwrite:
+        raise FileExistsError(f"fluxqueue-worker is already installed at {dest_path}")
+
+    # Linux
+    if actual_file_name.endswith(".tar.gz"):
+        with tarfile.open(temp_file_path, "r:gz") as tar:
+            try:
+                tar.extractall(path=".", filter="data")
+
+                os.chmod(BINARY_NAME, 0o755)
+
+                shutil.copy2(BINARY_NAME, dest_path)
+                delete_installed_files(temp_file_path)
+            except:
+                delete_installed_files(temp_file_path)
+                raise
+    # macOS + Windows
+    elif actual_file_name.endswith(".zip"):
+        with tempfile.TemporaryDirectory() as extract_temp_dir:
+            with zipfile.ZipFile(temp_file_path, "r") as zip_file:
+                zip_file.extractall(extract_temp_dir)
+
+            exe_name = (
+                f"{BINARY_NAME}.exe" if platform.system() == "Windows" else BINARY_NAME
+            )
+            found_binary = None
+
+            for root, _dirs, files in os.walk(extract_temp_dir):
+                if exe_name in files:
+                    found_binary = Path(root) / exe_name
+                    break
+
+            if not found_binary:
+                for root, _dirs, files in os.walk(extract_temp_dir):
+                    for file in files:
+                        if BINARY_NAME in file and (
+                            platform.system() != "Windows" or file.endswith(".exe")
+                        ):
+                            found_binary = Path(root) / file
+                            break
+                    if found_binary:
+                        break
+
+            if not found_binary:
+                try:
+                    os.remove(temp_file_path)
+                except PermissionError:
+                    raise PermissionError(
+                        f"Permission denied: Could not remove temporary file {temp_file_path}. "
+                        "Please remove it manually."
+                    ) from None
+                except OSError as e:
+                    if e.errno == 13:  # Permission denied (EACCES)
+                        raise PermissionError(
+                            f"Permission denied: Could not remove temporary file {temp_file_path}. "
+                            "Please remove it manually."
+                        ) from e
+                raise BinaryNotFoundError(
+                    f"Could not find {exe_name} in the downloaded archive."
+                )
+
+            dest_path.parent.mkdir(parents=True, exist_ok=True)
+            shutil.copy2(found_binary, dest_path)
+
+            if platform.system() != "Windows":
+                os.chmod(dest_path, 0o755)
+        try:
+            os.remove(temp_file_path)
+        except PermissionError:
+            raise PermissionError(
+                f"Permission denied: Could not remove temporary file {temp_file_path}. "
+                "Please remove it manually."
+            ) from None
+        except OSError as e:
+            if e.errno == 13:  # Permission denied (EACCES)
+                raise PermissionError(
+                    f"Permission denied: Could not remove temporary file {temp_file_path}. "
+                    "Please remove it manually."
+                ) from e
+            raise
+    else:
+        delete_installed_files(temp_file_path)
+        raise NotImplementedError("Only .tar.gz installation is implemented yet.")
+
+    print(f"Successfully installed {BINARY_NAME} to {INSTALL_DIR}")
+
+
+def download_and_install(version: str | None = None):
+    if shutil.which("fluxqueue-worker"):
+        raise AlreadyInstalledError(
+            "fluxqueue-worker is already installed, use `fluxqueue worker update` command to update it."
+        )
+
+    temp_path, target_name = download_worker_binary(version)
+    install_worker(actual_file_name=target_name, temp_file_path=temp_path)
+
+
+def update_worker(*, version: str | None = None, no_backup: bool = False):
+    current_version = get_worker_version()
+
+    if not current_version:
+        raise NotInstalledError(
+            "fluxqueue-worker is not installed. Use `fluxqueue worker install` to install it."
+        )
+
+    print(f"Current Version: {current_version}")
+    if version:
+        print(f"Desired Version: {version}")
+
+    if platform.system() == "Windows":
+        dest_path = os.path.join(INSTALL_DIR, f"{BINARY_NAME}.exe")
+        backup_suffix = ".exe.backup"
+    else:
+        dest_path = os.path.join(INSTALL_DIR, BINARY_NAME)
+        backup_suffix = ".backup"
+
+    if not no_backup:
+        new_name = os.path.join(
+            INSTALL_DIR, f"{BINARY_NAME}-{current_version}{backup_suffix}"
+        )
+        os.rename(dest_path, new_name)
+
+    temp_path, target_name = download_worker_binary(version)
+    install_worker(
+        actual_file_name=target_name,
+        temp_file_path=temp_path,
+        overwrite=no_backup,
+    )
+
+
+def delete_installed_files(temp_path: str):
+    os.remove(BINARY_NAME)
+    os.remove(temp_path)

fluxqueue_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: fluxqueue-cli
+Version: 0.1.0
+Summary: A command-line tool for installing and running FluxQueue workers
+Author-Email: Giorgi Merebashvili <mereba2627@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: <3.15,>=3.11
+Requires-Dist: typer>=0.17.0
+Requires-Dist: requests>=2.29.0
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pdm; extra == "dev"
+Description-Content-Type: text/markdown
+
+## FluxQueue CLI
+
+A command-line tool for installing and running [FluxQueue](https://github.com/CCXLV/fluxqueue) workers.
+
+## Installation
+
+```bash
+pip install fluxqueue-cli
+```
+
+## Installing the Worker
+
+Use the CLI to install the worker on your system:
+
+```bash
+fluxqueue worker install
+```
+
+## Starting a Worker
+
+To start a worker, provide the path to the module where your tasks are defined and exported:
+
+```bash
+fluxqueue start --tasks-module-path src/tasks
+```
+
+## Documentation
+
+For more information and documenation about the usage please visit [FluxQueue Documentation](https://fluxqueue.ccxlv.dev).
+
+## License
+
+FluxQueue is licensed under the Apache-2.0 license. See [LICENSE](LICENSE) for details.

fluxqueue_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+fluxqueue_cli-0.1.0.dist-info/METADATA,sha256=rjPqWOjqtRUN1xrqNFnpb5uXVNav_9a1sGWDyTDIFII,1175
+fluxqueue_cli-0.1.0.dist-info/WHEEL,sha256=Wb0ASbVj8JvWHpOiIpPi7ucfIgJeCi__PzivviEAQFc,90
+fluxqueue_cli-0.1.0.dist-info/entry_points.txt,sha256=JN_hvRiIt9uWTy_80IhpsF7ZzEs6SQQAJfJTPEgBsRI,68
+fluxqueue_cli-0.1.0.dist-info/licenses/LICENSE,sha256=QPVewe_5g9Ef98z-7_5345dT15DAvECrgyH82Rp3IKI,10209
+fluxqueue_cli/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+fluxqueue_cli/cli.py,sha256=tSPqEFpz8ZQolMHUxOZl2R3Nmka0mIVLlj8DV6JtMjQ,2938
+fluxqueue_cli/exceptions.py,sha256=6U5xHlYLGOGwZ_9FWEiJhVomIhOU8hKIcvsAI_gxj1k,244
+fluxqueue_cli/worker.py,sha256=I0ufla0tACPnQcSNX-LUt2duCzkl4u0HU-aqyyjoS1g,9100
+fluxqueue_cli-0.1.0.dist-info/RECORD,,

fluxqueue_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.7)
+Root-Is-Purelib: true
+Tag: py3-none-any

fluxqueue_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+fluxqueue = fluxqueue_cli.cli:app
+
+[gui_scripts]
+

fluxqueue_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,178 @@
+Copyright 2026 Giorgi Merebashvili
+
+                                 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