Merge pull request #10 from klauer/ci_migrate_gha

DEV/MNT: migrate to latest standards with pyproject.toml [LCLSPC-603]

.coveragerc

@@ -0,0 +1,11 @@
+[run]
+source =
+    krtc
+[report]
+omit =
+    #versioning
+    .*version.*
+    *_version.py
+    #tests
+    *test*
+    krtc/tests/*

.flake8

@@ -0,0 +1,23 @@
+[flake8]
+exclude = .git,__pycache__,build,dist,krtc/_version.py
+max-line-length = 88
+select = C,E,F,W,B,B950
+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 @@
-krtc/_version.py export-subst
+.git_archival.txt  export-subst

.github/workflows/standard.yml

@@ -0,0 +1,26 @@
+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: "krtc"
+      # 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: ""
+      # System packages to be installed only for pip-based testing:
+      pip-system-packages: "libkrb5-dev"
+      # Set if using setuptools-scm for the conda-build workflow
+      use-setuptools-scm: true

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 exclude: |
-    (?x)^(
-        versioneer.py|
-        krtc/_version.py|
-    )$
+  (?x)^(
+    krtc/_version.py|
+  )$
+
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
     -   id: no-commit-to-branch
     -   id: trailing-whitespace
@@ -19,18 +19,15 @@ repos:
     -   id: check-symlinks
     -   id: check-xml
     -   id: check-yaml
-        exclude: |
-            (?x)^(
-                conda-recipe/meta.yaml|
-            )$
+        exclude: '^(conda-recipe/meta.yaml)$'
     -   id: debug-statements
 
 -   repo: https://github.com/pycqa/flake8.git
-    rev: 3.9.2
+    rev: 6.0.0
     hooks:
     -   id: flake8
 
 -   repo: https://github.com/timothycrosley/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
     -   id: isort

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Maintainer
+----------
+
+* SLAC National Accelerator Laboratory <>
+
+Contributors
+------------
+
+Interested? See: `CONTRIBUTING.rst <CONTRIBUTING.rst>`_

CONTRIBUTING.rst

@@ -0,0 +1,103 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/pcdshub/krtc/issues.
+
+If you are reporting a bug, please include:
+
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+krtc could always use more documentation, whether
+as part of the official krtc docs, in docstrings,
+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/krtc/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `krtc` for local development.
+
+1. Fork the `krtc` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/krtc.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 krtc python=3.9 pip
+    $ cd krtc/
+    $ pip install -e .
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. Install and enable ``pre-commit`` for this repository::
+
+    $ 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::
+
+    $ pytest -v
+
+7. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+8. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+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.9 and up. Check the GitHub Actions status
+   and make sure that the tests pass for all supported Python versions.

LICENSE

@@ -1,21 +1,39 @@
-MIT License
+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
+modification, are permitted provided that the following conditions are met:
 
-Copyright (c) 2022 SLAC Lab
+(1) Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
 
-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:
+(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.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+(3) Neither the name of the Leland Stanford Junior University, SLAC National
+    Accelerator Laboratory, U.S. Dept. 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.
 
-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.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT,
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.
+
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to SLAC National Accelerator Laboratory,
+without imposing a separate written license agreement for such Enhancements,
+then you hereby grant the following license: a non-exclusive, royalty-free
+perpetual license to install, use, modify, prepare derivative works, incorporate
+into other computer software, distribute, and sublicense such Enhancements or
+derivative works thereof, in binary and source code form.

conda-recipe/meta.yaml

@@ -1,23 +1,33 @@
-{% set data = load_setup_py_data() %}
+{% set package_name = "krtc" %}
+{% set import_name = "krtc" %}
+{% set version = load_file_regex(load_file=os.path.join(import_name, "_version.py"), regex_pattern=".*version = '(\S+)'").group(1) %}
 
 package:
-  name: krtc
-  version: {{ data.get('version') }}
+  name: {{ package_name }}
+  version: {{ version }}
 
 source:
-  path : ..
+  path: ..
 
 build:
-  number: 2
+  number: 0
   noarch: python
+  script: {{ PYTHON }} -m pip install . -vv
 
 requirements:
   build:
-    - python
-    - pip
+  - python
+  - pip
+  - setuptools_scm
   run:
-    - python
-    - pykerberos
+  - python
+  - pykerberos
+
+test:
+  imports:
+  - krtc
+  requires:
+  - pytest
 
 about:
   home: https://github.com/slaclab/krtc.git

dev-requirements.txt

@@ -1,4 +1 @@
 pytest
-doctr
-sphinx
-sphinx_rtd_theme

docs-requirements.txt

@@ -0,0 +1,4 @@
+docs-versions-menu
+sphinx
+sphinx_rtd_theme
+sphinxcontrib-jquery