feat(framework:skip) Add new flwr-dev CLI

.github/workflows/docs.yml

@@ -30,7 +30,9 @@ jobs:
       - name: Install pandoc
         run: sudo apt install pandoc
       - name: Install Flower dependencies (mandatory only)
-        run: python -m poetry install --extras "simulation"
+        run: |
+          python -m poetry install --extras "simulation"
+          python -m pip install ./dev
       - name: Install Flower Datasets
         run: |
           cd datasets

.github/workflows/framework.yml

@@ -38,7 +38,9 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies (mandatory only)
-        run: python -m poetry install --all-extras
+        run: |
+          python -m poetry install --all-extras
+          python -m pip install ./dev
       - name: Check if protos need recompilation
         run: ./dev/check-protos.sh
       - name: Lint + Test (isort/black/docformatter/mypy/pylint/flake8/pytest)

.github/workflows/pr_check.yml

@@ -22,4 +22,6 @@ jobs:
           python-version: 3.11
           poetry-skip: 'true'
       - name: Check PR title format 
-        run: python ./dev/check_pr_title.py "${{ github.event.pull_request.title }}"
+        run: |
+          python -m pip install ./dev
+          flwr-dev check-title "${{ github.event.pull_request.title }}"

dev/build-docs.sh

@@ -8,7 +8,7 @@ cd $ROOT
 ./dev/build-baseline-docs.sh
 
 cd $ROOT
-python dev/build-example-docs.py
+flwr-dev build-examples
 
 cd $ROOT
 ./datasets/dev/build-flwr-datasets-docs.sh

dev/check-protos.sh

@@ -22,7 +22,7 @@ cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
 # but did not recompile or commit the new proto python files
 
 # Recompile protos
-python -m flwr_tool.protoc
+flwr-dev compile-protos
 
 # Fail if user forgot to recompile
 CHANGED=$(git diff --name-only HEAD src/py/flwr/proto)

dev/flwr_dev/app.py

@@ -0,0 +1,50 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Flower command line interface."""
+
+import typer
+from typer.main import get_command
+
+from flwr_dev.build_docker_image_matrix import build_images
+from flwr_dev.build_example_docs import build_examples
+from flwr_dev.check_copyright import check_copyrights
+from flwr_dev.check_pr_title import check_title
+from flwr_dev.init_py_check import check_init
+from flwr_dev.init_py_fix import fix_init
+from flwr_dev.protoc import compile_protos
+from flwr_dev.update_changelog import generate_changelog
+
+cli = typer.Typer(
+    help=typer.style(
+        "flwr is the Flower command line interface.",
+        fg=typer.colors.BRIGHT_YELLOW,
+        bold=True,
+    ),
+    no_args_is_help=True,
+)
+
+cli.command()(check_title)
+cli.command()(build_examples)
+cli.command()(build_images)
+cli.command()(check_copyrights)
+cli.command()(check_init)
+cli.command()(fix_init)
+cli.command()(compile_protos)
+cli.command()(generate_changelog)
+
+typer_click_object = get_command(cli)
+
+if __name__ == "__main__":
+    cli()