Bely cli

.github/workflows/test-bely-cli.yml

@@ -0,0 +1,46 @@
+name: Test BELY CLI
+
+on:
+  pull_request:
+    paths:
+      - 'tools/developer_tools/bely-cli/**'
+      - '.github/workflows/test-bely-cli.yml'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Run BELY CLI Tests
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: tools/developer_tools/bely-cli
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+      # pyproject.toml pins bely-api to the ../python-client/packages/api directory,
+      # whose generated belyApi/ subpackage is gitignored and so absent on a fresh
+      # checkout. Resolve just that one package from PyPI instead. Job-level so
+      # `uv run` inside run_test.sh honours it too.
+      UV_NO_SOURCES_PACKAGE: bely-api
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: tools/developer_tools/bely-cli/uv.lock
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests
+        run: ./run_test.sh

.gitignore

@@ -17,17 +17,19 @@ tools/developer_tools/portal_testing/CdbFunctionalTester/nbproject/private/
 /tools/developer_tools/python-client/*
 /tools/developer_tools/python-client/**/.DS_Store
 !/tools/developer_tools/python-client/generatePyClient.sh
-!/tools/developer_tools/python-client/BelyApiFactory.py
 !/tools/developer_tools/python-client/ClientApiConfig.yml
-!/tools/developer_tools/python-client/cdbCli
-!/tools/developer_tools/python-client/setup-cli.py
-!/tools/developer_tools/python-client/setup-api.py
 !/tools/developer_tools/python-client/test
 !/tools/developer_tools/python-client/conda-recipe
+!/tools/developer_tools/python-client/conda-build.sh
 !/tools/developer_tools/python-client/data
-## Conda API build
+!/tools/developer_tools/python-client/pyproject.toml
+!/tools/developer_tools/python-client/uv.lock
+!/tools/developer_tools/python-client/README.md
+!/tools/developer_tools/python-client/packages
+/tools/developer_tools/python-client/packages/api/belyApi/
+/tools/developer_tools/python-client/packages/**/__pycache__/
+/tools/developer_tools/python-client/packages/**/dist/
 /tools/developer_tools/python-client/conda-recipe/API/build
-/tools/developer_tools/python-client/conda-recipe/API/src
 /tools/developer_tools/python-client/conda-recipe/API/bely-api-env.txt
 
 # Generated deployment specific config files 
@@ -55,7 +57,6 @@ docs/python/_build/
 /src/python/dist
 
 # Temporary testing csv files
-tools/developer_tools/python-client/cdbCli/service/cli/Spreadsheets/
 .env
 tools/developer_tools/bely-mqtt-message-broker/conda-bld
 tools/developer_tools/bely-mqtt-message-broker/dev-config

Makefile

@@ -8,12 +8,62 @@ TOP = .
 #SUBDIRS = irmis src
 SUBDIRS = src
 
+.PHONY: help
 .PHONY: support support-mysql dev-config
 .PHONY: db backup db-dev deploy-web-portal undeploy-web-portal deploy-web-service undeploy-web-service
 .PHONY: db-dev backup-dev deploy-web-portal-dev undeploy-web-portal-dev deploy-web-service-dev undeploy-web-service-dev
+.PHONY: prepare-release release-python-client
 
 default:
 
+help:
+	@echo "BELY - available make targets"
+	@echo ""
+	@echo "Setup:"
+	@echo "  support               Install support software (Java, Payara, MySQL, etc.)"
+	@echo "  support-portal        Install support software for the web portal only"
+	@echo "  support-mysql         Install MySQL and deploy mysqld"
+	@echo "  support-netbeans      Install NetBeans IDE"
+	@echo "  dev-config            Create development configuration"
+	@echo "  configuration         Create deployment configuration"
+	@echo "  prepare-dev-env       support + db + dev-config"
+	@echo ""
+	@echo "Database:"
+	@echo "  clean-db              Create a clean database with schema"
+	@echo "  test-db               Create a test database with test data"
+	@echo "  db                    Create the database (interactive)"
+	@echo "  backup                Backup the database"
+	@echo ""
+	@echo "Build & Deploy:"
+	@echo "  configure-web-portal  Configure the web portal"
+	@echo "  deploy-web-portal     Deploy the web portal"
+	@echo "  deploy-web-service    Deploy the web service"
+	@echo "  deploy-cdb-plugin     Deploy a BELY plugin"
+	@echo "  unconfigure-web-portal  Unconfigure the web portal"
+	@echo "  undeploy-web-portal   Undeploy the web portal"
+	@echo "  undeploy-web-service  Undeploy the web service"
+	@echo ""
+	@echo "Testing:"
+	@echo "  test                  Run the full test suite (backs up DB, deploys test DB,"
+	@echo "                        runs tests, restores DB)"
+	@echo "  test-plugins          Run plugin utility tests"
+	@echo ""
+	@echo "Release:"
+	@echo "  prepare-release       Bump the version across the repo and scaffold release notes"
+	@echo "  release-python-client Build and publish bely-api, bely-cli, and"
+	@echo "                        bely-mqtt-framework to PyPI"
+	@echo ""
+	@echo "Development variants:"
+	@echo "  Most Setup/Database/Build & Deploy targets above have a '-dev' counterpart"
+	@echo "  (e.g. db-dev, backup-dev, deploy-web-portal-dev) that operates against the"
+	@echo "  dev configuration/database instead of the production one."
+
+prepare-release:
+	$(TOP)/sbin/bely_prepare_release.py
+
+release-python-client:
+	$(TOP)/sbin/bely_release_pip.py
+
 prepare-dev-env: support db dev-config
 
 dev-config:

README.md

@@ -127,5 +127,17 @@ source setup.sh
 make test
 ```
 
+# Preparing a Release
+
+```sh
+source setup.sh
+make prepare-release          # bumps the version everywhere and scaffolds release notes
+# review the diff, then commit
+make release-python-client    # publishes bely-api, bely-cli, and bely-mqtt-framework to PyPI
+```
+
+See `tools/developer_tools/python-client/README.md` for the full build/publish/conda
+procedure, including TestPyPI dry runs.
+
 # License
 [Copyright (c) UChicago Argonne, LLC. All rights reserved.](https://github.com/AdvancedPhotonSource/ComponentDB/blob/master/LICENSE)