diff --git a/.copier-answers.yml b/.copier-answers.yml index 04fc527..0ee806c 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,4 +1,9 @@ -# Changes here will be overwritten by Copier! -_commit: 8d13fbd +# Do not edit this file! +# It is needed to track the repo template version, and editing may break things. +# This file will be overwritten by copier on template updates. + +_commit: v1.2.2 _src_path: https://github.com/bec-project/plugin_copier_template.git +make_commit: false project_name: xtreme_bec +widget_plugins_input: [] diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml new file mode 100644 index 0000000..3e5df46 --- /dev/null +++ b/.gitea/workflows/ci.yml @@ -0,0 +1,97 @@ +name: CI for xtreme_bec +on: + push: + pull_request: + workflow_dispatch: + inputs: + BEC_WIDGETS_BRANCH: + description: "Branch of BEC Widgets to install" + required: false + type: string + default: "main" + BEC_CORE_BRANCH: + description: "Branch of BEC Core to install" + required: false + type: string + default: "main" + OPHYD_DEVICES_BRANCH: + description: "Branch of Ophyd Devices to install" + required: false + type: string + default: "main" + BEC_PLUGIN_REPO_BRANCH: + description: "Branch of the BEC Plugin Repository to install" + required: false + type: string + default: "main" + PYTHON_VERSION: + description: "Python version to use" + required: false + type: string + default: "3.11" + +permissions: + pull-requests: write + +jobs: + test: + runs-on: ubuntu-latest + env: + QTWEBENGINE_DISABLE_SANDBOX: 1 + QT_QPA_PLATFORM: "offscreen" + + steps: + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "${{ inputs.PYTHON_VERSION || '3.11' }}" + + - name: Checkout BEC Core + uses: actions/checkout@v4 + with: + repository: bec/bec + ref: "${{ inputs.BEC_CORE_BRANCH || 'main' }}" + path: ./bec + + - name: Checkout Ophyd Devices + uses: actions/checkout@v4 + with: + repository: bec/ophyd_devices + ref: "${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }}" + path: ./ophyd_devices + + - name: Checkout BEC Widgets + uses: actions/checkout@v4 + with: + repository: bec/bec_widgets + ref: "${{ inputs.BEC_WIDGETS_BRANCH || 'main' }}" + path: ./bec_widgets + + - name: Checkout BEC Plugin Repository + uses: actions/checkout@v4 + with: + repository: bec/xtreme_bec + ref: "${{ inputs.BEC_PLUGIN_REPO_BRANCH || github.head_ref || github.sha }}" + path: ./xtreme_bec + + - name: Install dependencies + shell: bash + run: | + sudo apt-get update + sudo apt-get install -y libgl1 libegl1 x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb + sudo apt-get -y install libnss3 libxdamage1 libasound2t64 libatomic1 libxcursor1 + + - name: Install Python dependencies + shell: bash + run: | + pip install uv + uv pip install --system -e ./ophyd_devices + uv pip install --system -e ./bec/bec_lib[dev] + uv pip install --system -e ./bec/bec_ipython_client + uv pip install --system -e ./bec/bec_server[dev] + uv pip install --system -e ./bec_widgets[dev,pyside6] + uv pip install --system -e ./xtreme_bec + + - name: Run Pytest with Coverage + id: coverage + run: pytest --random-order --cov=./xtreme_bec --cov-config=./xtreme_bec/pyproject.toml --cov-branch --cov-report=xml --no-cov-on-fail ./xtreme_bec/tests/ || test $? -eq 5 diff --git a/pyproject.toml b/pyproject.toml index 0928bc8..5d878ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,7 @@ dependencies = [] [project.optional-dependencies] dev = [ "black", + "copier", "isort", "coverage", "pylint", diff --git a/xtreme_bec/bec_ipython_client/startup/pre_startup.py b/xtreme_bec/bec_ipython_client/startup/pre_startup.py index 972a34a..aed18ea 100644 --- a/xtreme_bec/bec_ipython_client/startup/pre_startup.py +++ b/xtreme_bec/bec_ipython_client/startup/pre_startup.py @@ -3,8 +3,12 @@ Pre-startup script for BEC client. This script is executed before the BEC client is started. It can be used to add additional command line arguments. """ +import os + from bec_lib.service_config import ServiceConfig +import xtreme_bec + def extend_command_line_args(parser): """ @@ -16,8 +20,13 @@ def extend_command_line_args(parser): return parser -# def get_config() -> ServiceConfig: -# """ -# Create and return the service configuration. -# """ -# return ServiceConfig(redis={"host": "localhost", "port": 6379}) +def get_config() -> ServiceConfig: + """ + Create and return the ServiceConfig for the plugin repository + """ + deployment_path = os.path.dirname(os.path.dirname(os.path.dirname(xtreme_bec.__file__))) + files = os.listdir(deployment_path) + if "bec_config.yaml" in files: + return ServiceConfig(config_path=os.path.join(deployment_path, "bec_config.yaml")) + else: + return ServiceConfig(redis={"host": "localhost", "port": 6379}) diff --git a/xtreme_bec/macros/README.md b/xtreme_bec/macros/README.md new file mode 100644 index 0000000..d51fbe3 --- /dev/null +++ b/xtreme_bec/macros/README.md @@ -0,0 +1,6 @@ +# Macros + +This directory is intended to store macros which will be loaded automatically when starting BEC. +Macros are small functions to make repetitive tasks easier. Functions defined in python files in this directory will be accessible from the BEC console. +Please do not put any code outside of function definitions here. If you wish for code to be automatically run when starting BEC, see the startup script at xtreme_bec/bec_ipython_client/startup/post_startup.py +For a guide on writing macros, please see: https://bec.readthedocs.io/en/latest/user/command_line_interface.html#how-to-write-a-macro diff --git a/xtreme_bec/macros/__init__.py b/xtreme_bec/macros/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/xtreme_bec/scans/metadata_schema/__init__.py b/xtreme_bec/scans/metadata_schema/__init__.py new file mode 100644 index 0000000..e69de29