deploy: e7e3369

.gitignore

@@ -0,0 +1,31 @@
+# local developer files
+dev_*.*
+
+# analysis of unt test code coverage
+.coverage
+
+db/
+log/
+pid/
+security/
+__pycache__/
+*.pyc
+*.egg-info
+*.tar.gz
+*.whl
+docs/build/
+.settings/
+build/
+.ipynb_checkpoints/
+.pydevproject
+issue*.py
+build_log.txt
+
+.ipython_*.log*
+.logs/
+.vscode/
+20*.dat
+
+# bird droppings from IT
+.log
+.loglogin

.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

@@ -0,0 +1,98 @@
+..
+  This file describes user-visible changes between the versions.
+
+  subsections could include these headings (in this order), omit if no content
+
+    Notice
+    Breaking Changes
+    New Features and/or Enhancements
+    Fixes
+    Maintenance
+    Deprecations
+    Contributors
+
+History
+#######
+
+The project `milestones <https://github.com/BCDA-APS/apstools/milestones>`_
+describe the future plans.
+
+..
+   2.0.0
+   *****
+
+   * next release expected by 2024-12-31
+
+   Notice
+   ------
+
+   * 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 search for ESAFs & Proposals using Whoosh package.
+   * Add support for direct access to read IS database.
+   * Add Server class that chooses between DM or IS interface.
+   * Integer timestamp PVs for ESAF start & end and Proposal start, end, & submitted.
+   * User can override default DM URL by setting an environment variable.
+
+   Maintenance
+   -----------
+
+   * 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.
+
+-------------
+
+1.5.6
+*****
+
+released 2022-03-24
+
+Fixes
+~~~~~
+
+* add ``pyyaml`` to package requirements
+
+1.5.5
+*****
+
+released 2022-01-12
+
+Fixes
+~~~~~
+
+* install with Python 3.7+
+* ``main()`` now found for command-line use
+
+1.5.4
+******
+
+released 2022-01-05
+
+This package (``apsbss``) was moved out of ``apstools`` release 1.5.4. See the
+*apstools* `change history
+<https://github.com/BCDA-APS/apstools/blob/main/CHANGES.rst>`_ for any previous
+changes to this code base.

LICENSE.txt

@@ -0,0 +1,48 @@
+Copyright (c) 2017-2025, UChicago Argonne, LLC
+
+All Rights Reserved
+
+apsbss
+
+BCDA, Advanced Photon Source, Argonne National Laboratory
+
+
+OPEN SOURCE LICENSE
+
+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
+   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
+   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
+   permission.
+
+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
+   under Contract No. DE-AC02-06CH11357 with the Department of Energy."
+
+****************************************************************************
+
+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
+represents that its use would not infringe privately owned rights.
+
+****************************************************************************

README.md

@@ -0,0 +1,11 @@
+# apsbss
+
+Read-only interface to get information from APS Proposal and ESAF (experiment safety
+approval form) databases.
+
+home: https://bcda-aps.github.io/apsbss/
+
+[![Release](https://img.shields.io/github/release/BCDA-APS/apsbss.svg)](https://github.com/BCDA-APS/apsbss/releases)
+[![Tag](https://img.shields.io/github/tag/BCDA-APS/apsbss.svg)](https://github.com/BCDA-APS/apsbss/tags)
+[![Build Status](https://img.shields.io/github/workflow/status/BCDA-APS/apsbss/Unit%20Tests)](https://github.com/BCDA-APS/apsbss/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amain)
+[![PyPI](https://img.shields.io/pypi/v/apsbss.svg)](https://pypi.python.org/pypi/apsbss)