diff options
| author | Aleš Mrázek <ales.mrazek@nic.cz> | 2024-08-01 15:58:34 +0200 |
|---|---|---|
| committer | Aleš Mrázek <ales.mrazek@nic.cz> | 2024-08-26 14:28:10 +0200 |
| commit | c4d55629b618f4f45453269ab8615a1c565cd093 (patch) | |
| tree | bee4f3e292445482c0bf91cce1004ad8110ac10a /pyproject.toml | |
| parent | scripts/poe-tasks: scripts and pyproject.toml tasks names unification (diff) | |
| download | knot-resolver-c4d55629b618f4f45453269ab8615a1c565cd093.tar.xz knot-resolver-c4d55629b618f4f45453269ab8615a1c565cd093.zip | |
pyproject.toml: help for some poe tasks improved
Diffstat (limited to 'pyproject.toml')
| -rw-r--r-- | pyproject.toml | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/pyproject.toml b/pyproject.toml index 4263fc4e..c241727a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,17 +69,21 @@ kresctl = 'knot_resolver_manager.cli.main:main' knot-resolver = 'knot_resolver_manager.__main__:run' [tool.poe.tasks] -configure = { cmd = "scripts/poe-tasks/configure", help = "Configure Knot Resolver daemon" } -run = { cmd = "scripts/poe-tasks/run", help = "Run the manager" } -run-debug = { cmd = "scripts/poe-tasks/run-debug", help = "Run the manager under debugger" } -docs = { cmd = "scripts/poe-tasks/docs", help = "Create HTML documentation" } -test = { shell = "env PYTHONPATH=. pytest --junitxml=unit.junit.xml --cov=manager/knot_resolver_manager --show-capture=all tests/manager", help = "Run tests" } -check = { cmd = "scripts/poe-tasks/check", help = "Run static code analysis" } +# tasks runed through scripts located in 'scripts/poe-tasks/' +configure = { cmd = "scripts/poe-tasks/configure", help = "(Re)configure Meson build directory" } +run = { cmd = "scripts/poe-tasks/run", help = "Run Knot Resolver" } +run-debug = { cmd = "scripts/poe-tasks/run-debug", help = "Debug Knot Resolver with debugpy" } +docs = { cmd = "scripts/poe-tasks/docs", help = "Create Knot Resolver HTML documentation" } +test = { shell = "env PYTHONPATH=. pytest --junitxml=unit.junit.xml --cov=manager/knot_resolver_manager --show-capture=all tests/manager", help = "Run unit tests" } +check = { cmd = "scripts/poe-tasks/check", help = "Check that all dependencies are installed and run static code analysis" } +examples = { cmd = "scripts/poe-tasks/examples", help = "Validate all configuration examples using 'kresctl validate' utility" } +man = {cmd = "scripts/poe-tasks/man", help = "Display Knot Resolver manpage from sources" } +# tasks runned directly +gen-setuppy = { shell = "python scripts/poe-tasks/create_setup.py > setup.py", help = "Generate 'setup.py' file for backwards compatibility" } format = { shell = "black manager/knot_resolver_manager/ tests/manager scripts/create_setup.py manager/build_c_extensions.py; isort .", help = "Run code formatter" } fixdeps = { shell = "poetry install; npm install; npm update", help = "Install/update dependencies according to configuration files"} -examples = { cmd = "scripts/poe-tasks/examples", help = "Validate all configuration examples" } -kresctl = { script = "knot_resolver_manager.cli.main:main", cwd="${POE_PWD}", help="run kresctl" } -kresctl-nocwd = { script = "knot_resolver_manager.cli.main:main", help="run kresctl" } # Python <3.8 and poethepoet <0.22.0 compatibility (see also `./poe`) +kresctl = { script = "knot_resolver_manager.cli.main:main", cwd="${POE_PWD}", help="Run kresctl utility" } +kresctl-nocwd = { script = "knot_resolver_manager.cli.main:main", help="Run kresctl utility" } # Python <3.8 and poethepoet <0.22.0 compatibility (see also `./poe`) clean = """ rm -rf .coverage .mypy_cache @@ -88,8 +92,6 @@ clean = """ build dist """ -gen-setuppy = { shell = "python scripts/poe-tasks/create_setup.py > setup.py", help = "Generate setup.py file for backwards compatibility" } -man = {cmd = "scripts/poe-tasks/man", help = "Display manpage from sources" } [tool.black] line-length = 120 |