pybricks-cli 1.0.0b1__tar.gz

pybricks_cli-1.0.0b1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The Pybricks Authors
+
+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.

pybricks_cli-1.0.0b1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: pybricks-cli
+Version: 1.0.0b1
+Summary: The Pybricks command line interface
+Keywords: pybricks,lego,micropython,bluetooth,robotics
+Author: The Pybricks Authors
+Author-email: The Pybricks Authors <dev@pybricks.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Typing :: Typed
+Requires-Dist: pybricks-core>=1.0.0b1
+Requires-Dist: pybricks-client>=1.0.0b1
+Requires-Dist: pybricks-service>=1.0.0b1
+Requires-Dist: anyio>=4.14
+Requires-Dist: cyclopts>=4.22
+Requires-Dist: rich>=13.7
+Requires-Dist: typing-extensions>=4.15
+Requires-Dist: watchfiles>=1.2
+Maintainer: David Lechner
+Maintainer-email: David Lechner <david@pybricks.com>
+Requires-Python: >=3.11
+Project-URL: homepage, https://pybricks.com
+Project-URL: repository, https://github.com/pybricks/pybricks-tools
+Project-URL: documentation, https://pybricks.com/pybricks-tools/cli/
+Project-URL: Changelog, https://github.com/pybricks/pybricks-tools/blob/main/packages/pb-cli/CHANGELOG.md
+Project-URL: Support, https://github.com/pybricks/support/discussions
+Project-URL: Issues, https://github.com/pybricks/support/issues
+Description-Content-Type: text/markdown
+
+# pybricks-cli
+
+The `pb` command: run Python programs on a [Pybricks](https://pybricks.com) hub
+from your computer.
+
+```bash
+uv tool install pybricks-cli
+```
+
+Then switch a hub on:
+
+```bash
+pb connect          # find a hub and connect to it
+pb run demo.py      # compile the script, send it, and run it
+```
+
+**The hub stays connected after the command finishes**, so the second `pb run`
+starts instantly, and so does the hundredth.
+
+`pb repl` talks to the hub's interpreter a line at a time, and `pb run -c` runs
+a line or two of Python without a file. `pb --help` lists the rest.
+
+> **Status:** beta. Commands and APIs may still change before 1.0.0.

pybricks_cli-1.0.0b1/README.md

@@ -0,0 +1,23 @@
+# pybricks-cli
+
+The `pb` command: run Python programs on a [Pybricks](https://pybricks.com) hub
+from your computer.
+
+```bash
+uv tool install pybricks-cli
+```
+
+Then switch a hub on:
+
+```bash
+pb connect          # find a hub and connect to it
+pb run demo.py      # compile the script, send it, and run it
+```
+
+**The hub stays connected after the command finishes**, so the second `pb run`
+starts instantly, and so does the hundredth.
+
+`pb repl` talks to the hub's interpreter a line at a time, and `pb run -c` runs
+a line or two of Python without a file. `pb --help` lists the rest.
+
+> **Status:** beta. Commands and APIs may still change before 1.0.0.

pybricks_cli-1.0.0b1/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "pybricks-cli"
+version = "1.0.0b1"
+description = "The Pybricks command line interface"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+keywords = [
+    "pybricks",
+    "lego",
+    "micropython",
+    "bluetooth",
+    "robotics",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Embedded Systems",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pybricks-core>=1.0.0b1",
+    "pybricks-client>=1.0.0b1",
+    "pybricks-service>=1.0.0b1",
+    "anyio>=4.14",
+    "cyclopts>=4.22",
+    "rich>=13.7",
+    "typing-extensions>=4.15",
+    "watchfiles>=1.2",
+]
+
+[[project.authors]]
+name = "The Pybricks Authors"
+email = "dev@pybricks.com"
+
+[[project.maintainers]]
+name = "David Lechner"
+email = "david@pybricks.com"
+
+[project.scripts]
+pb = "pb_cli.cli:main"
+
+[project.urls]
+homepage = "https://pybricks.com"
+repository = "https://github.com/pybricks/pybricks-tools"
+documentation = "https://pybricks.com/pybricks-tools/cli/"
+Changelog = "https://github.com/pybricks/pybricks-tools/blob/main/packages/pb-cli/CHANGELOG.md"
+Support = "https://github.com/pybricks/support/discussions"
+Issues = "https://github.com/pybricks/support/issues"
+
+[build-system]
+requires = ["uv_build>=0.12.7,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pb_cli"
+
+[tool.uv.sources.pybricks-core]
+workspace = true
+
+[tool.uv.sources.pybricks-client]
+workspace = true
+
+[tool.uv.sources.pybricks-service]
+workspace = true

pybricks_cli-1.0.0b1/pyproject.toml.orig

@@ -0,0 +1,54 @@
+[project]
+name = "pybricks-cli"
+version = "1.0.0b1"
+description = "The Pybricks command line interface"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "The Pybricks Authors", email = "dev@pybricks.com" }]
+maintainers = [{ name = "David Lechner", email = "david@pybricks.com" }]
+requires-python = ">=3.11"
+keywords = ["pybricks", "lego", "micropython", "bluetooth", "robotics"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Embedded Systems",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pybricks-core>=1.0.0b1",
+    "pybricks-client>=1.0.0b1",
+    "pybricks-service>=1.0.0b1",
+    "anyio>=4.14",
+    "cyclopts>=4.22",
+    "rich>=13.7",
+    "typing-extensions>=4.15",
+    "watchfiles>=1.2",
+]
+
+[project.scripts]
+pb = "pb_cli.cli:main"
+
+[project.urls]
+homepage = "https://pybricks.com"
+repository = "https://github.com/pybricks/pybricks-tools"
+documentation = "https://pybricks.com/pybricks-tools/cli/"
+"Changelog" = "https://github.com/pybricks/pybricks-tools/blob/main/packages/pb-cli/CHANGELOG.md"
+"Support" = "https://github.com/pybricks/support/discussions"
+"Issues" = "https://github.com/pybricks/support/issues"
+
+[build-system]
+requires = ["uv_build>=0.12.7,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pb_cli"
+
+[tool.uv.sources]
+pybricks-core = { workspace = true }
+pybricks-client = { workspace = true }
+pybricks-service = { workspace = true }

pybricks_cli-1.0.0b1/src/pb_cli/__init__.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2026 The Pybricks Authors
+
+"""The Pybricks command line interface."""
+
+__version__ = "1.0.0b1"
+
+__all__ = ["__version__"]

pybricks_cli-1.0.0b1/src/pb_cli/__main__.py

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2026 The Pybricks Authors
+
+from pb_cli.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pybricks_cli-1.0.0b1/src/pb_cli/app.py

@@ -0,0 +1,127 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2026 The Pybricks Authors
+
+"""The command line's shape: the app itself, its groups, and shared options.
+
+Separate from the commands so that the command modules can all import it
+without importing each other. :mod:`pb_cli.cli` pulls those modules in, which is
+what registers them.
+"""
+
+from __future__ import annotations
+
+import logging
+import sys
+from collections.abc import Sequence
+from typing import Annotated
+
+import cyclopts
+
+from pb_cli import __version__
+from pb_cli.config import config_sources
+from pb_core.logging import TRACE, setup_logging
+
+__all__ = [
+    "HUB_COMMANDS",
+    "PROGRAM_COMMANDS",
+    "SERVICE_COMMANDS",
+    "Verbose",
+    "app",
+    "configure_logging",
+    "service_app",
+]
+
+app = cyclopts.App(
+    name="pb",
+    version=__version__,
+    help=(
+        "Talk to Pybricks hubs.\n\n"
+        "A hub stays connected between commands, so you only need to run "
+        "pb connect once."
+    ),
+    # Every command is in a group of its own, so what is left in the default
+    # panel is --help and --version. Calling that panel "Commands" would be a
+    # lie, and putting it last keeps the commands at the top where someone
+    # reading the help is looking.
+    group_commands=cyclopts.Group("Options", sort_key=3),
+    config=config_sources(),
+)
+
+HUB_COMMANDS = cyclopts.Group("Hubs", sort_key=0)
+"""Finding a hub, holding on to one, and asking what it is doing.
+
+Ordered by what someone actually has to do, which is why each command carries
+an explicit ``sort_key`` rather than falling back to alphabetical. ``connect``
+comes first, because it is the one command nobody gets anywhere without, with
+its opposite ``disconnect`` beside it.
+
+The rest are things a user may want rather than steps they must take, so they
+come after: ``status`` and ``list`` report on what is already connected, and
+``scan`` comes last because nobody has to run it at all -- ``connect`` does its
+own looking, and ``connect --scan`` shows the same list when the choice
+matters.
+"""
+
+PROGRAM_COMMANDS = cyclopts.Group("Programs", sort_key=1)
+"""Getting a program onto a hub and controlling it once it is there."""
+
+SERVICE_COMMANDS = cyclopts.Group("Background service", sort_key=2)
+"""The thing holding the connections open. Rarely needed, so it comes last."""
+
+service_app = cyclopts.App(
+    name="service",
+    help="Manage the background service that keeps hubs connected.",
+    group=SERVICE_COMMANDS,
+    # Not inherited from the root app, where the default panel holds only the
+    # flags: down here it really is the list of commands.
+    group_commands=cyclopts.Group("Commands"),
+)
+app.command(service_app)
+
+
+Verbose = Annotated[
+    Sequence[bool],
+    cyclopts.Parameter(
+        name=["-v", "--verbose"],
+        help="Increase log detail. Repeat for more (-v, -vv, -vvv).",
+        show_default=False,
+        # No --no-verbose: there is nothing to turn off, and offering it
+        # would be one more thing in every command's help for no reason.
+        negative=(),
+    ),
+]
+"""How loud to be, counted rather than measured.
+
+A sequence of flags rather than a number, because that is what makes the help
+true. As an ``int`` this took a value -- ``-v 1`` worked and ``-v`` was an
+error saying it "requires an argument", while every command's help said to
+repeat it. Collecting the flags gives ``-v``, ``-v -v`` and the stacked
+``-vv``, which is what anybody typing it expects.
+"""
+
+
+def configure_logging(verbose: Verbose | int = ()) -> None:
+    """Map repeated ``-v`` flags onto log levels.
+
+    Args:
+        verbose: The flags as they were given, or how many there
+            were. Both, because the commands hand over what they
+            were passed and a count reads better everywhere else.
+    """
+    count = verbose if isinstance(verbose, int) else len(verbose)
+    if count <= 0:
+        level = logging.WARNING
+    elif count == 1:
+        level = logging.INFO
+    elif count == 2:
+        level = logging.DEBUG
+    else:
+        level = TRACE
+
+    setup_logging(
+        level=level,
+        style="rich" if sys.stderr.isatty() else "plain",
+        # bleak is noisy enough to bury our own lines, and is only interesting
+        # once someone is debugging the radio itself.
+        quiet_loggers=("bleak", "asyncio") if count < 3 else (),
+    )