PyDMConverter 0.0.0__tar.gz

pydmconverter-0.0.0/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,71 @@
+name: Bug report
+description: Report an issue or bug with the project.
+title: "[BUG] - "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Please provide a clear and concise description of the bug.**
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: The bug occurs when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: I expected...
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps_to_reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the bug.
+      placeholder: |
+        1. Go to...
+        2. Click on...
+        3. Scroll down to...
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: possible_solution
+    attributes:
+      label: Possible solution (optional)
+      description: Suggest a fix or reason for the bug, if you have any.
+      placeholder: A possible solution could be...
+    validations:
+      required: false
+
+  - type: input
+    id: platform
+    attributes:
+      label: My platform
+      description: Provide details about your system.
+      placeholder: |
+        OS Version: ...
+        Python Version: ...
+        Package Versions: ...
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context, links, or information about the bug.
+      placeholder: Include logs, screenshots, or other details here.
+    validations:
+      required: false

pydmconverter-0.0.0/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,37 @@
+name: Feature request
+description: Suggest a new feature or enhancement for the project.
+title: "[FEATURE] - "
+labels: ["enhancement"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Please provide a clear and concise description of the feature you'd like to propose.**
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What's the problem this feature will solve?
+      description: A clear and concise description of the problem or pain point.
+      placeholder: This feature would solve...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+      placeholder: The ideal solution would be...
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context, links, or resources to support your feature request.
+      placeholder: Include any relevant links, screenshots, or references here.
+    validations:
+      required: false

pydmconverter-0.0.0/.github/workflows/gh-pages.yml

@@ -0,0 +1,38 @@
+# This workflow will publish a new version of the documentation to the gh-pages branch
+
+name: Publish Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    if: ${{ github.repository == 'slaclab/pydm-converter-tool' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: latest
+          use-mamba: true
+          python-version: ${{ matrix.python-version }}
+          channels: conda-forge
+          activate-environment: pydm-converter-tool-dev
+          environment-file: environment.yml
+
+      - name: Build Docs
+        shell: bash -l {0}
+        run: |
+          mkdocs build
+
+      - name: Deploy to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site/

pydmconverter-0.0.0/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Linting
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff pre-commit
+      - name: Switch to a temporary branch
+        run: |
+          git checkout -b _ci_branch_
+      - name: Run pre-commit on all files
+        env:
+          RUFF_OUTPUT_FORMAT: github
+        run: |
+          pre-commit run --show-diff-on-failure --color=always --all-files

pydmconverter-0.0.0/.github/workflows/pypi_release.yml

@@ -0,0 +1,28 @@
+name: Publish Python distributions to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+    environment: deployment
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install pypa/build
+        run: |
+          python -m pip install build --user
+      - name: Build a source tarball
+        run: |
+          python -m build --sdist --outdir dist/ .
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pydmconverter-0.0.0/.github/workflows/tests.yml

@@ -0,0 +1,69 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+
+jobs:
+
+  test:
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    strategy:
+      max-parallel: 1
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.10']
+    env:
+      DISPLAY: ':99.0'
+      QT_MAC_WANTS_LAYER: 1  # PyQT gui tests involving qtbot interaction on macOS will fail without this
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: latest
+          activate-environment: pydm-converter-tool-dev
+          use-mamba: true
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install libs for testing a pyqt app on linux
+        shell: bash -el {0}
+        run: |
+          if [ "$RUNNER_OS" == "Linux" ]; then
+            sudo apt install xvfb herbstluftwm libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils
+            sudo /sbin/start-stop-daemon --start --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -screen 0 1024x768x24 -ac +extension GLX +render -noreset
+            sleep 3
+            sudo /sbin/start-stop-daemon --start --pidfile /tmp/custom_herbstluftwm_99.pid --make-pidfile --background --exec /usr/bin/herbstluftwm
+            sleep 1
+          fi
+
+      - name: Install PyDMConverter
+        shell: bash -l {0}
+        run: |
+          pip install ".[dev]"
+
+      - name: Run Tests
+        shell: bash -l {0}
+        run: |
+          pytest
+
+  test-pypi-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install pypa/build
+        run: |
+          python -m pip install build --user
+      - name: Build a source tarball
+        run: |
+          python -m build --sdist --outdir dist/ .

pydmconverter-0.0.0/.gitignore

@@ -0,0 +1,121 @@
+# PyTest Cache
+.pytest_cache
+
+# OSX DS_Store
+.DS_Store
+
+# PyCharm
+.idea
+
+# PyDev
+.settings
+*.project
+*.pydevproject
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# vim
+*.swp
+
+# Microsoft Visual Studio Code editor
+.vscode/
+
+*.json

pydmconverter-0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: no-commit-to-branch
+      - id: trailing-whitespace
+        exclude: ^examples/
+      - id: end-of-file-fixer
+        exclude: ^examples/
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-xml
+      - id: check-yaml
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format