Skip to content

Commit 0dfb21c

Browse files
ajnelson-nistajnelson-nist
committed
Merge branch 'develop' into pre-commit-black
2 parents 63f01d4 + 4617cf4 commit 0dfb21c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+19650
-322
lines changed

‎.github/workflows/ci.yml renamed to ‎.github/workflows/cicd.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,27 @@ jobs:
4343
run: make clean
4444
- name: Run tests
4545
run: make PYTHON3=python check
46+
47+
# Build the binary wheel as well as the source tar
48+
- name: Build Objects
49+
run: |
50+
pip install -q twine wheel
51+
python setup.py sdist bdist_wheel
52+
53+
# Ensure the objects were packaged correctly and there wasn't an issue with
54+
# the compilation or packaging process.
55+
- name: Check Objects
56+
run: twine check dist/*
57+
58+
# Upload the packages on all develop and main pipleines for test consumption
59+
- name: Upload HTML Docs
60+
uses: actions/upload-artifact@v2
61+
with:
62+
name: packages
63+
path: ./dist/
64+
65+
# If this commit is the result of a Git tag, push the wheel and tar packages
66+
# to the PyPi registry
67+
- name: Publish to PyPI
68+
if: startsWith(github.ref, 'refs/tags')
69+
run: twine upload --repository-url https://upload.pypi.org/legacy/ -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} --skip-existing --verbose dist/*

‎.gitmodules

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
[submodule "dependencies/CASE"]
22
path = dependencies/CASE
33
url = https://github.com/casework/CASE.git
4-
[submodule "dependencies/CASE-Examples-QC"]
5-
path = dependencies/CASE-Examples-QC
6-
url = https://github.com/ajnelson-nist/CASE-Examples-QC.git

‎CONTRIBUTE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
1. After cloning this repository, ensure the CASE submodule is checked out. This can be done with either `git submodule init && git submodule update`, `make .git_submodule_init.done.log`, or `make check`.
77
2. Update the CASE submodule pointer to the new tagged release.
88
3. The version of CASE is also hard-coded in [`case_utils/ontology/version_info.py`](case_utils/ontology/version_info.py). Edit the variable `CURRENT_CASE_VERSION`.
9-
4. From the top source directory, run `make clean`. This guarantees a clean state of this repository as well as the ontology submodules.
10-
5. Still from the top source directory, run `make`.
11-
6. Any new `.ttl` files will be created under [`case_utils/ontology/`](case_utils/ontology/). Use `git add` to add each of them. (The patch-weight of these files could overshadow manual revisions, so it is fine to commit the built files after the manual changes are committed.)
9+
4. A list of built versions of CASE is also hard-coded in [`case_utils/ontology/version_info.py`](case_utils/ontology/version_info.py). Edit the variable `built_version_choices_list`.
10+
5. From the top source directory, run `make clean`. This guarantees a clean state of this repository as well as the ontology submodules.
11+
6. Still from the top source directory, run `make`.
12+
7. Any new `.ttl` files will be created under [`case_utils/ontology/`](case_utils/ontology/). Use `git add` to add each of them. (The patch-weight of these files could overshadow manual revisions, so it is fine to commit the built files separately from the manual changes being committed. Preferably, commit the built files *before* manual changes - this prevents later issues with a `git bisect` that relies on CI passing.)
1213

1314
Here is a sample sequence of shell commands to run the build:
1415

@@ -29,8 +30,8 @@ pushd case_utils/ontology
2930
popd
3031
make check
3132
# Assuming `make check` passes:
33+
git commit -m "Build CASE 0.6.0 monolithic .ttl files" case_utils/ontology/case-0.6.0-subclasses.ttl case_utils/ontology/case-0.6.0.ttl
3234
git commit -m "Update CASE ontology pointer to version 0.6.0" dependencies/CASE case_utils/ontology/version_info.py
33-
git commit -m "Build CASE 0.6.0.ttl" case_utils/ontology/case-0.6.0.ttl
3435
```
3536

3637
This project uses [the `pre-commit` tool](https://pre-commit.com/) for linting The easiest way to install it is with `pip`:

‎LICENSE

Lines changed: 176 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,176 @@
1-
NIST Software
2-
3-
This software was developed by employees of the National Institute of Standards
4-
and Technology (NIST), an agency of the Federal Government and is being made
5-
available as a public service. Pursuant to title 17 United States Code Section
6-
105, works of NIST employees are not subject to copyright protection in the
7-
United States. This software may be subject to foreign copyright. Permission
8-
in the United States and in foreign countries, to the extent that NIST may hold
9-
copyright, to use, copy, modify, create derivative works, and distribute this
10-
software and its documentation without fee is hereby granted on a non-exclusive
11-
basis, provided that this notice and disclaimer of warranty appears in all copies.
12-
13-
THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED
14-
, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SOFTWARE
15-
WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
16-
A PARTICULAR PURPOSE, AND FREEDOM FROM INFRINGEMENT, AND ANY WARRANTY THAT THE
17-
DOCUMENTATION WILL CONFORM TO THE SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE
18-
ERROR FREE. IN NO EVENT SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT
19-
LIMITED TO, DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF,
20-
RESULTING FROM, OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON
21-
WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS
22-
OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF
23-
THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎Makefile

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,6 @@ all: \
3333
cd dependencies \
3434
&& git diff . \
3535
| cat
36-
git submodule init dependencies/CASE-Examples-QC
37-
git submodule update dependencies/CASE-Examples-QC
38-
# Build an ontology terms list, which has a side effect of initiating further submodules.
39-
$(MAKE) \
40-
--directory dependencies/CASE-Examples-QC \
41-
.git_submodule_init.done.log \
42-
.venv.done.log
43-
$(MAKE) \
44-
--directory dependencies/CASE-Examples-QC/tests \
45-
ontology_vocabulary.txt
4636
test -r dependencies/CASE/ontology/master/case.ttl \
4737
|| (git submodule init dependencies/CASE && git submodule update dependencies/CASE)
4838
test -r dependencies/CASE/ontology/master/case.ttl
@@ -116,10 +106,6 @@ clean:
116106
tests/examples \
117107
|| true \
118108
)
119-
@#Remove flag files that are normally set after deeper submodules and rdf-toolkit are downloaded.
120-
@rm -f \
121-
dependencies/CASE-Examples-QC/.git_submodule_init.done.log \
122-
dependencies/CASE-Examples-QC/.lib.done.log
123109

124110
# This recipe guarantees timestamp update order, and is otherwise intended to be a no-op.
125111
dependencies/CASE/ontology/master/case.ttl: \

‎README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,10 @@ Some `make` targets are defined for this repository:
136136
* `check` - Run unit tests.
137137
* `clean` - Remove test build files, but not downloaded files.
138138
* `download` - Download files sufficiently to run the unit tests offline. This will *not* include the ontology repositories tracked as submodules. Note if you do need to work offline, be aware touching the `setup.cfg` file in the project root directory, or `tests/requirements.txt`, will trigger a virtual environment rebuild.
139+
140+
141+
## Licensing
142+
143+
This repository is licensed under the Apache 2.0 License. See [LICENSE](LICENSE).
144+
145+
Portions of this repository contributed by NIST are governed by the [NIST Software Licensing Statement](THIRD_PARTY_LICENSES.md#nist-software-licensing-statement).

‎THIRD_PARTY_LICENSES.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Portions of this repository contributed by NIST are governed by
2+
the following license.
3+
4+
5+
# NIST Software Licensing Statement
6+
7+
NIST-developed software is provided by NIST as a public service.
8+
You may use, copy, and distribute copies of the software in any
9+
medium, provided that you keep intact this entire notice. You may
10+
improve, modify, and create derivative works of the software or
11+
any portion of the software, and you may copy and distribute such
12+
modifications or works. Modified works should carry a notice
13+
stating that you changed the software and should note the date
14+
and nature of any such change. Please explicitly acknowledge the
15+
National Institute of Standards and Technology as the source of
16+
the software.
17+
18+
NIST-developed software is expressly provided "AS IS." NIST MAKES
19+
NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT, OR ARISING BY
20+
OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
21+
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
22+
NON-INFRINGEMENT, AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
23+
WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED
24+
OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES
25+
NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE
26+
SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE
27+
CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE
28+
SOFTWARE.
29+
30+
You are solely responsible for determining the appropriateness of
31+
using and distributing the software and you assume all risks
32+
associated with its use, including but not limited to the risks
33+
and costs of program errors, compliance with applicable laws,
34+
damage to or loss of data, programs or equipment, and the
35+
unavailability or interruption of operation. This software is not
36+
intended to be used in any situation where a failure could cause
37+
risk of injury or damage to property. The software developed by
38+
NIST employees is not subject to copyright protection within the
39+
United States.

‎case_utils/__init__.py

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,6 @@
1111
#
1212
# We would appreciate acknowledgement if the software is used.
1313

14-
__version__ = "0.3.0"
15-
16-
import typing
17-
import warnings
18-
19-
import rdflib.util # type: ignore
14+
__version__ = "0.4.0"
2015

2116
from . import local_uuid
22-
23-
24-
def guess_format(
25-
fpath: str, fmap: typing.Optional[typing.Dict[str, str]] = None
26-
) -> typing.Optional[str]:
27-
warnings.warn(
28-
"The functionality in case_utils.guess_format is now upstream. Please revise your code to use rdflib.util.guess_format. The function arguments remain the same. case_utils.guess_format will be removed in case_utils 0.4.0.",
29-
DeprecationWarning,
30-
)
31-
32-
return rdflib.util.guess_format(fpath, fmap) # type: ignore

0 commit comments

Comments
 (0)