CASE Python Utilities

This project provides various specialized utilities for producing data in the CASE format.

Disclaimer

Participation by NIST in the creation of the documentation of mentioned software is not intended to imply a recommendation or endorsement by the National Institute of Standards and Technology, nor is it intended to imply that any specific software is necessarily the best available for the purpose.

Installation

1. Clone this repository.
2. (Optional) Create and activate a virtual environment.
3. Run python setup.py.

Installation is demonstrated in the .venv.done.log target of the tests/ directory.

Usage

case_file

To characterize a file, including hashes:

case_file sample.txt.json sample.txt

To characterize a file, but skip hashing it:

case_file --disable-hashes sample.txt.json sample.txt

local_uuid

This module provides a wrapper UUID generator, local_uuid(). Its main purpose is making example data generate consistent identifiers, and intentionally includes mechanisms to make it difficult to activate this mode without awareness of the caller.

Development status

This repository follows CASE community guidance on describing development status, by adherence to noted support requirements.

The status of this repository is:

4 - Beta

Versioning

This project follows SEMVER 2.0.0 where versions are declared.

Ontology versions supported

This repository supports the ontology versions that are linked as submodules in the CASE Examples QC repository. Currently, the ontology versions are:

• CASE - 0.3.0
• UCO - 0.5.0

Repository locations

This repository is available at the following locations:

• https://github.com/casework/CASE-Utilities-Python
• https://github.com/usnistgov/CASE-Utilities-Python (a mirror)

Releases and issue tracking will be handled at the casework location.

Make targets

Some make targets are defined for this repository:

• check - Run unit tests.
• clean - Remove test build files, but not downloaded files.
• 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.