Roland Thomas
55d581b870
- Renamed CLI subcommand from `list` to `help` for clarity and discoverability. - Added `--key` and `--tldr` support to the `help` command for detailed and example-based output. - Introduced `FalyxMode.HELP` to clearly delineate help-related behavior. - Enhanced `_render_help()` to support: - Tag filtering (`--tag`) - Per-command help (`--key`) - TLDR example rendering (`--tldr`) - Updated built-in Help command to: - Use `FalyxMode.HELP` internally - Provide fallback messages for missing help or TLDR data - Remove `LIST` alias (replaced by `help`) - Documented `FalyxCompleter`: - Improved docstrings for public methods and completions - Updated internal documentation to reflect all supported completion cases - Updated `CommandArgumentParser.render_tldr()` with fallback message for missing TLDR entries. - Updated all parser docstrings and variable names to reference `help` (not `list`) as the proper CLI entrypoint. - Added test coverage: - `tests/test_falyx/test_help.py` for CLI `help` command with `tag`, `key`, `tldr`, and fallback scenarios - `tests/test_falyx/test_run.py` for basic CLI parser integration - Bumped version to 0.1.81
49 lines
1.2 KiB
TOML
49 lines
1.2 KiB
TOML
[tool.poetry]
|
|
name = "falyx"
|
|
version = "0.1.81"
|
|
description = "Reliable and introspectable async CLI action framework."
|
|
authors = ["Roland Thomas Jr <roland@rtj.dev>"]
|
|
license = "MIT"
|
|
readme = "README.md"
|
|
packages = [{ include = "falyx" }]
|
|
|
|
[tool.poetry.dependencies]
|
|
python = ">=3.10"
|
|
prompt_toolkit = "^3.0"
|
|
rich = "^14.0"
|
|
pydantic = "^2.0"
|
|
python-json-logger = "^3.3.0"
|
|
toml = "^0.10"
|
|
pyyaml = "^6.0"
|
|
aiohttp = "^3.11"
|
|
python-dateutil = "^2.8"
|
|
|
|
[tool.poetry.group.dev.dependencies]
|
|
pytest = "^8.3.5"
|
|
pytest-asyncio = "^0.20"
|
|
ruff = "^0.3"
|
|
toml = "^0.10"
|
|
black = { version = "^25.0", allow-prereleases = true }
|
|
mypy = { version = "^1.0", allow-prereleases = true }
|
|
isort = { version = "^5.0", allow-prereleases = true }
|
|
pytest-cov = "^4.0"
|
|
mkdocs = "^1.6.1"
|
|
mkdocs-material = "^9.6.14"
|
|
mkdocstrings = {extras = ["python"], version = "^0.29.1"}
|
|
mike = "^2.1.3"
|
|
|
|
[tool.poetry.scripts]
|
|
falyx = "falyx.__main__:main"
|
|
|
|
[build-system]
|
|
requires = ["poetry-core>=1.0.0"]
|
|
build-backend = "poetry.core.masonry.api"
|
|
|
|
[tool.pytest.ini_options]
|
|
testpaths = ["tests"]
|
|
asyncio_mode = "auto"
|
|
#asyncio_default_fixture_loop_scope = "function"
|
|
|
|
[tool.pylint."MESSAGES CONTROL"]
|
|
disable = ["broad-exception-caught"]
|