Merge pull request #15 from casework/release-0.3.0

Release 0.3.0
casework · Aug 12, 2022 · ff43f39 · ff43f39
2 parents 194c615 + 24ab951
commit ff43f39
Show file tree

Hide file tree

Showing 30 changed files with 637 additions and 1,043 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,14 +24,18 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-java@v2
+    - uses: actions/setup-java@v3
       with:
-        distribution: 'adopt'
-        java-version: '8'
+        distribution: 'temurin'
+        java-version: '11'
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Pre-commit Checks
+      run: |
+        pip -q install pre-commit
+        pre-commit run --all-files
     - name: Start from clean state
       run: make clean
     - name: Run tests

diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,7 @@
 *.swp
 .generated-*
 .pytest_cache
+.venv-pre-commit
 __pycache__
+build
 catalog-v001.xml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort (python)
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,36 +1,35 @@
-# NIST DISCLAIMER
+# NIST Software Licensing Statement
 
-The following information applies to the software code developed
-by employees of NIST.
+NIST-developed software is provided by NIST as a public service.
+You may use, copy, and distribute copies of the software in any
+medium, provided that you keep intact this entire notice. You may
+improve, modify, and create derivative works of the software or
+any portion of the software, and you may copy and distribute such
+modifications or works. Modified works should carry a notice
+stating that you changed the software and should note the date
+and nature of any such change. Please explicitly acknowledge the
+National Institute of Standards and Technology as the source of
+the software.
 
-Additional LICENSES are located within the code base and are provided by 3rd 
-party developers.
-==============================================================================
+NIST-developed software is expressly provided "AS IS." NIST MAKES
+NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT, OR ARISING BY
+OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+NON-INFRINGEMENT, AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
+WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED
+OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES
+NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE
+SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE
+CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE
+SOFTWARE.
 
-This software was developed by employees of the National Institute of
-Standards and Technology (NIST), an agency of the Federal Government and is
-being made available as a public service. Pursuant to title 17 United States
-Code Section 105, works of NIST employees are not subject to copyright
-protection in the United States.  This software may be subject to foreign
-copyright.  Permission in the United States and in foreign countries, to the
-extent that NIST may hold copyright, to use, copy, modify, create derivative
-works, and distribute this software and its documentation without fee is hereby
-granted on a non-exclusive basis, provided that this notice and disclaimer of
-warranty appears in all copies.
-
-THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
-EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
-THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
-INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
-SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
-SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
-INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
-OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON
-WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED
-BY PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED
-FROM, OR AROSE OUT OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES
-PROVIDED HEREUNDER.
-
-To see the latest statement, please visit:
-[https://www.nist.gov/director/copyright-fair-use-and-licensing-statements-srd-data-and-software](Copyright, Fair Use, and Licensing Statements for SRD, Data, and Software)
+You are solely responsible for determining the appropriateness of
+using and distributing the software and you assume all risks
+associated with its use, including but not limited to the risks
+and costs of program errors, compliance with applicable laws,
+damage to or loss of data, programs or equipment, and the
+unavailability or interruption of operation. This software is not
+intended to be used in any situation where a failure could cause
+risk of injury or damage to property. The software developed by
+NIST employees is not subject to copyright protection within the
+United States.
diff --git a/Makefile b/Makefile
@@ -18,6 +18,7 @@ PYTHON3 ?= $(shell which python3.9 2>/dev/null || which python3.8 2>/dev/null ||
 GSED ?= $(shell which gsed 2>/dev/null || which sed)
 
 all: \
+  .venv-pre-commit/var/.pre-commit-built.log \
   README.md
 
 .PHONY: \
@@ -59,8 +60,32 @@ README.md: \
 	  --directory lib
 	touch $@
 
+# This virtual environment is meant to be built once and then persist, even through 'make clean'.
+# If a recipe is written to remove this flag file, it should first run `pre-commit uninstall`.
+.venv-pre-commit/var/.pre-commit-built.log:
+	rm -rf .venv-pre-commit
+	test -r .pre-commit-config.yaml \
+	  || (echo "ERROR:Makefile:pre-commit is expected to install for this repository, but .pre-commit-config.yaml does not seem to exist." >&2 ; exit 1)
+	$(PYTHON3) -m venv \
+	  .venv-pre-commit
+	source .venv-pre-commit/bin/activate \
+	  && pip install \
+	    --upgrade \
+	    pip \
+	    setuptools \
+	    wheel
+	source .venv-pre-commit/bin/activate \
+	  && pip install \
+	    pre-commit
+	source .venv-pre-commit/bin/activate \
+	  && pre-commit install
+	mkdir -p \
+	  .venv-pre-commit/var
+	touch $@
+
 # After running unit tests, see if README.md needs to be regenerated.
 check: \
+  .venv-pre-commit/var/.pre-commit-built.log \
   .lib.done.log
 	$(MAKE) \
 	  PYTHON3=$(PYTHON3) \
@@ -80,7 +105,8 @@ clean:
 	  clean
 
 download: \
-  .lib.done.log
+  .lib.done.log \
+  .venv-pre-commit/var/.pre-commit-built.log
 	$(MAKE) \
 	  PYTHON3=$(PYTHON3) \
 	  --directory tests \

diff --git a/README.md b/README.md
@@ -65,6 +65,11 @@ This repository is available at the following locations:
 Releases and issue tracking will be handled at the [casework location](https://github.com/casework/CASE-Utility-SHACL-Inheritance-Reviewer).
 
 
+## Licensing
+
+Portions of this repository contributed by NIST are governed by the [NIST Software Licensing Statement](LICENSE.md#nist-software-licensing-statement).
+
+
 ## Make targets
 
 Some `make` targets are defined for this repository:

diff --git a/README.md.in b/README.md.in
@@ -65,6 +65,11 @@ This repository is available at the following locations:
 Releases and issue tracking will be handled at the [casework location](https://github.com/casework/CASE-Utility-SHACL-Inheritance-Reviewer).
 
 
+## Licensing
+
+Portions of this repository contributed by NIST are governed by the [NIST Software Licensing Statement](LICENSE.md#nist-software-licensing-statement).
+
+
 ## Make targets
 
 Some `make` targets are defined for this repository: