invenio-subjects-lcsh 2024.1.0

LCSH subject terms for InvenioRDM

invenio-subjects-lcsh

LCSH subject terms for InvenioRDM

Install this extension to get Library of Congress Subject Headings into your instance.

Note that this list excludes -781 geographical variations as it's not their original intent to be independent tagging terms.

Installation

From your instance directory:

pipenv install invenio-subjects-lcsh

This will add it to your Pipfile.

Versions

This repository follows calendar versioning for year and month. It does a "best effort" attempt at tracking the LCSH updates in an up-to-and-including version date manner. The following are illustrative cases of how to understand the versioning of this distribution package:

Last LCSH update included	version of this project	date of release of this project
2024-01-31	2024.1.X	any time after 2024-01-31
2023-12-31	2023.12.X	any time after 2023-12-31

2021.06.18 is both a valid semantic version and an indicator of the year-month corresponding to the loaded terms. 18 here is a patch number (not a day).

Usage

There are 2 types of users for this package. Maintainers of the package and instance administrators.

Update terms in an instance

For instance administrators, after you have installed the extension as per the steps above, you will want to reload your instance's fixtures: pipenv run invenio rdm-records fixtures. This will install the new terms in your instance.

Alternatively, or if you want to update your already loaded subjects to a new listing (e.g. from one year's list to another), you can update your instance's LCSH subjects as per below. Updating subjects this way takes care of everything for you: the subjects themselves and the records/drafts using those subjects. WARNING This operation can remove subjects.

# In your instance's project
# Download up-to-date listings
pipenv run invenio galter_subjects lcsh download -d /path/to/downloads/storage/
# Generate file containg deltas to transition your instance to the downloaded listing
pipenv run invenio galter_subjects lcsh deltas -d /path/to/downloads/storage/ -o /path/to/deltas_lcsh.csv
# Update your instance - *this operation will modify your instance*
pipenv run invenio galter_subjects update /path/to/deltas_lcsh.csv

Look at the help text for these commands to see additional options that can be passed. In particular, options for galter_subjects update allow you to store renamed, replaced or removed subjects on records according to a template of your choice.

Maintain the initial vocabulary list

When a new list of LCSH terms comes out, this package should be updated to provide an up-to-date starting fixture. Here we show how.

Pre-requisite/Context

Maintaining the vocabulary file doesn't apriori need any Inveniordm functionality, but updating an instance does and as such this project depends on invenio-app-rdm. In turn, because of the plugin system of InvenioRDM, this dependency requires invenio-search[X] (where X is elasticsearch7 or opensearch1 or opensearch2) to be installed. It has to be installed separately because this project makes no assumption about the document engine used by the instance. So, even for maintainers of this project, invenio-search with an appropriate extra (we choose elasticsearch2 but it is inconsequential) needs to be installed separately to update the vocabulary file.

Commands

Once you have that dependency installed, you can run the following commands:

# In this project
# Download up-to-date listings
pipenv run invenio galter_subjects lcsh download -d /path/to/downloads/storage/
# Generate file containing initial listing
pipenv run invenio galter_subjects lcsh file -d /path/to/downloads/storage/ -o invenio_subjects_lcsh/vocabularies/subjects_lcsh.csv

When you are happy with the list, bump the version in pyproject.toml and release it.

Development

Install the project in editable mode with dev dependencies in an isolated virtualenv ((venv) denotes that going forward):

(venv) pip install -e .[dev]
# or if using pipenv
pipenv run pip install -e .[dev]

Run tests:

(venv) invoke test
# or shorter
(venv) inv test
# or if using pipenv
pipenv run inv test

Check manifest:

(venv) inv check-manifest
# or if using pipenv
pipenv run inv check-manifest

Clean out artefacts:

(venv) inv clean
# or if using pipenv
pipenv run inv clean