fx-tool 1.0.0__tar.gz

fx_tool-1.0.0/LICENSE

@@ -0,0 +1,6 @@
+## LICENSE
+Copyright (c) [2026] Charles DeFreese
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

fx_tool-1.0.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: fx-tool
+Version: 1.0.0
+Summary: Functionals FX project and DevOps operations CLI.
+Author: Charles DeFreese
+License: MIT
+Project-URL: Homepage, https://github.com/nexustech101/fx
+Project-URL: Repository, https://github.com/nexustech101/fx
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: registers>=6.0.0
+Requires-Dist: tqdm<5,>=4.66
+Provides-Extra: dev
+Requires-Dist: pytest<8,>=7.4; extra == "dev"
+Requires-Dist: pytest-cov<5,>=4.1; extra == "dev"
+Requires-Dist: pytest-asyncio<1,>=0.23; extra == "dev"
+Dynamic: license-file
+
+# fx-tool
+
+`fx` is the standalone project manager and operations CLI for the
+Functionals framework.
+
+It is focused on developer and DevOps workflows around Functionals apps:
+
+- project scaffolding (`cli` and `db` project types)
+- module and plugin structure management
+- runtime operations (`run`, `install`, `update`, `pull`)
+- cron workspace, workflow registration, and runtime control
+- local control-plane state and operational history
+
+`fx-tool` is intentionally separate from the core framework package now, but it
+still manages projects built on the Functionals runtime (`registers`).
+
+Runtime package note: the framework package/import namespace is now `registers`
+(renamed from `decorates`/`registers`).
+
+## Install
+
+```bash
+pip install fx-tool
+```
+
+`fx-tool` depends on [`registers`](https://pypi.org/project/registers/) for the
+framework runtime modules (`registers.cli`, `registers.db`,
+`registers.cron`).
+
+## Run
+
+```bash
+fx --version
+fx --help
+fx --interactive
+python -m fx --help
+```
+
+## Quick Example
+
+```bash
+# Initialize a Functionals project
+fx init cli MyService
+
+# Validate project structure and plugin wiring
+fx status MyService
+fx health MyService
+
+# Operate cron workflows
+fx cron workspace MyService
+fx cron jobs MyService
+fx cron start MyService
+```
+
+## Documentation
+
+- Usage guide: [`src/fx/USAGE.md`](C:/Users/charl/Documents/Python/framework/fx/src/fx/USAGE.md)
+

fx_tool-1.0.0/README.md

@@ -0,0 +1,58 @@
+# fx-tool
+
+`fx` is the standalone project manager and operations CLI for the
+Functionals framework.
+
+It is focused on developer and DevOps workflows around Functionals apps:
+
+- project scaffolding (`cli` and `db` project types)
+- module and plugin structure management
+- runtime operations (`run`, `install`, `update`, `pull`)
+- cron workspace, workflow registration, and runtime control
+- local control-plane state and operational history
+
+`fx-tool` is intentionally separate from the core framework package now, but it
+still manages projects built on the Functionals runtime (`registers`).
+
+Runtime package note: the framework package/import namespace is now `registers`
+(renamed from `decorates`/`registers`).
+
+## Install
+
+```bash
+pip install fx-tool
+```
+
+`fx-tool` depends on [`registers`](https://pypi.org/project/registers/) for the
+framework runtime modules (`registers.cli`, `registers.db`,
+`registers.cron`).
+
+## Run
+
+```bash
+fx --version
+fx --help
+fx --interactive
+python -m fx --help
+```
+
+## Quick Example
+
+```bash
+# Initialize a Functionals project
+fx init cli MyService
+
+# Validate project structure and plugin wiring
+fx status MyService
+fx health MyService
+
+# Operate cron workflows
+fx cron workspace MyService
+fx cron jobs MyService
+fx cron start MyService
+```
+
+## Documentation
+
+- Usage guide: [`src/fx/USAGE.md`](C:/Users/charl/Documents/Python/framework/fx/src/fx/USAGE.md)
+

fx_tool-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fx-tool"
+version = "1.0.0"
+description = "Functionals FX project and DevOps operations CLI."
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Charles DeFreese" }
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+]
+
+dependencies = [
+    "registers>=6.0.0",
+    "tqdm>=4.66,<5",
+]
+
+[project.scripts]
+fx = "fx.commands:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4,<8",
+    "pytest-cov>=4.1,<5",
+    "pytest-asyncio>=0.23,<1",
+]
+
+[project.urls]
+Homepage = "https://github.com/nexustech101/fx"
+Repository = "https://github.com/nexustech101/fx"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+asyncio_mode = "auto"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["fx*"]
+namespaces = true
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+

fx_tool-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fx_tool-1.0.0/src/fx/__init__.py

@@ -0,0 +1,10 @@
+"""
+FX: project structuring and management tooling built on the
+registers CLI + DB framework.
+"""
+
+from fx.commands import FX_VERSION, get_registry, main, run
+
+__version__ = FX_VERSION
+
+__all__ = ["run", "main", "get_registry", "__version__"]

fx_tool-1.0.0/src/fx/__main__.py

@@ -0,0 +1,4 @@
+from fx.commands import main
+
+if __name__ == "__main__":
+    main()

fx_tool-1.0.0/src/fx/commands.py

@@ -0,0 +1,177 @@
+"""
+Public FX command surface.
+
+This module owns the FX command registry and runtime entrypoints. Command
+implementations are split into plugin modules under ``fx.plugins``.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from importlib.metadata import PackageNotFoundError, version as resolve_distribution_version
+from threading import Lock
+from typing import Any
+
+from registers.cli.plugins import load_plugins
+from registers.cli.registry import CommandRegistry
+
+try:
+    from registers.cli.registry import MISSING  # type: ignore[attr-defined]
+except ImportError:
+    # Older/incompatible runtime builds may not export MISSING.
+    MISSING = object()
+
+_registry = CommandRegistry()
+_FX_DISTRIBUTION_NAME = "fx-tool"
+_PLUGINS_PACKAGE = "fx.plugins"
+_REQUIRED_COMMANDS = frozenset(
+    {
+        "init",
+        "status",
+        "module",
+        "plugin",
+        "version",
+        "cron",
+        "run",
+        "install",
+        "update",
+        "pull",
+        "health",
+        "history",
+    }
+)
+_plugins_lock = Lock()
+_plugins_loaded = False
+_plugin_load_error: Exception | None = None
+
+
+def _resolve_fx_version() -> str:
+    try:
+        return resolve_distribution_version(_FX_DISTRIBUTION_NAME)
+    except PackageNotFoundError:
+        return "dev"
+
+
+FX_VERSION = _resolve_fx_version()
+
+
+def argument(
+    name: str,
+    *,
+    type: Any = str,
+    help: str = "",
+    default: Any = MISSING,
+):
+    def decorator(fn):
+        if not hasattr(_registry, "stage_argument"):
+            raise RuntimeError(
+                "Incompatible 'registers' runtime: CommandRegistry.stage_argument is required."
+            )
+        _registry.stage_argument(fn, name, arg_type=type, help_text=help, default=default)
+        return fn
+
+    return decorator
+
+
+def option(flag: str, *, help: str = ""):
+    def decorator(fn):
+        if not hasattr(_registry, "stage_option"):
+            raise RuntimeError(
+                "Incompatible 'registers' runtime: CommandRegistry.stage_option is required."
+            )
+        _registry.stage_option(fn, flag, help_text=help)
+        return fn
+
+    return decorator
+
+
+def register(name: str | None = None, *, description: str = "", help: str = ""):
+    def decorator(fn):
+        if not hasattr(_registry, "finalize_command"):
+            raise RuntimeError(
+                "Incompatible 'registers' runtime: CommandRegistry.finalize_command is required."
+            )
+        _registry.finalize_command(fn, name=name, description=description, help_text=help)
+        return fn
+
+    return decorator
+
+
+def ensure_plugins_loaded() -> None:
+    global _plugins_loaded, _plugin_load_error
+
+    if _plugins_loaded:
+        return
+    if _plugin_load_error is not None:
+        raise RuntimeError("FX command plugins failed to load.") from _plugin_load_error
+
+    with _plugins_lock:
+        if _plugins_loaded:
+            return
+        if _plugin_load_error is not None:
+            raise RuntimeError("FX command plugins failed to load.") from _plugin_load_error
+
+        try:
+            load_plugins(_PLUGINS_PACKAGE, _registry)
+            missing = sorted(name for name in _REQUIRED_COMMANDS if not _registry.has(name))
+            if missing:
+                raise RuntimeError(
+                    "FX command plugins loaded incompletely. Missing commands: "
+                    + ", ".join(missing)
+                )
+            _plugins_loaded = True
+        except Exception as exc:
+            _plugin_load_error = exc
+            raise
+
+
+def run(
+    argv: Sequence[str] | None = None,
+    *,
+    print_result: bool = True,
+    shell_prompt: str = "fx > ",
+    shell_input_fn=None,
+    shell_banner: bool = True,
+    shell_banner_text: str | None = None,
+    shell_title: str = "Functionals FX",
+    shell_description: str = "Manage Functionals projects, modules, and plugin structures.",
+    shell_colors: bool | None = None,
+    shell_usage: bool = True,
+) -> Any:
+    ensure_plugins_loaded()
+    return _registry.run(
+        argv,
+        print_result=print_result,
+        shell_prompt=shell_prompt,
+        shell_input_fn=shell_input_fn,
+        shell_banner=shell_banner,
+        shell_banner_text=shell_banner_text,
+        shell_title=shell_title,
+        shell_description=shell_description,
+        shell_version=f"Version: {FX_VERSION}",
+        shell_colors=shell_colors,
+        shell_usage=shell_usage,
+    )
+
+
+def get_registry() -> CommandRegistry:
+    ensure_plugins_loaded()
+    return _registry
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    run(argv)
+    return 0
+
+
+__all__ = [
+    "FX_VERSION",
+    "argument",
+    "option",
+    "register",
+    "ensure_plugins_loaded",
+    "run",
+    "get_registry",
+    "main",
+]
+

fx_tool-1.0.0/src/fx/plugin_sync.py

@@ -0,0 +1,72 @@
+"""
+Plugin pull/sync helpers for ``fx``.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+import shutil
+
+from fx.structure import normalize_identifier
+
+
+@dataclass(frozen=True)
+class SyncReport:
+    created: tuple[str, ...] = ()
+    updated: tuple[str, ...] = ()
+    skipped: tuple[str, ...] = ()
+
+    @property
+    def synced_aliases(self) -> tuple[str, ...]:
+        return tuple(dict.fromkeys([*self.created, *self.updated]))
+
+
+def sync_plugins_from_checkout(
+    *,
+    checkout_root: Path,
+    subdir: str,
+    target_plugins_dir: Path,
+    force: bool = False,
+) -> SyncReport:
+    source_dir = (checkout_root / subdir).resolve()
+    if not source_dir.exists() or not source_dir.is_dir():
+        raise FileNotFoundError(
+            f"Plugin source directory '{subdir}' not found in checkout."
+        )
+
+    created: list[str] = []
+    updated: list[str] = []
+    skipped: list[str] = []
+
+    target_plugins_dir.mkdir(parents=True, exist_ok=True)
+
+    for candidate in sorted(source_dir.iterdir()):
+        if not candidate.is_dir():
+            continue
+        if not (candidate / "__init__.py").exists():
+            continue
+
+        alias = normalize_identifier(candidate.name)
+        target = target_plugins_dir / alias
+        existed = target.exists()
+
+        if existed and not force:
+            skipped.append(alias)
+            continue
+
+        if existed and force:
+            shutil.rmtree(target)
+            updated.append(alias)
+        else:
+            created.append(alias)
+
+        shutil.copytree(candidate, target)
+
+    return SyncReport(
+        created=tuple(created),
+        updated=tuple(updated),
+        skipped=tuple(skipped),
+    )
+
+

fx_tool-1.0.0/src/fx/plugins/__init__.py

@@ -0,0 +1,7 @@
+"""
+FX command plugins.
+
+Modules in this package are auto-imported by ``fx.commands`` to register
+commands against the shared FX command registry.
+"""
+