Merge pull request #27 from BCDA-APS/14-APSU-refactor

Refactor for APS-U

.github/.archive/publish-sphinx.yml

@@ -26,4 +26,4 @@ jobs:
       uses: ad-m/github-push-action@master
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        branch: gh-pages
+        branch: gh-pages

.github/.archive/publish_anaconda.yml

@@ -12,7 +12,7 @@ on:
       - '**'
   pull_request:
     branches: [ main ]
-    
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/docs.yml

@@ -63,7 +63,7 @@ jobs:
       with:
         name: apsbss-docs
         path: ${{ steps.deployment.outputs.artifact }}
-    
+
     - uses: peaceiris/actions-gh-pages@v4
       if: ${{ github.event.inputs.deploy }}
       with:

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# hint: pre-commit run --all-files
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      # exclude_types: [jupyter]
+      - id: check-yaml
+      - id: check-toml
+      - id: check-ast
+      # - id: check-docstring-first  # let variables have docstrings
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-case-conflict
+      # - id: check-json
+      # - id: check-symlinks
+      - id: check-executables-have-shebangs
+  # Don't strip output from jupyter notebooks ATM.
+  # - repo: https://github.com/kynan/nbstripout
+  #   rev: 0.7.1
+  #   hooks:
+  #     - id: nbstripout
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.8
+    hooks:
+      - id: ruff # replaces Flake8, isort, pydocstyle, pyupgrade
+        args:
+          - --fix
+      - id: ruff-format # replaces Black

CHANGES.rst

@@ -11,8 +11,8 @@
     Deprecations
     Contributors
 
-Change History
-##############
+History
+#######
 
 The project `milestones <https://github.com/BCDA-APS/apstools/milestones>`_
 describe the future plans.
@@ -21,19 +21,47 @@ describe the future plans.
    2.0.0
    *****
 
-   next release expected by -tba-
+   * next release expected by 2024-12-31
 
    Notice
    ------
 
-   Complete overhaul for APS-U era.
+   * Complete overhaul for APS-U era.
+
+   Breaking Changes
+   ----------------
+
+   * Proposal ID is now an integer, was previously text.  (ESAF ID is integer,
+     as before.)
+   * Standardize on the name **run** instead of **cycle** as the reference used
+     for the name of an APS operations *run* period.
+
+     * Includes EPICS PV: ``record(stringout, "$(P)esaf:run")``
+
+   New Features
+   ------------
+
+   * Add support for direct access to read IS database.
+   * Add Server class that chooses between DM or IS interface.
 
    Maintenance
    -----------
 
-   Update to install and run with Python versions 3.9, 3.10, 3.11.
+   * Add requests to project requirements.
+   * Code style enforced by pre-commit.
+   * Increased code coverage of unit testing.
+   * Moved report and table generation to new Server class.
+   * Refactored (and simplified) IOC report table.
+   * Relocated functions out of apsbss module.
+   * Switch documentation to use pydata sphinx theme.
+   * Update to install and run with Python versions 3.9, 3.10, 3.11.
+
+   Deprecations
+   -------------
+
+   * Removed all items marked for deprecation.
 
-pyyaml
+-------------
 
 1.5.6
 *****

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2022, UChicago Argonne, LLC
+Copyright (c) 2017-2025, UChicago Argonne, LLC
 
 All Rights Reserved
 
@@ -9,27 +9,27 @@ BCDA, Advanced Photon Source, Argonne National Laboratory
 
 OPEN SOURCE LICENSE
 
-Redistribution and use in source and binary forms, with or without 
+Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, 
-   this list of conditions and the following disclaimer.  Software changes, 
-   modifications, or derivative works, should be noted with comments and 
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.  Software changes,
+   modifications, or derivative works, should be noted with comments and
    the author and organization's name.
 
 2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation 
+   this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 
-3. Neither the names of UChicago Argonne, LLC or the Department of Energy 
-   nor the names of its contributors may be used to endorse or promote 
-   products derived from this software without specific prior written 
+3. Neither the names of UChicago Argonne, LLC or the Department of Energy
+   nor the names of its contributors may be used to endorse or promote
+   products derived from this software without specific prior written
    permission.
 
-4. The software and the end-user documentation included with the 
+4. The software and the end-user documentation included with the
    redistribution, if any, must include the following acknowledgment:
 
-   "This product includes software produced by UChicago Argonne, LLC 
+   "This product includes software produced by UChicago Argonne, LLC
    under Contract No. DE-AC02-06CH11357 with the Department of Energy."
 
 ****************************************************************************
@@ -38,11 +38,11 @@ DISCLAIMER
 
 THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 
-Neither the United States GOVERNMENT, nor the United States Department 
-of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes 
-any warranty, express or implied, or assumes any legal liability or 
-responsibility for the accuracy, completeness, or usefulness of any 
-information, data, apparatus, product, or process disclosed, or 
+Neither the United States GOVERNMENT, nor the United States Department
+of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes
+any warranty, express or implied, or assumes any legal liability or
+responsibility for the accuracy, completeness, or usefulness of any
+information, data, apparatus, product, or process disclosed, or
 represents that its use would not infringe privately owned rights.
 
 ****************************************************************************

apsbss/__init__.py

@@ -16,7 +16,7 @@
 # -----------------------------------------------------------------------------
 # :author:    Pete R. Jemian
 # :email:     jemian@anl.gov
-# :copyright: (c) 2017-2021, UChicago Argonne, LLC
+# :copyright: (c) 2017-2025, UChicago Argonne, LLC
 #
 # Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
 #

apsbss/apsbss.adl

@@ -146,7 +146,7 @@ composite {
 			"basic attribute" {
 				clr=14
 			}
-			textix="APS run cycle"
+			textix="APS run"
 			align="horiz. right"
 		}
 		"text entry" {
@@ -157,7 +157,7 @@ composite {
 				height=16
 			}
 			control {
-				chan="$(P)esaf:cycle"
+				chan="$(P)esaf:run"
 				clr=14
 				bclr=50
 			}