nova-epics 0.1.0__tar.gz

nova_epics-0.1.0/.dockerignore

@@ -0,0 +1 @@
+dockerfiles/Dockerfile

nova_epics-0.1.0/.github/workflows/build-test.yml

@@ -0,0 +1,49 @@
+name: Build and Test
+
+on: push
+
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  NDIP_DOCKER_REPOSITORY: "${{ secrets.NDIP_DOCKER_REPOSITORY }}"
+  READTHEDOCS_WEBHOOK_URL: "${{ secrets.READTHEDOCS_WEBHOOK_URL }}"
+  READTHEDOCS_WEBHOOK_SECRET: "${{ secrets.READTHEDOCS_WEBHOOK_SECRET }}"
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    env:
+      GIT_STRATEGY: clone
+      IMAGE_NAME: "${NDIP_DOCKER_REPOSITORY}/${{ github.repository }}"
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Build
+        uses: docker/build-push-action@v6
+        id: build
+        with:
+          file: dockerfiles/Dockerfile
+          load: true
+          target: source
+      - name: Run ruff check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff check
+      - name: Run format check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff format --check
+      - name: Run mypy
+        run: docker run --rm ${{ steps.build.outputs.imageid }} mypy .
+      - name: Unit tests
+        run: docker run --rm ${{ steps.build.outputs.imageid }} pytest
+      - name: Run coverage
+        run: docker run --rm ${{ steps.build.outputs.imageid }} sh -c "coverage run && coverage report"
+      - name: Docs test
+        run: docker run --rm ${{ steps.build.outputs.imageid }} bash build_docs.sh

nova_epics-0.1.0/.github/workflows/nova-epics.yml

@@ -0,0 +1,60 @@
+name: Publish Package
+
+on: workflow_dispatch
+
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  PYPI_API_TOKEN: "${{ secrets.PYPI_API_TOKEN }}"
+
+jobs:
+  tag-release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    permissions: write-all
+    env:
+      GIT_STRATEGY: clone
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Parse version
+        run: echo "VERSION=$(cat pyproject.toml | grep "version =" | head -n 1 | awk '{ print $3 }' | tr -d '"')" >> $GITHUB_ENV
+      - name: Create release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.VERSION }}
+          release_name: ${{ env.VERSION }}
+
+  publish-package:
+    needs: tag-release
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch'
+    timeout-minutes: 60
+    env:
+      GIT_STRATEGY: clone
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Build
+        uses: docker/build-push-action@v6
+        id: build
+        with:
+          file: dockerfiles/Dockerfile
+          load: true
+          target: package
+      - name: Publish
+        run: docker run --rm ${{ steps.build.outputs.imageid }} sh -c "hatch build && hatch publish -u __token__ -a ${PYPI_API_TOKEN}"

nova_epics-0.1.0/.gitignore

@@ -0,0 +1,168 @@
+# 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/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  We ingore the whole .idea folder
+#  For more fine tuning, JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.
+.idea
+
+
+.envrc
+
+
+junit.xml
+
+.pixi

nova_epics-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: check-added-large-files
+      args: [--maxkb=8192]
+    - id: check-merge-conflict
+    - id: check-yaml
+      args: [--allow-multiple-documents]
+    - id: end-of-file-fixer
+    - id: check-toml
+    - id: trailing-whitespace
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.2
+  hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
+    - id: ruff-format
+- repo: local
+  hooks:
+    - id: mypy
+      name: mypy
+      entry: pixi run mypy .
+      language: system
+      types: [python]
+      verbose: true
+      pass_filenames: false

nova_epics-0.1.0/.readthedocs.yml

@@ -0,0 +1,39 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+  jobs:
+    post_create_environment:
+      - pip install sphinx-rtd-theme==3.0.2 tomli
+      - pip install .
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

nova_epics-0.1.0/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "ms-python.mypy-type-checker"
+    ]
+}

nova_epics-0.1.0/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "[restructuredtext]": {
+        "editor.wordWrap": "wordWrapColumn",
+        "editor.wordWrapColumn": 120
+    },
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

nova_epics-0.1.0/CHANGELOG.md

@@ -0,0 +1,3 @@
+### nova-epics, 0.1.0
+
+* Adds read-only connection to EPICS Tomcat server for pulling instrument status into Trame applications (thanks to John Duggan).

nova_epics-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socioeconomic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+watsongr@ornl.gov.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

nova_epics-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing to nova-trame
+
+Thank you for considering contributing to nova-trame!
+This document provides guidelines to help you contribute effectively and ensure a smooth process for everyone involved.
+
+## Getting Started
+
+To start contributing to this project, you will need a GitHub account. If you are unfamiliar with GitHub or version control,
+then please consider reviewing the [GitHub docs](https://docs.github.com/).
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug in the project, please open an issue on GitHub with a clear and concise description. Make sure to include:
+
+- Steps to reproduce the bug.
+- Expected behavior.
+- Actual behavior.
+- Any relevant screenshots, logs, or stack traces.
+
+### Suggesting Features
+
+We welcome feature suggestions! To propose a new feature:
+
+1. Open an issue on GitHub with the title "Feature Request: [Feature Name]".
+2. Provide a detailed description of the proposed feature.
+3. Explain why this feature would be useful for the project.
+4. Include any relevant examples or mockups.
+
+### Submitting Changes
+
+If you'd like to contribute code changes, please follow our
+[style guidelines](https://calvera.ornl.gov/docs/dev_guide/contributing/style_guidelines/).
+
+## Code of Conduct
+
+Please adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.

nova_epics-0.1.0/DEVELOPMENT.md

@@ -0,0 +1,87 @@
+# Development Guide
+
+This document provides guidelines and instructions for setting up and contributing to
+the nova-trame project.
+
+## Starting from the template
+
+- Add other Python dependencies you project need with [`pixi add`](https://pixi.sh/latest/reference/cli/pixi/add/).
+- Modify Dockerfile as needed. Please make sure it can still run as non-root (we use it in GitHub Actions and in general this
+is a good practice).
+- install pre-commit (if not already installed) - `pixi add --pypi pre-commit`
+- activate `pre-commit` for your project: `cd <project folder> && pixi run pre-commit install`
+- finally, clear the content of this section and add the description of your project. You can keep/adjust instructions
+below
+
+Note 1: please don't change linter settings, license, code of conduct without discussing with the team first - we want to keep them
+the same for all our projects.
+
+Note 2: if you think some changes that you've made might be useful for other projects as well, please fill free
+to create an issue [in this repo](https://code.ornl.gov/ndip/project-templates/python/-/issues/new)
+
+
+## Installation
+
+Start by installing [Pixi](https://pixi.sh/latest/). Once done, run the following:
+
+```commandline
+pixi install
+```
+
+## Widget Gallery
+This package includes a widget gallery that shows commonly used Vuetify components for visual testing. Please use this to test your changes in this repository.
+
+You can run it via:
+```commandline
+pixi run app [--server]
+```
+
+## Formatting
+```commandline
+pixi run ruff format
+```
+
+## Linting
+```commandline
+pixi run ruff check
+pixi run mypy .
+```
+
+## Testing
+You will need a working [Firefox](https://www.mozilla.org/en-US/firefox/) install available in order to run all tests.
+Otherwise, all [Selenium-based tests](https://www.selenium.dev/) will fail.
+
+```commandline
+pixi run pytest
+```
+or, with coverage
+```commandline
+pixi run coverage run
+pixi run coverage report
+```
+
+## Updating project from template
+
+This project was created from a [template](https://code.ornl.gov/ndip/project-templates/python.git) using [copier](https://copier.readthedocs.io/). If the template has changed, you
+can try to update the project to incorporate these changes. Just enter the project folder, make sure `git status`
+shows it clean, and run:
+```
+copier update
+```
+See [here](https://copier.readthedocs.io/en/stable/updating/#updating-a-project) for more information.
+
+
+## CI/CD in GitHub
+
+Take a look at the [`.github/workflows`](.github/workflows) folder.
+Actions to lint and test your code will run automatically on each commit.
+The action for building and releasing this package needs to be triggered manually.
+
+### Versioning
+
+The "source of truth" for the version number is in the [`pyproject.toml`](pyproject.toml) file. It is used for Docker
+image tags, python package versioning, and automatic creation of git tags.
+
+### Publishing docs to readthedocs.io
+
+This repo has a [webhook](https://github.com/nova-model/nova-trame/settings/hooks) that automatically triggers documentation builds on readthedocs.

nova_epics-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ONRL
+
+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.

nova_epics-0.1.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: nova-epics
+Version: 0.1.0
+Summary: A Python Package for 
+Project-URL: Changelog, https://github.com/nova-sdk/nova-epics/blob/main/CHANGELOG.md
+Author-email: John Duggan <dugganjw@ornl.gov>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: NDIP,Python,Trame
+Requires-Python: <3.14,>=3.10
+Requires-Dist: dpath
+Requires-Dist: tomli
+Requires-Dist: xmltodict
+Provides-Extra: trame
+Requires-Dist: nova-trame; extra == 'trame'
+Description-Content-Type: text/markdown
+
+nova-epics
+==========
+
+`nova-epics` is a Python package for retrieving unprivileged instrument status information from EPICS for use in NOVA applications.
+
+You can install this package directly with
+
+```commandline
+pip install "nova-epics[trame]"
+```
+
+Developers: please read [this document](DEVELOPMENT.md)

nova_epics-0.1.0/README.md

@@ -0,0 +1,12 @@
+nova-epics
+==========
+
+`nova-epics` is a Python package for retrieving unprivileged instrument status information from EPICS for use in NOVA applications.
+
+You can install this package directly with
+
+```commandline
+pip install "nova-epics[trame]"
+```
+
+Developers: please read [this document](DEVELOPMENT.md)