Setup standard ECS GH workflows

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 source =
-    btms_ui
+    btms-ui
 [report]
 omit =
     #versioning

.flake8

@@ -1,5 +1,23 @@
 [flake8]
-exclude = .git,__pycache__,build,dist,versioneer.py,btms_ui/_version.py,docs/source/conf.py
+exclude = .git,__pycache__,build,dist,btms_ui/_version.py
 max-line-length = 88
 select = C,E,F,W,B,B950
-extend-ignore = E203, E501
+extend-ignore = E203, E501, E226, W503, W504
+
+# Explanation section:
+# B950
+#   This takes into account max-line-length but only triggers when the value
+#   has been exceeded by more than 10% (96 characters).
+# E203: Whitespace before ':'
+#   This is recommended by black in relation to slice formatting.
+# E501: Line too long (82 > 79 characters)
+#   Our line length limit is 88 (above 79 defined in E501).  Ignore it.
+# E226: Missing whitespace around arithmetic operator
+#   This is a stylistic choice which you'll find everywhere in pcdsdevices, for
+#   example.  Formulas can be easier to read when operators and operands
+#   have no whitespace between them.
+#
+# W503: Line break occurred before a binary operator
+# W504: Line break occurred after a binary operator
+#   flake8 wants us to choose one of the above two.  Our choice
+#   is to make no decision.

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -1 +1 @@
-btms_ui/_version.py export-subst
+.git_archival.txt  export-subst

.github/workflows/standard.yml

@@ -0,0 +1,24 @@
+name: PCDS Standard Testing
+
+on:
+  push:
+  pull_request:
+  release:
+    types:
+      - published
+
+jobs:
+  standard:
+    uses: pcdshub/pcds-ci-helpers/.github/workflows/python-standard.yml@master
+    with:
+      # The workflow needs to know the package name.  This can be determined
+      # automatically if the repository name is the same as the import name.
+      package-name: "btms_ui"
+      # Extras that will be installed for both conda/pip:
+      testing-extras: ""
+      # Extras to be installed only for conda-based testing:
+      conda-testing-extras: ""
+      # Extras to be installed only for pip-based testing:
+      pip-testing-extras: ""
+      # Set if using setuptools-scm for the conda-build workflow
+      use-setuptools-scm: true

.pre-commit-config.yaml

@@ -1,10 +1,15 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: |
+  (?x)^(
+    btms_ui/_version.py|
+  )$
+
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.6.0
     hooks:
-    # -   id: no-commit-to-branch
+    -   id: no-commit-to-branch
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-ast
@@ -18,11 +23,11 @@ repos:
     -   id: debug-statements
 
 -   repo: https://github.com/pycqa/flake8.git
-    rev: 3.9.2
+    rev: 7.1.0
     hooks:
     -   id: flake8
 
 -   repo: https://github.com/timothycrosley/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
     -   id: isort

AUTHORS.rst

@@ -10,4 +10,4 @@ Maintainer
 Contributors
 ------------
 
-Interested? See: CONTRIBUTING.rst
+Interested? See: `CONTRIBUTING.rst <CONTRIBUTING.rst>`_

CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/pcdshub/btms_ui/issues.
+Report bugs at https://github.com/pcdshub/btms-ui/issues.
 
 If you are reporting a bug, please include:
 
@@ -42,7 +42,7 @@ or even on the web in blog posts, articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/pcdshub/btms_ui/issues.
+The best way to send feedback is to file an issue at https://github.com/pcdshub/btms-ui/issues.
 
 If you are proposing a feature:
 
@@ -54,17 +54,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `btms_ui` for local development.
+Ready to contribute? Here's how to set up `btms-ui` for local development.
 
-1. Fork the `btms_ui` repo on GitHub.
+1. Fork the `btms-ui` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/btms_ui.git
+    $ git clone git@github.com:your_name_here/btms-ui.git
 
 3. Install your local copy into a new conda environment. Assuming you have conda installed, this is how you set up your fork for local development::
 
-    $ conda create -n btms_ui python=3.7
-    $ cd btms_ui/
+    $ conda create -n btms-ui python=3.9 pip
+    $ cd btms-ui/
     $ pip install -e .
 
 4. Create a branch for local development::
@@ -73,13 +73,14 @@ Ready to contribute? Here's how to set up `btms_ui` for local development.
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8::
+5. Install and enable ``pre-commit`` for this repository::
 
-    $ flake8 btms_ui
+    $ pip install pre-commit
+    $ pre-commit install
 
 6. Add new tests for any additional functionality or bugs you may have discovered.  And, of course, be sure that all previous tests still pass by running::
 
-    $ python run_tests.py -v
+    $ pytest -v
 
 7. Commit your changes and push your branch to GitHub::
 
@@ -98,6 +99,5 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put your
    new functionality into a function with a docstring, and add the feature to
    the list in README.rst.
-3. The pull request should work for Python 3.5 and up. Check
-   https://travis-ci.org/pcdshub/btms_ui/pull_requests
+3. The pull request should work for Python 3.9 and up. Check the GitHub Actions status
    and make sure that the tests pass for all supported Python versions.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017, The Board of Trustees of the Leland Stanford Junior
+Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior
 University, through SLAC National Accelerator Laboratory (subject to receipt
 of any required approvals from the U.S. Dept. of Energy). All rights reserved.
 Redistribution and use in source and binary forms, with or without

btms_ui/__init__.py

@@ -1,4 +1,3 @@
-from . import _version
-__version__ = _version.get_versions()['version']
+from ._version import __version__  # noqa: F401
 
 __all__ = []