Skip to content

Commit 33d9565

Browse files
kchasonkchason
authored
Merge pull request #53 from casework/release-0.5.0
2 parents 1521663 + f2f87f1 commit 33d9565

25 files changed

+589
-161
lines changed

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

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
runs-on: ubuntu-latest
2424
strategy:
2525
matrix:
26-
python-version: [ 3.7, 3.8 ]
26+
python-version: [ '3.7', '3.10' ]
2727

2828
steps:
2929
- uses: actions/checkout@v2
@@ -35,7 +35,35 @@ jobs:
3535
uses: actions/setup-python@v2
3636
with:
3737
python-version: ${{ matrix.python-version }}
38+
- name: Pre-commit Checks
39+
run: |
40+
pip -q install pre-commit
41+
pre-commit run --all-files
3842
- name: Start from clean state
3943
run: make clean
4044
- name: Run tests
4145
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/*

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
*.swp
33
.DS_Store
44
.idea/
5+
.venv-pre-commit/
56
__pycache__
67
build/
78
case_utils.egg-info/

‎.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
repos:
2+
- repo: https://github.com/psf/black
3+
rev: 22.3.0
4+
hooks:
5+
- id: black

‎CONTRIBUTE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,14 @@ make check
3333
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
3434
git commit -m "Update CASE ontology pointer to version 0.6.0" dependencies/CASE case_utils/ontology/version_info.py
3535
```
36+
37+
This project uses [the `pre-commit` tool](https://pre-commit.com/) for linting The easiest way to install it is with `pip`:
38+
```bash
39+
pip install pre-commit
40+
pre-commit --version
41+
```
42+
43+
The `pre-commit` tool hooks into Git's commit machinery to run a set of linters and static analyzers over each change. To install `pre-commit` into Git's hooks, run:
44+
```bash
45+
pre-commit install
46+
```

‎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: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ $(error Unable to determine CASE version)
2121
endif
2222

2323
all: \
24-
.ontology.done.log
24+
.ontology.done.log \
25+
.venv-pre-commit/var/.pre-commit-built.log
2526

2627
.PHONY: \
2728
download
@@ -54,8 +55,32 @@ all: \
5455
test -r case_utils/ontology/case-$(case_version)-subclasses.ttl
5556
touch $@
5657

58+
# This virtual environment is meant to be built once and then persist, even through 'make clean'.
59+
# If a recipe is written to remove this flag file, it should first run `pre-commit uninstall`.
60+
.venv-pre-commit/var/.pre-commit-built.log:
61+
rm -rf .venv-pre-commit
62+
test -r .pre-commit-config.yaml \
63+
|| (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)
64+
$(PYTHON3) -m venv \
65+
.venv-pre-commit
66+
source .venv-pre-commit/bin/activate \
67+
&& pip install \
68+
--upgrade \
69+
pip \
70+
setuptools \
71+
wheel
72+
source .venv-pre-commit/bin/activate \
73+
&& pip install \
74+
pre-commit
75+
source .venv-pre-commit/bin/activate \
76+
&& pre-commit install
77+
mkdir -p \
78+
.venv-pre-commit/var
79+
touch $@
80+
5781
check: \
58-
.ontology.done.log
82+
.ontology.done.log \
83+
.venv-pre-commit/var/.pre-commit-built.log
5984
$(MAKE) \
6085
PYTHON3=$(PYTHON3) \
6186
--directory tests \

‎README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CASE Python Utilities
22

3-
This project provides various specialized utilities for producing data in the [CASE](https://caseontology.org/) format.
3+
This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format.
44

55

66
## Disclaimer
@@ -10,12 +10,28 @@ Participation by NIST in the creation of the documentation of mentioned software
1010

1111
## Installation
1212

13+
This repository can be installed from PyPI or from source.
14+
15+
16+
### Installing from PyPI
17+
18+
```bash
19+
pip install case_utils
20+
```
21+
22+
Users who wish to install from PyPI should be aware that while CASE's ontology is in its pre-1.0.0 release state, backwards-incompatible ontology changes may occur. This may manifest as [`case_validate`](#case_validate) reporting data review errors after installing an updated `case_utils` version. Users may wish to pin `case_utils` within any dependent code bases to be less than the next unreleased SEMVER-minor version. (E.g. if `case_utils` version `0.8.0` is currently available, a newly adopting project might wish to track `case_utils<0.9.0` among its dependencies.)
23+
24+
25+
### Installing from source
26+
27+
Users who wish to install pre-release versions and/or make improvements to the code base should install in this manner.
28+
1329
1. Clone this repository.
1430
2. (Optional) Create and activate a virtual environment.
1531
3. (Optional) Upgrade `pip` with `pip install --upgrade pip`. (This can speed installation of some dependent packages.)
16-
4. Run `pip install .`.
32+
4. Run `pip install $x`, where `$x` is the path to the cloned repository.
1733

18-
Installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile).
34+
Local installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile).
1935

2036

2137
## Usage
@@ -136,3 +152,10 @@ Some `make` targets are defined for this repository:
136152
* `check` - Run unit tests.
137153
* `clean` - Remove test build files, but not downloaded files.
138154
* `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.
155+
156+
157+
## Licensing
158+
159+
This repository is licensed under the Apache 2.0 License. See [LICENSE](LICENSE).
160+
161+
Portions of this repository contributed by NIST are governed by the [NIST Software Licensing Statement](THIRD_PARTY_LICENSES.md#nist-software-licensing-statement).

‎README_PyPI.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CASE Python Utilities
2+
3+
This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format.
4+
5+
Full documentation is available at the [project homepage](https://github.com/casework/CASE-Utilities-Python).

0 commit comments

Comments
 (0)