Skip to content

Release 0.11.0 #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
May 9, 2023
Merged

Release 0.11.0 #113

merged 19 commits into from
May 9, 2023

Conversation

ajnelson-nist
Copy link
Member

@ajnelson-nist ajnelson-nist commented May 9, 2023

Coordination

  • CI passes in this PR

kchason and others added 19 commits March 31, 2023 10:14
This patch moves the packages listed in `tests/requirements.txt` into
`setup.cfg`.

This is done to:

* Reduce complexity of downstream projects that wish to inherit testing
  dependencies.  E.g. currently the `tests/requirements.txt` file is
  loaded via incorporating `case-utils` as a submodule in at least two
  projects (`case_exiftool`, `case_gnu_time`).
* Expose test requirements for supply-chain review via package metadata.

The feature name is for the test requirements is `testing`, inheriting
the name from Python's `setuptools`.

This feature is added knowing that, once added, it should not be
removed, per this best practice in the PyPA guidance:

> Best practice: if a project ends up no longer needing any other
> packages to support a feature, it should keep an empty requirements
> list for that feature in its extras_require argument, so that packages
> depending on that feature don’t break (due to an invalid feature
> name).

There were no effects observed on Make-managed files.

References:
* https://github.com/casework/CASE-Implementation-ExifTool/blob/0.5.0/tests/Makefile#L43-L45
* https://github.com/casework/CASE-Implementation-GNU-Time/blob/0.7.0/tests/Makefile#L56-L58
* https://github.com/pypa/setuptools/blob/v67.6.1/setup.cfg#L42
* https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies

Signed-off-by: Alex Nelson <[email protected]>
…tup_cfg

Move testing dependencies to setup.cfg
A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#526

Signed-off-by: Alex Nelson <[email protected]>
Add SHA3-256 and SHA3-512 to default generated hashes
…f class's IRI

While drafting hand-written example data, it had proved beneficial to
some drafters (myself included) to disambiguate `owl:NamedIndividual`s
from `owl:Class`es by spelling the class differently in the IRI.  Taking
`uco-observable:FileFacet` as an example, it was originally frequently
written as `FileFacet` when referring to the class, and `file-facet-...`
when referring to an individual.

Unfortunately, trying to carry this pattern forward is likely to create
a technological burden.  Camel casing can't always be assumed to apply
straightforwardly, and would cause special-case logic to be needed.
See e.g.:

* `uco-observable:WifiAddressFacet` that would split on capital letters
  to `kb:wifi-address-facet`, which doesn't seem to be a problem;
* `uco-location:GPSCoordinatesFacet` would induce
  `kb:g-p-s-coordinates-facet`, which seems far less obviously
  acceptable;
* `uco-observable:HTTPConnectionFacet` splitting to
  `kb:h-t-t-p-connection-facet` may be the last convincing we need.

Rather than invest in preserving the lowercased, hyphenated suffix
scheme, this patch removes the question and now has individuals use the
last path-segment of the class's IRI.

A follow-on patch will regenerate Make-managed files.

Signed-off-by: Alex Nelson <[email protected]>
This patch enables review of Python code inlined in the `case-utils`
modules' docstrings.

An initial docstring test is also included, because `pytest` reports an
error if it is called and no tests are found.

References:
* https://docs.pytest.org/en/7.1.x/how-to/doctest.html

Signed-off-by: Alex Nelson <[email protected]>
… case_file

A follow-on patch will regenerate Make-managed files.

Signed-off-by: Alex Nelson <[email protected]>
No effects were observed on Make-managed files.

Signed-off-by: Alex Nelson <[email protected]>
Change start of NamedIndividuals' suffices to use last path-segment of class's IRI
Signed-off-by: Alex Nelson <[email protected]>
@ajnelson-nist ajnelson-nist added this to the 0.11.0 milestone May 9, 2023
@ajnelson-nist ajnelson-nist mentioned this pull request May 9, 2023
2 tasks
@ajnelson-nist ajnelson-nist marked this pull request as ready for review May 9, 2023 18:49
@ajnelson-nist ajnelson-nist requested a review from a team as a code owner May 9, 2023 18:49
@kchason kchason merged commit 435d67e into main May 9, 2023
@ajnelson-nist ajnelson-nist deleted the release-0.11.0 branch May 11, 2023 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants