From 185e9f22878ea01de8d28dc8fe5abd652e4b833e Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Mon, 23 Mar 2026 23:22:16 +0000 Subject: [PATCH] bump cyclopts dep version add ToC to README. add Shell Completion section to README patch bump --- README.md | 25 ++++++++++++++++++++----- pyproject.toml | 4 ++-- uv.lock | 10 +++++----- 3 files changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e408578..9e4ec63 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,16 @@ --- -## Install +## Table of Contents + +- [Installation](#installation) +- [Configuration](#configuration) +- [Use](#use) +- [Shell Completion](#shell-completion) +- [License](#license) + + +## Installation #### With uv @@ -211,6 +220,14 @@ vban-cli sendtext 'Point(ASIO128.IN[1..4],ASIO128.OUT[1]).dBGain = -3.0' see `vban-cli sendtext --help` for more info. +## Shell Completion + +Shell completion scripts are available for *bash*, *zsh*, and *fish*. + +```console +vban-cli --install-completion +``` + --- ## Implementation Notes @@ -226,8 +243,6 @@ see `vban-cli sendtext --help` for more info. I've made the effort to set up the basic skeletal structure of the CLI as well as demonstrate how to combine subcommand groups with subcommand groups so more can be implemented, it just needs doing. There may be restrictions on some things however, for example, retrieving values is only possible for parameters [defined in the protocol](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L787). Setting parameters can be done for anything possible by a string request. -Shell completion scripts are available (for zsh, bash and fish) but they haven't been thoroughly tested. - If there's something missing that you would like to see added the best bet is to submit a PR. You may raise an issue and if it's quick and simple to do I may (or may not) do it. --- @@ -235,9 +250,9 @@ If there's something missing that you would like to see added the best bet is to ## License `vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. - + [ident-0]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L896 [ident-1]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L1053 -[ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995 \ No newline at end of file +[ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995 diff --git a/pyproject.toml b/pyproject.toml index 5566919..11eecf6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,11 +1,11 @@ [project] name = "vban-cli" -version = "0.12.5" +version = "0.12.6" description = "A command-line interface for Voicemeeter leveraging VBAN." readme = "README.md" license = { text = "LICENSE" } requires-python = ">=3.10" -dependencies = ["cyclopts>=4.6.0", "loguru>=0.7.3", "vban-cmd>=2.10.3"] +dependencies = ["cyclopts>=4.10.1", "loguru>=0.7.3", "vban-cmd>=2.10.3"] classifiers = [ "Development Status :: 4 - Beta", "Programming Language :: Python", diff --git a/uv.lock b/uv.lock index d86551f..1c4cb60 100644 --- a/uv.lock +++ b/uv.lock @@ -22,7 +22,7 @@ wheels = [ [[package]] name = "cyclopts" -version = "4.6.0" +version = "4.10.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "attrs" }, @@ -32,9 +32,9 @@ dependencies = [ { name = "tomli", marker = "python_full_version < '3.11'" }, { name = "typing-extensions", marker = "python_full_version < '3.11'" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/49/5c/88a4068c660a096bbe87efc5b7c190080c9e86919c36ec5f092cb08d852f/cyclopts-4.6.0.tar.gz", hash = "sha256:483c4704b953ea6da742e8de15972f405d2e748d19a848a4d61595e8e5360ee5", size = 162724, upload-time = "2026-02-23T15:44:49.286Z" } +sdist = { url = "https://files.pythonhosted.org/packages/6c/c4/2ce2ca1451487dc7d59f09334c3fa1182c46cfcf0a2d5f19f9b26d53ac74/cyclopts-4.10.1.tar.gz", hash = "sha256:ad4e4bb90576412d32276b14a76f55d43353753d16217f2c3cd5bdceba7f15a0", size = 166623, upload-time = "2026-03-23T14:43:01.098Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/8f/eb/1e8337755a70dc7d7ff10a73dc8f20e9352c9ad6c2256ed863ac95cd3539/cyclopts-4.6.0-py3-none-any.whl", hash = "sha256:0a891cb55bfd79a3cdce024db8987b33316aba11071e5258c21ac12a640ba9f2", size = 200518, upload-time = "2026-02-23T15:44:47.854Z" }, + { url = "https://files.pythonhosted.org/packages/8a/0b/2261922126b2e50c601fe22d7ff5194e0a4d50e654836260c0665e24d862/cyclopts-4.10.1-py3-none-any.whl", hash = "sha256:35f37257139380a386d9fe4475e1e7c87ca7795765ef4f31abba579fcfcb6ecd", size = 204331, upload-time = "2026-03-23T14:43:02.625Z" }, ] [[package]] @@ -189,7 +189,7 @@ wheels = [ [[package]] name = "vban-cli" -version = "0.12.5" +version = "0.12.6" source = { editable = "." } dependencies = [ { name = "cyclopts" }, @@ -199,7 +199,7 @@ dependencies = [ [package.metadata] requires-dist = [ - { name = "cyclopts", specifier = ">=4.6.0" }, + { name = "cyclopts", specifier = ">=4.10.1" }, { name = "loguru", specifier = ">=0.7.3" }, { name = "vban-cmd", editable = "../vban-cmd-python" }, ]