usnistgov / oar-pdr

The NIST Open Access to Research (OAR) Public Data Repository (PDR) system software
11 stars 10 forks source link

Introduce the PDR command-line tools #163

Closed RayPlante closed 3 years ago

RayPlante commented 3 years ago

This PR establishes a set of command-line tools intended for use by an administrator or curator to interact with the PDR system and functions. All tools access via a top-level script called pdr, and different areas of capability are accessed via sub-commands (e.g., pdr publish and pdr preserve). These tools are built into a general CLI infrastructure that allows not only the introduction of new subcommands but also the ability to assemble existing capabilities into more restricted command-line scripts or otherwise differently organized scripts. The command documentation is accessed by providing the -h or --help option on the command line.

This initial introduction of tools serve to assist with the publishing process; in particular, the tools can be used to create new submission information packages (SIPs) that fix or otherwise update previously published datasets. In particular, one can:

RayPlante commented 3 years ago

This PR brings in primarily new code that is not used in the on-line system. (Note: the commits listed above that suggest the opposite is an artifact of a git rebase operation.) I have used the off-line (command-line) tools introduced here on the datapub production on a number of datasets, resulting in a number of fixes. Recent use suggests that common usage is bug-free; although, further enhancements in the future are expected.

Given this performance, I'm skipping normal review on this PR.