Metadata-Version: 2.4
Name: fx-tool
Version: 1.0.2
Summary: 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.1.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 `registers`/`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)

